# Compute

This document explains how to get started using Azure Compute Service with Fog. With this gem you can create/update/list/delete availability sets and virtual machines.

## Usage 

First of all, you need to require the Fog library by executing:

```ruby
require 'fog/azurerm'
```

## Create Connection

Next, create a connection to the Compute Service:

```ruby
    azure_compute_service = Fog::Compute::AzureRM.new(
      tenant_id:        '<Tenantid>',                                                      # Tenant id of Azure Active Directory Application
      client_id:        '<Clientid>',                                                      # Client id of Azure Active Directory Application
      client_secret:    '<ClientSecret>',                                                  # Client Secret of Azure Active Directory Application
      subscription_id:  '<Subscriptionid>',                                                # Subscription id of an Azure Account
      environment:      '<AzureCloud/AzureChinaCloud/AzureUSGovernment/AzureGermanCloud>'  # Azure cloud environment. Default is AzureCloud.
)
```

## Check Server Existence

```ruby
azure_compute_service.servers.check_vm_exists(<Resource Group name>, <VM Name>)
```

## Create Server

**Info:**

- Attribute **network_interface_card_ids** is an array of NICs ids. The NIC id at index zero will become primary NIC of this server(virtual machine) by default.
- To create VM with managed OS disk, use the _managed_disk_storage_type_ argument
- To create VM with unmanaged OS disk, use the _storage_account_name_ argument

### Virtual Machine (Managed OS Disk)

```ruby
    azure_compute_service.servers.create(
        name: '<VM Name>',
        location: 'West US',
        resource_group: '<Resource Group Name>',
        vm_size: 'Basic_A0',
        username: '<Username for VM>',
        password: '<Password for VM>',             # Optional, if 'platform' partameter is 'Linux'.
        disable_password_authentication: false,
        network_interface_card_ids: ['/subscriptions/{Subscription-Id}/resourceGroups/{Resource-Group-Name}/providers/Microsoft.Network/networkInterfaces/{Network-Interface-Id}'],
        availability_set_id: '<availability_set_id>', # Optional
        publisher: 'Canonical',                    # Not required if custom image is being used 
        offer: 'UbuntuServer',                     # Not required if custom image is being used
        sku: '14.04.2-LTS',                        # Not required if custom image is being used
        version: 'latest',                         # Not required if custom image is being used
        platform: 'Linux',
        vhd_path: '<Path of VHD>',                 # Optional, if you want to create the VM from a custom image.
        custom_data: 'echo customData',            # Optional, if you want to add custom data in this VM.
        os_disk_caching: Fog::ARM::Compute::Models::CachingTypes::None, # Optional, can be one of None, ReadOnly, ReadWrite
        managed_disk_storage_type: Azure::ARM::Compute::Models::StorageAccountTypes::StandardLRS, # Optional if storage_account_name is passed, can be StandardLRS or PremiumLRS
        os_disk_size: <Disk Size>                  # Optional, size of the os disk in GB (upto 1023)
    )
```

### Virtual Machine (Unmanaged OS Disk)

```ruby
    azure_compute_service.servers.create(
        name: '<VM Name>',
        location: 'West US',
        resource_group: '<Resource Group Name>',
        vm_size: 'Basic_A0',
        storage_account_name: '<Storage Account Name>',
        username: '<Username for VM>',
        password: '<Password for VM>',
        disable_password_authentication: false,
        network_interface_card_ids: ['/subscriptions/{Subscription-Id}/resourceGroups/{Resource-Group-Name}/providers/Microsoft.Network/networkInterfaces/{Network-Interface-Id}'],
        availability_set_id: '<availability_set_id>', # Optional
        publisher: 'MicrosoftWindowsServerEssentials',   # Not required if custom image is being used
        offer: 'WindowsServerEssentials',                # Not required if custom image is being used  
        sku: 'WindowsServerEssentials',                  # Not required if custom image is being used
        version: 'latest',                               # Not required if custom image is being used
        platform: 'Windows',
        vhd_path: '<Path of VHD>',                       # Optional, if you want to create the VM from a custom image.
        custom_data: 'echo customData',                  # Optional, if you want to add custom data in this VM.
        os_disk_size: <Disk Size>                        # Optional, size of the os disk in GB (upto 1023)
    )
```

## Create Server Asynchronously

Create a new linux server asynchronously

```ruby
    async_response = azure_compute_service.servers.create_async(
        name: '<VM Name>',
        location: 'West US',
        resource_group: '<Resource Group Name>',
        vm_size: 'Basic_A0',
        storage_account_name: '<Storage Account Name>',
        username: '<Username for VM>',
        password: '<Password for VM>',             # Optional, if 'platform' partameter is 'Linux'.
        disable_password_authentication: false,
        network_interface_card_ids: ['/subscriptions/{Subscription-Id}/resourceGroups/{Resource-Group-Name}/providers/Microsoft.Network/networkInterfaces/{Network-Interface-Id}'],
        availability_set_id: '<availability_set_id>', # Optional
        publisher: 'Canonical',                    # Not required if custom image is being used 
        offer: 'UbuntuServer',                     # Not required if custom image is being used
        sku: '14.04.2-LTS',                        # Not required if custom image is being used
        version: 'latest',                         # Not required if custom image is being used
        platform: 'Linux',
        vhd_path: '<Path of VHD>',                 # Optional, if you want to create the VM from a custom image.
        custom_data: 'echo customData',            # Optional, if you want to add custom data in this VM.
        os_disk_caching: Fog::ARM::Compute::Models::CachingTypes::None, # Optional, can be one of None, ReadOnly, ReadWrite
        managed_disk_storage_type: Azure::ARM::Compute::Models::StorageAccountTypes::StandardLRS, # Optional, can be StandardLRS or PremiumLRS
        os_disk_size: <Disk Size>                  # Optional, size of the os disk in GB (upto 1023)
    )
```
Following methods are available to handle async respoonse:
- state
- pending?
- rejected?
- reason
- fulfilled?
- value

An example of handling async response is given below:

```ruby
while 1
    puts async_response.state
    
    if async_response.pending?
      sleep(2)
    end

    if async_response.fulfilled?
      puts async_response.value.inspect
      break
    end

    if async_response.rejected?
      puts async_response.reason.inspect
      break
    end
 end
```
 
For more information about custom_data; see link: https://msdn.microsoft.com/en-us/library/azure/mt163591.aspx

## List Servers

List servers in a resource group

```ruby
    servers  = azure_compute_service.servers(resource_group: '<Resource Group name>')
    servers.each do |server|
        puts "#{server.name}"
        puts "#{server.location}"
    end
```

## Retrieve a single Server

Get a single record of Server

```ruby
      server = azure_compute_service
                          .servers(resource_group: '<Resource Group name>')
                          .get('<Resource Group name>', 'Server name>')
      puts "#{server.name}"
```

## Attach a Data Disk to Server

Get the server object and attach a Data Disk to it.

```ruby
      server.attach_data_disk('<Disk Name>', <Size in GB>, '<Storage Account Name>')
```

## Detach a Data Disk from Server

Get the server object and detach a Data Disk from it.

```ruby
      server.detach_data_disk('<Disk Name>')
```

## Attach a Managed Data Disk to Server

Get the server object and attach a Data Disk to it.

```ruby
      server.attach_managed_disk('<Disk Name>', '<Disk Resource Group Name>')
```

## Detach a Managed Data Disk from Server

Get the server object and detach a Data Disk from it.

```ruby
      server.detach_managed_disk('<Disk Name>')
```

## Get a Server's status

Check the status of a Server

```ruby 
      status = azure_compute_service
                          .servers
                          .get('<Resource Group name>', '<Server name>')
                          .vm_status
      puts status
```

## Destroy a single Server

Get a server object from the get method(described above) and then destroy that server.

```ruby
      server.destroy
```

## Check Availability Set Existence

```ruby
azure_compute_service.availability_sets.check_availability_set_exists(<Resource Group name>, <Availability Set name>)
```

## Create Availability Set

Create a new availability set

```ruby
azure_compute_service.availability_sets.create(
    name: '<Availability Set name>',
    location: '<Location>',
    resource_group: '<Resource Group name>'
    platform_fault_domain_count: <No of Fault Domains>,     # [Optional] Default => 2
    platform_update_domain_count: <No of Update Domains>,   # [Optional] Default => 5
    use_managed_disk: true                                  # [Optional] Possible values true or false
)
```
## List Availability Sets 

List availability sets in a resource group

```ruby
    availability_sets  = azure_compute_service.availability_sets(resource_group: '<Resource Group name>')
    availability_sets.each do |availability_set|
        puts "#{availability_set.name}"
        puts "#{availability_set.location}"
    end
```

## Retrieve a single Availability Set

Get a single record of Availability Set

```ruby
      availability_set = azure_compute_service
                          .availability_sets
                          .get('<Resource Group name>','<Availability Set name>')
        puts "#{availability_set.name}"
```

## Destroy a single Availability Set

Get an availability set object from the get method and then destroy that availability set.

```ruby
      availability_set.destroy
```

## Check Virtual Machine Extension Existence

```ruby
azure_compute_service.virtual_machine_extensions.check_vm_extension_exists(<Resource Group name>, <Virtual Machine Name>, <Extension Name>)
```

## Create Virtual Machine Extension

Installs an extension to the specified virtual machine.

```ruby
    azure_compute_service.virtual_machine_extensions.create(
        name: <Extension Name>,
        resource_group: <Resource Group>,
        location: <Location>,
        vm_name: <Virtual Machine Name>, # Extension will be installed on this VM
        publisher: <Extension publisher>,
        type: <Extension type>,
        type_handler_version: <Extension version>,
        auto_upgrade_minor_version: <true|false>, # Optional
        settings: {JSON object}, # Format: {"key": "value", "key": {"key": "value"}}
        protected_settings: {JSON object}
    )
```

## Get Extension from Virtual Machine

Retrieves the given extension from the virtual machine

```ruby
    vm_extension = azure_compute_service.virtual_machine_extensions.get(
        '<Resource Group Name>', '<Virtual Machine Name>', '<Extension Name>'
    )
```

## Update Extension

Update the given extension. The attributes that can be modified are
- auto_upgrade_minor_version
- settings
- protected_settings

```ruby
    vm_extension.update(
        auto_upgrade_minor_version: <true|false>,
        settings: {JSON object},
        protected_settings: {JSON object}
    )
```

## Destroy Extension

Destroy the given extension from the virtual machine

```ruby
    vm_extension.destroy
```


## Create Managed Disk

Create a new Premium Managed Disk

```ruby
    azure_compute_service.managed_disks.create(
        name: 'disk_name',
        location: 'east us',
        resource_group_name: 'resource_group_name',
        account_type: 'Premium_LRS',
        disk_size_gb: 1023,
        creation_data: {
          create_option: 'Empty'
        }
    )
```

Create a new Standard Managed Disk

```ruby
    azure_compute_service.managed_disks.create(
        name: 'disk_name',
        location: 'east us',
        resource_group_name: 'resource_group_name',
        account_type: 'Standard_LRS',
        disk_size_gb: 1023,
        creation_data: {
          create_option: 'Empty'
        }
    )
```

## List Managed Disks in a Resource Group

List managed disks in a resource group

```ruby
    managed_disks  = azure_compute_service.managed_disks(resource_group: '<Resource Group name>')
    mnaged_disks.each do |disk|
        puts "#{disk.name}"
        puts "#{disk.location}"
    end
```

## List Managed Disks in a Subscription

List managed disks in a subscription

```ruby
    azure_compute_service.managed_disks.each do |disk|
        puts "#{disk.name}"
        puts "#{disk.location}"
    end
```

## Grant Access to a Managed Disk

Grant access to a managed disk

```ruby
    access_sas = azure_compute_service.managed_disks.grant_access('<resource_group_name>', '<disk_name>', 'Read', 1000)
    puts "Access SAS: #{access_sas}"
```

## Revoke Access from a Managed Disk

Revoke access from a managed disk

```ruby
    response = azure_compute_service.managed_disks.revoke_access('<resource_group_name>', '<disk_name>')
    puts "Revoke Access response status: #{response.status}"
```

## Check Managed Disk Existence

```ruby
    azure_compute_service.managed_disks.check_managed_disk_exists(<Resource Group name>, <Disk name>)
```

## Retrieve a single Managed Disk

Get a single record of managed disks

```ruby
      managed_disk = azure_compute_service
                          .managed_disks
                          .get('<Resource Group name>','<Disk name>')
      puts "#{managed_disk.name}"
```

## Destroy a single Managed Disk

Get an managed disk object from the get method and then destroy that managed disk.

```ruby
      managed_disk.destroy
```


## Support and Feedback
Your feedback is appreciated! If you have specific issues with the fog ARM, you should file an issue via Github.