Class: Azure::Compute::Mgmt::V2019_07_01::VirtualMachines

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb

Overview

Compute Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VirtualMachines

Creates and initializes a new instance of the VirtualMachines class.

Parameters:

  • client

    service class for accessing basic functionality.



17
18
19
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientComputeManagementClient (readonly)

Returns reference to the ComputeManagementClient.

Returns:



22
23
24
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 22

def client
  @client
end

Instance Method Details

#begin_capture(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ VirtualMachineCaptureResult

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

the Capture Virtual Machine operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachineCaptureParameters)

    Parameters supplied to

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualMachineCaptureResult)

    operation results.



1282
1283
1284
1285
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1282

def begin_capture(resource_group_name, vm_name, parameters, custom_headers:nil)
  response = begin_capture_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_capture_async(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

the Capture Virtual Machine operation. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachineCaptureParameters)

    Parameters supplied to

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1317

def begin_capture_async(resource_group_name, vm_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachineCaptureParameters.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachineCaptureResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_capture_with_http_info(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

the Capture Virtual Machine operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachineCaptureParameters)

    Parameters supplied to

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1300
1301
1302
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1300

def begin_capture_with_http_info(resource_group_name, vm_name, parameters, custom_headers:nil)
  begin_capture_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers).value!
end

#begin_convert_to_managed_disks(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



1709
1710
1711
1712
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1709

def begin_convert_to_managed_disks(resource_group_name, vm_name, custom_headers:nil)
  response = begin_convert_to_managed_disks_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#begin_convert_to_managed_disks_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1740

def begin_convert_to_managed_disks_async(resource_group_name, vm_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/convertToManagedDisks'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_convert_to_managed_disks_with_http_info(resource_group_name, vm_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1725
1726
1727
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1725

def begin_convert_to_managed_disks_with_http_info(resource_group_name, vm_name, custom_headers:nil)
  begin_convert_to_managed_disks_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
end

#begin_create_or_update(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ VirtualMachine

The operation to create or update a virtual machine.

Machine operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachine)

    Parameters supplied to the Create Virtual

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualMachine)

    operation results.



1392
1393
1394
1395
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1392

def begin_create_or_update(resource_group_name, vm_name, parameters, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

The operation to create or update a virtual machine.

Machine operation. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachine)

    Parameters supplied to the Create Virtual

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1425

def begin_create_or_update_async(resource_group_name, vm_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachine.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 201
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachine.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachine.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_create_or_update_with_http_info(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The operation to create or update a virtual machine.

Machine operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachine)

    Parameters supplied to the Create Virtual

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1409
1410
1411
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1409

def begin_create_or_update_with_http_info(resource_group_name, vm_name, parameters, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers).value!
end

#begin_deallocate(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



1795
1796
1797
1798
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1795

def begin_deallocate(resource_group_name, vm_name, custom_headers:nil)
  response = begin_deallocate_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#begin_deallocate_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1826

def begin_deallocate_async(resource_group_name, vm_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_deallocate_with_http_info(resource_group_name, vm_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1811
1812
1813
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1811

def begin_deallocate_with_http_info(resource_group_name, vm_name, custom_headers:nil)
  begin_deallocate_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

The operation to delete a virtual machine.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



1625
1626
1627
1628
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1625

def begin_delete(resource_group_name, vm_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#begin_delete_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

The operation to delete a virtual machine.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1654

def begin_delete_async(resource_group_name, vm_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_delete_with_http_info(resource_group_name, vm_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The operation to delete a virtual machine.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1640
1641
1642
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1640

def begin_delete_with_http_info(resource_group_name, vm_name, custom_headers:nil)
  begin_delete_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
end

#begin_perform_maintenance(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

The operation to perform maintenance on a virtual machine.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



2415
2416
2417
2418
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2415

def begin_perform_maintenance(resource_group_name, vm_name, custom_headers:nil)
  response = begin_perform_maintenance_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#begin_perform_maintenance_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

The operation to perform maintenance on a virtual machine.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2444

def begin_perform_maintenance_async(resource_group_name, vm_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_perform_maintenance_with_http_info(resource_group_name, vm_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The operation to perform maintenance on a virtual machine.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2430
2431
2432
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2430

def begin_perform_maintenance_with_http_info(resource_group_name, vm_name, custom_headers:nil)
  begin_perform_maintenance_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
end

#begin_power_off(resource_group_name, vm_name, skip_shutdown: false, custom_headers: nil) ⇒ Object

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • skip_shutdown (Boolean) (defaults to: false)

    The parameter to request non-graceful VM

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



1886
1887
1888
1889
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1886

def begin_power_off(resource_group_name, vm_name, skip_shutdown:false, custom_headers:nil)
  response = begin_power_off_async(resource_group_name, vm_name, skip_shutdown:skip_shutdown, custom_headers:custom_headers).value!
  nil
end

#begin_power_off_async(resource_group_name, vm_name, skip_shutdown: false, custom_headers: nil) ⇒ Concurrent::Promise

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • skip_shutdown (Boolean) (defaults to: false)

    The parameter to request non-graceful VM

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1927

def begin_power_off_async(resource_group_name, vm_name, skip_shutdown:false, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/powerOff'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'skipShutdown' => skip_shutdown,'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_power_off_with_http_info(resource_group_name, vm_name, skip_shutdown: false, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • skip_shutdown (Boolean) (defaults to: false)

    The parameter to request non-graceful VM

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1907
1908
1909
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1907

def begin_power_off_with_http_info(resource_group_name, vm_name, skip_shutdown:false, custom_headers:nil)
  begin_power_off_async(resource_group_name, vm_name, skip_shutdown:skip_shutdown, custom_headers:custom_headers).value!
end

#begin_reapply(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

The operation to reapply a virtual machine's state.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



1981
1982
1983
1984
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1981

def begin_reapply(resource_group_name, vm_name, custom_headers:nil)
  response = begin_reapply_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#begin_reapply_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

The operation to reapply a virtual machine's state.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2010

def begin_reapply_async(resource_group_name, vm_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reapply'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_reapply_with_http_info(resource_group_name, vm_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The operation to reapply a virtual machine's state.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1996
1997
1998
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1996

def begin_reapply_with_http_info(resource_group_name, vm_name, custom_headers:nil)
  begin_reapply_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
end

#begin_redeploy(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

Shuts down the virtual machine, moves it to a new node, and powers it back on.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



2231
2232
2233
2234
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2231

def begin_redeploy(resource_group_name, vm_name, custom_headers:nil)
  response = begin_redeploy_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#begin_redeploy_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

Shuts down the virtual machine, moves it to a new node, and powers it back on.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2262

def begin_redeploy_async(resource_group_name, vm_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_redeploy_with_http_info(resource_group_name, vm_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Shuts down the virtual machine, moves it to a new node, and powers it back on.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2247
2248
2249
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2247

def begin_redeploy_with_http_info(resource_group_name, vm_name, custom_headers:nil)
  begin_redeploy_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
end

#begin_reimage(resource_group_name, vm_name, parameters: nil, custom_headers: nil) ⇒ Object

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

the Reimage Virtual Machine operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachineReimageParameters) (defaults to: nil)

    Parameters supplied to

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



2319
2320
2321
2322
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2319

def begin_reimage(resource_group_name, vm_name, parameters:nil, custom_headers:nil)
  response = begin_reimage_async(resource_group_name, vm_name, parameters:parameters, custom_headers:custom_headers).value!
  nil
end

#begin_reimage_async(resource_group_name, vm_name, parameters: nil, custom_headers: nil) ⇒ Concurrent::Promise

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

the Reimage Virtual Machine operation. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachineReimageParameters) (defaults to: nil)

    Parameters supplied to

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2354

def begin_reimage_async(resource_group_name, vm_name, parameters:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachineReimageParameters.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_reimage_with_http_info(resource_group_name, vm_name, parameters: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

the Reimage Virtual Machine operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachineReimageParameters) (defaults to: nil)

    Parameters supplied to

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2337
2338
2339
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2337

def begin_reimage_with_http_info(resource_group_name, vm_name, parameters:nil, custom_headers:nil)
  begin_reimage_async(resource_group_name, vm_name, parameters:parameters, custom_headers:custom_headers).value!
end

#begin_restart(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

The operation to restart a virtual machine.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



2064
2065
2066
2067
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2064

def begin_restart(resource_group_name, vm_name, custom_headers:nil)
  response = begin_restart_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#begin_restart_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

The operation to restart a virtual machine.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2093

def begin_restart_async(resource_group_name, vm_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_restart_with_http_info(resource_group_name, vm_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The operation to restart a virtual machine.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2079
2080
2081
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2079

def begin_restart_with_http_info(resource_group_name, vm_name, custom_headers:nil)
  begin_restart_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
end

#begin_run_command(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ RunCommandResult

Run command on the VM.

operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (RunCommandInput)

    Parameters supplied to the Run command

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (RunCommandResult)

    operation results.



2501
2502
2503
2504
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2501

def begin_run_command(resource_group_name, vm_name, parameters, custom_headers:nil)
  response = begin_run_command_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_run_command_async(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Run command on the VM.

operation. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (RunCommandInput)

    Parameters supplied to the Run command

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2534

def begin_run_command_async(resource_group_name, vm_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::RunCommandInput.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::RunCommandResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_run_command_with_http_info(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Run command on the VM.

operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (RunCommandInput)

    Parameters supplied to the Run command

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2518
2519
2520
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2518

def begin_run_command_with_http_info(resource_group_name, vm_name, parameters, custom_headers:nil)
  begin_run_command_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers).value!
end

#begin_start(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

The operation to start a virtual machine.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



2147
2148
2149
2150
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2147

def begin_start(resource_group_name, vm_name, custom_headers:nil)
  response = begin_start_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#begin_start_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

The operation to start a virtual machine.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2176

def begin_start_async(resource_group_name, vm_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_start_with_http_info(resource_group_name, vm_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The operation to start a virtual machine.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2162
2163
2164
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2162

def begin_start_with_http_info(resource_group_name, vm_name, custom_headers:nil)
  begin_start_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
end

#begin_update(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ VirtualMachine

The operation to update a virtual machine.

Virtual Machine operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachineUpdate)

    Parameters supplied to the Update

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualMachine)

    operation results.



1510
1511
1512
1513
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1510

def begin_update(resource_group_name, vm_name, parameters, custom_headers:nil)
  response = begin_update_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_update_async(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

The operation to update a virtual machine.

Virtual Machine operation. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachineUpdate)

    Parameters supplied to the Update

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1543

def begin_update_async(resource_group_name, vm_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachineUpdate.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:patch, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 201
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachine.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachine.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_update_with_http_info(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The operation to update a virtual machine.

Virtual Machine operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachineUpdate)

    Parameters supplied to the Update

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1527
1528
1529
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1527

def begin_update_with_http_info(resource_group_name, vm_name, parameters, custom_headers:nil)
  begin_update_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers).value!
end

#capture(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ VirtualMachineCaptureResult

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

the Capture Virtual Machine operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachineCaptureParameters)

    Parameters supplied to

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualMachineCaptureResult)

    operation results.



134
135
136
137
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 134

def capture(resource_group_name, vm_name, parameters, custom_headers:nil)
  response = capture_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#capture_async(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

the Capture Virtual Machine operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachineCaptureParameters)

    Parameters supplied to

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 150

def capture_async(resource_group_name, vm_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_capture_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachineCaptureResult.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method, FinalStateVia::LOCATION)
  end

  promise
end

#convert_to_managed_disks(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



504
505
506
507
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 504

def convert_to_managed_disks(resource_group_name, vm_name, custom_headers:nil)
  response = convert_to_managed_disks_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#convert_to_managed_disks_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 518

def convert_to_managed_disks_async(resource_group_name, vm_name, custom_headers:nil)
  # Send request
  promise = begin_convert_to_managed_disks_async(resource_group_name, vm_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#create_or_update(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ VirtualMachine

The operation to create or update a virtual machine.

Machine operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachine)

    Parameters supplied to the Create Virtual

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualMachine)

    operation results.



180
181
182
183
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 180

def create_or_update(resource_group_name, vm_name, parameters, custom_headers:nil)
  response = create_or_update_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Machine operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachine)

    Parameters supplied to the Create Virtual

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 196

def create_or_update_async(resource_group_name, vm_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachine.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#deallocate(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



543
544
545
546
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 543

def deallocate(resource_group_name, vm_name, custom_headers:nil)
  response = deallocate_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#deallocate_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 557

def deallocate_async(resource_group_name, vm_name, custom_headers:nil)
  # Send request
  promise = begin_deallocate_async(resource_group_name, vm_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#delete(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

The operation to delete a virtual machine.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



268
269
270
271
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 268

def delete(resource_group_name, vm_name, custom_headers:nil)
  response = delete_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 282

def delete_async(resource_group_name, vm_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, vm_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#generalize(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

Sets the state of the virtual machine to generalized.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



582
583
584
585
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 582

def generalize(resource_group_name, vm_name, custom_headers:nil)
  response = generalize_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#generalize_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

Sets the state of the virtual machine to generalized.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 611

def generalize_async(resource_group_name, vm_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#generalize_with_http_info(resource_group_name, vm_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Sets the state of the virtual machine to generalized.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



597
598
599
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 597

def generalize_with_http_info(resource_group_name, vm_name, custom_headers:nil)
  generalize_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
end

#get(resource_group_name, vm_name, expand: nil, custom_headers: nil) ⇒ VirtualMachine

Retrieves information about the model view or the instance view of a virtual machine.

operation. Possible values include: 'instanceView' will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • expand (InstanceViewTypes) (defaults to: nil)

    The expand expression to apply on the

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualMachine)

    operation results.



311
312
313
314
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 311

def get(resource_group_name, vm_name, expand:nil, custom_headers:nil)
  response = get_async(resource_group_name, vm_name, expand:expand, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, vm_name, expand: nil, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves information about the model view or the instance view of a virtual machine.

operation. Possible values include: 'instanceView' to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • expand (InstanceViewTypes) (defaults to: nil)

    The expand expression to apply on the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 346

def get_async(resource_group_name, vm_name, expand:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'$expand' => expand,'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachine.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_with_http_info(resource_group_name, vm_name, expand: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves information about the model view or the instance view of a virtual machine.

operation. Possible values include: 'instanceView' will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • expand (InstanceViewTypes) (defaults to: nil)

    The expand expression to apply on the

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



329
330
331
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 329

def get_with_http_info(resource_group_name, vm_name, expand:nil, custom_headers:nil)
  get_async(resource_group_name, vm_name, expand:expand, custom_headers:custom_headers).value!
end

#instance_view(resource_group_name, vm_name, custom_headers: nil) ⇒ VirtualMachineInstanceView

Retrieves information about the run-time state of a virtual machine.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualMachineInstanceView)

    operation results.



411
412
413
414
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 411

def instance_view(resource_group_name, vm_name, custom_headers:nil)
  response = instance_view_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#instance_view_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves information about the run-time state of a virtual machine.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 440

def instance_view_async(resource_group_name, vm_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachineInstanceView.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#instance_view_with_http_info(resource_group_name, vm_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves information about the run-time state of a virtual machine.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



426
427
428
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 426

def instance_view_with_http_info(resource_group_name, vm_name, custom_headers:nil)
  instance_view_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
end

#list(resource_group_name, custom_headers: nil) ⇒ Array<VirtualMachine>

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Array<VirtualMachine>)

    operation results.



666
667
668
669
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 666

def list(resource_group_name, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_all(status_only: nil, custom_headers: nil) ⇒ Array<VirtualMachine>

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

of all Virtual Machines in the subscription. will be added to the HTTP request.

Parameters:

  • status_only (String) (defaults to: nil)

    statusOnly=true enables fetching run time status

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Array<VirtualMachine>)

    operation results.



760
761
762
763
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 760

def list_all(status_only:nil, custom_headers:nil)
  first_page = list_all_as_lazy(status_only:status_only, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_all_as_lazy(status_only: nil, custom_headers: nil) ⇒ VirtualMachineListResult

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

of all Virtual Machines in the subscription. will be added to the HTTP request.

response.

Parameters:

  • status_only (String) (defaults to: nil)

    statusOnly=true enables fetching run time status

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualMachineListResult)

    which provide lazy access to pages of the



2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2933

def list_all_as_lazy(status_only:nil, custom_headers:nil)
  response = list_all_async(status_only:status_only, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_all_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_all_async(status_only: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

of all Virtual Machines in the subscription. to the HTTP request.

Parameters:

  • status_only (String) (defaults to: nil)

    statusOnly=true enables fetching run time status

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 791

def list_all_async(status_only:nil, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version,'statusOnly' => status_only},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachineListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_all_next(next_page_link, custom_headers: nil) ⇒ VirtualMachineListResult

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualMachineListResult)

    operation results.



2794
2795
2796
2797
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2794

def list_all_next(next_page_link, custom_headers:nil)
  response = list_all_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_all_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2825

def list_all_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachineListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_all_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2810
2811
2812
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2810

def list_all_next_with_http_info(next_page_link, custom_headers:nil)
  list_all_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_all_with_http_info(status_only: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

of all Virtual Machines in the subscription. will be added to the HTTP request.

Parameters:

  • status_only (String) (defaults to: nil)

    statusOnly=true enables fetching run time status

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



776
777
778
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 776

def list_all_with_http_info(status_only:nil, custom_headers:nil)
  list_all_async(status_only:status_only, custom_headers:custom_headers).value!
end

#list_as_lazy(resource_group_name, custom_headers: nil) ⇒ VirtualMachineListResult

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualMachineListResult)

    which provide lazy access to pages of the



2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2910

def list_as_lazy(resource_group_name, custom_headers:nil)
  response = list_async(resource_group_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_async(resource_group_name, custom_headers: nil) ⇒ Concurrent::Promise

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 695

def list_async(resource_group_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachineListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_available_sizes(resource_group_name, vm_name, custom_headers: nil) ⇒ VirtualMachineSizeListResult

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualMachineSizeListResult)

    operation results.



855
856
857
858
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 855

def list_available_sizes(resource_group_name, vm_name, custom_headers:nil)
  response = list_available_sizes_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_available_sizes_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 886

def list_available_sizes_async(resource_group_name, vm_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmName' => vm_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachineSizeListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_available_sizes_with_http_info(resource_group_name, vm_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



871
872
873
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 871

def list_available_sizes_with_http_info(resource_group_name, vm_name, custom_headers:nil)
  list_available_sizes_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
end

#list_by_location(location, custom_headers: nil) ⇒ Array<VirtualMachine>

Gets all the virtual machines under the specified subscription for the specified location.

subscription are queried. will be added to the HTTP request.

Parameters:

  • location (String)

    The location for which virtual machines under the

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Array<VirtualMachine>)

    operation results.



35
36
37
38
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 35

def list_by_location(location, custom_headers:nil)
  first_page = list_by_location_as_lazy(location, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_location_as_lazy(location, custom_headers: nil) ⇒ VirtualMachineListResult

Gets all the virtual machines under the specified subscription for the specified location.

subscription are queried. will be added to the HTTP request.

response.

Parameters:

  • location (String)

    The location for which virtual machines under the

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualMachineListResult)

    which provide lazy access to pages of the



2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2888

def list_by_location_as_lazy(location, custom_headers:nil)
  response = list_by_location_async(location, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_location_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_location_async(location, custom_headers: nil) ⇒ Concurrent::Promise

Gets all the virtual machines under the specified subscription for the specified location.

subscription are queried. to the HTTP request.

Parameters:

  • location (String)

    The location for which virtual machines under the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 66

def list_by_location_async(location, custom_headers:nil)
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, "'location' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !location.nil? && location.match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachines'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'location' => location,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachineListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_location_next(next_page_link, custom_headers: nil) ⇒ VirtualMachineListResult

Gets all the virtual machines under the specified subscription for the specified location.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualMachineListResult)

    operation results.



2608
2609
2610
2611
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2608

def list_by_location_next(next_page_link, custom_headers:nil)
  response = list_by_location_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_location_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Gets all the virtual machines under the specified subscription for the specified location.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2639

def list_by_location_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachineListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_location_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all the virtual machines under the specified subscription for the specified location.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2624
2625
2626
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2624

def list_by_location_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_location_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_location_with_http_info(location, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all the virtual machines under the specified subscription for the specified location.

subscription are queried. will be added to the HTTP request.

Parameters:

  • location (String)

    The location for which virtual machines under the

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



51
52
53
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 51

def list_by_location_with_http_info(location, custom_headers:nil)
  list_by_location_async(location, custom_headers:custom_headers).value!
end

#list_next(next_page_link, custom_headers: nil) ⇒ VirtualMachineListResult

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualMachineListResult)

    operation results.



2701
2702
2703
2704
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2701

def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2732

def list_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachineListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2717
2718
2719
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 2717

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_with_http_info(resource_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



681
682
683
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 681

def list_with_http_info(resource_group_name, custom_headers:nil)
  list_async(resource_group_name, custom_headers:custom_headers).value!
end

#perform_maintenance(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

The operation to perform maintenance on a virtual machine.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



1193
1194
1195
1196
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1193

def perform_maintenance(resource_group_name, vm_name, custom_headers:nil)
  response = perform_maintenance_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#perform_maintenance_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1207

def perform_maintenance_async(resource_group_name, vm_name, custom_headers:nil)
  # Send request
  promise = begin_perform_maintenance_async(resource_group_name, vm_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#power_off(resource_group_name, vm_name, skip_shutdown: false, custom_headers: nil) ⇒ Object

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • skip_shutdown (Boolean) (defaults to: false)

    The parameter to request non-graceful VM

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



955
956
957
958
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 955

def power_off(resource_group_name, vm_name, skip_shutdown:false, custom_headers:nil)
  response = power_off_async(resource_group_name, vm_name, skip_shutdown:skip_shutdown, custom_headers:custom_headers).value!
  nil
end

#power_off_async(resource_group_name, vm_name, skip_shutdown: false, custom_headers: nil) ⇒ Concurrent::Promise

shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • skip_shutdown (Boolean) (defaults to: false)

    The parameter to request non-graceful VM

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 973

def power_off_async(resource_group_name, vm_name, skip_shutdown:false, custom_headers:nil)
  # Send request
  promise = begin_power_off_async(resource_group_name, vm_name, skip_shutdown:skip_shutdown, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#reapply(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

The operation to reapply a virtual machine's state.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



997
998
999
1000
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 997

def reapply(resource_group_name, vm_name, custom_headers:nil)
  response = reapply_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#reapply_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1011

def reapply_async(resource_group_name, vm_name, custom_headers:nil)
  # Send request
  promise = begin_reapply_async(resource_group_name, vm_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#redeploy(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

Shuts down the virtual machine, moves it to a new node, and powers it back on.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



1112
1113
1114
1115
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1112

def redeploy(resource_group_name, vm_name, custom_headers:nil)
  response = redeploy_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#redeploy_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1126

def redeploy_async(resource_group_name, vm_name, custom_headers:nil)
  # Send request
  promise = begin_redeploy_async(resource_group_name, vm_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#reimage(resource_group_name, vm_name, parameters: nil, custom_headers: nil) ⇒ Object

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

the Reimage Virtual Machine operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachineReimageParameters) (defaults to: nil)

    Parameters supplied to

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



1153
1154
1155
1156
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1153

def reimage(resource_group_name, vm_name, parameters:nil, custom_headers:nil)
  response = reimage_async(resource_group_name, vm_name, parameters:parameters, custom_headers:custom_headers).value!
  nil
end

#reimage_async(resource_group_name, vm_name, parameters: nil, custom_headers: nil) ⇒ Concurrent::Promise

the Reimage Virtual Machine operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachineReimageParameters) (defaults to: nil)

    Parameters supplied to

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1169

def reimage_async(resource_group_name, vm_name, parameters:nil, custom_headers:nil)
  # Send request
  promise = begin_reimage_async(resource_group_name, vm_name, parameters:parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#restart(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

The operation to restart a virtual machine.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



1035
1036
1037
1038
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1035

def restart(resource_group_name, vm_name, custom_headers:nil)
  response = restart_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#restart_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1049

def restart_async(resource_group_name, vm_name, custom_headers:nil)
  # Send request
  promise = begin_restart_async(resource_group_name, vm_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#run_command(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ RunCommandResult

Run command on the VM.

operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (RunCommandInput)

    Parameters supplied to the Run command

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (RunCommandResult)

    operation results.



1235
1236
1237
1238
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1235

def run_command(resource_group_name, vm_name, parameters, custom_headers:nil)
  response = run_command_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#run_command_async(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (RunCommandInput)

    Parameters supplied to the Run command

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1251

def run_command_async(resource_group_name, vm_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_run_command_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::RunCommandResult.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method, FinalStateVia::LOCATION)
  end

  promise
end

#start(resource_group_name, vm_name, custom_headers: nil) ⇒ Object

The operation to start a virtual machine.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that



1073
1074
1075
1076
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1073

def start(resource_group_name, vm_name, custom_headers:nil)
  response = start_async(resource_group_name, vm_name, custom_headers:custom_headers).value!
  nil
end

#start_async(resource_group_name, vm_name, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 1087

def start_async(resource_group_name, vm_name, custom_headers:nil)
  # Send request
  promise = begin_start_async(resource_group_name, vm_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#update(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ VirtualMachine

The operation to update a virtual machine.

Virtual Machine operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachineUpdate)

    Parameters supplied to the Update

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualMachine)

    operation results.



226
227
228
229
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 226

def update(resource_group_name, vm_name, parameters, custom_headers:nil)
  response = update_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_async(resource_group_name, vm_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Virtual Machine operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • vm_name (String)

    The name of the virtual machine.

  • parameters (VirtualMachineUpdate)

    Parameters supplied to the Update

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# File 'lib/2019-07-01/generated/azure_mgmt_compute/virtual_machines.rb', line 242

def update_async(resource_group_name, vm_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_update_async(resource_group_name, vm_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Compute::Mgmt::V2019_07_01::Models::VirtualMachine.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end