Class: Azure::ARM::Compute::VirtualMachineScaleSets

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb

Overview

The Compute Management Client.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VirtualMachineScaleSets

Creates and initializes a new instance of the VirtualMachineScaleSets class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns reference to the ComputeManagementClient.

Returns:

  • reference to the ComputeManagementClient



23
24
25
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 23

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, name, parameters, custom_headers = nil) ⇒ VirtualMachineScaleSet

Allows you to create or update a virtual machine scale set by providing parameters or a path to pre-configured parameter file.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • name (String) —

    Parameters supplied to the Create Virtual Machine Scale

  • parameters (VirtualMachineScaleSet) —

    Parameters supplied to the Create

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

    A hash of custom headers that

Returns:



88
89
90
91
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 88

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

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

Allows you to create or update a virtual machine scale set by providing parameters or a path to pre-configured parameter file.

Set operation. Virtual Machine Scale Set operation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • name (String) —

    Parameters supplied to the Create Virtual Machine Scale

  • parameters (VirtualMachineScaleSet) —

    Parameters supplied to the Create

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 125

def begin_create_or_update_async(resource_group_name, name, parameters, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'name is nil' if 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 = {}

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

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

  # Serialize Request
  request_mapper = VirtualMachineScaleSet.mapper()
  request_content = @client.serialize(request_mapper,  parameters, 'parameters')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{name}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'name' => name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :put, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = VirtualMachineScaleSet.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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 = VirtualMachineScaleSet.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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, name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Allows you to create or update a virtual machine scale set by providing parameters or a path to pre-configured parameter file.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • name (String) —

    Parameters supplied to the Create Virtual Machine Scale

  • parameters (VirtualMachineScaleSet) —

    Parameters supplied to the Create

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



107
108
109
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 107

def begin_create_or_update_with_http_info(resource_group_name, name, parameters, custom_headers = nil)
  begin_create_or_update_async(resource_group_name, name, parameters, custom_headers).value!
end

#begin_deallocate(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Object

Allows you to deallocate virtual machines in a virtual machine scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set uses.

virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that



259
260
261
262
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 259

def begin_deallocate(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  response = begin_deallocate_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
  nil
end

#begin_deallocate_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Concurrent::Promise

Allows you to deallocate virtual machines in a virtual machine scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set uses.

virtual machine scale set instance IDs. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 298

def begin_deallocate_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_scale_set_name is nil' if vm_scale_set_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 = {}

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

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

  # Serialize Request
  request_mapper = VirtualMachineScaleSetVMInstanceIDs.mapper()
  request_content = @client.serialize(request_mapper,  vm_instance_ids, 'vm_instance_ids')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/deallocate'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmScaleSetName' => vm_scale_set_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :post, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#begin_deallocate_with_http_info(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Allows you to deallocate virtual machines in a virtual machine scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set uses.

virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



279
280
281
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 279

def begin_deallocate_with_http_info(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  begin_deallocate_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
end

#begin_delete(resource_group_name, vm_scale_set_name, custom_headers = nil) ⇒ Object

Allows you to delete a virtual machine scale set.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

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

    A hash of custom headers that



399
400
401
402
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 399

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

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

Allows you to delete a virtual machine scale set.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



428
429
430
431
432
433
434
435
436
437
438
439
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
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 428

def begin_delete_async(resource_group_name, vm_scale_set_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_scale_set_name is nil' if vm_scale_set_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 = {}

  # 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/virtualMachineScaleSets/{vmScaleSetName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmScaleSetName' => vm_scale_set_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :delete, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#begin_delete_instances(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil) ⇒ Object

Allows you to delete virtual machines in a virtual machine scale set.

list of virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceRequiredIDs) —

    The

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

    A hash of custom headers that



620
621
622
623
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 620

def begin_delete_instances(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil)
  response = begin_delete_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
  nil
end

#begin_delete_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil) ⇒ Concurrent::Promise

Allows you to delete virtual machines in a virtual machine scale set.

list of virtual machine scale set instance IDs. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceRequiredIDs) —

    The

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 653

def begin_delete_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_scale_set_name is nil' if vm_scale_set_name.nil?
  fail ArgumentError, 'vm_instance_ids is nil' if vm_instance_ids.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 = {}

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

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

  # Serialize Request
  request_mapper = VirtualMachineScaleSetVMInstanceRequiredIDs.mapper()
  request_content = @client.serialize(request_mapper,  vm_instance_ids, 'vm_instance_ids')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmScaleSetName' => vm_scale_set_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :post, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#begin_delete_instances_with_http_info(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Allows you to delete virtual machines in a virtual machine scale set.

list of virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceRequiredIDs) —

    The

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



637
638
639
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 637

def begin_delete_instances_with_http_info(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil)
  begin_delete_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
end

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

Allows you to delete a virtual machine scale set.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



414
415
416
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 414

def begin_delete_with_http_info(resource_group_name, vm_scale_set_name, custom_headers = nil)
  begin_delete_async(resource_group_name, vm_scale_set_name, custom_headers).value!
end

#begin_power_off(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Object

Allows you to power off (stop) virtual machines in a virtual machine scale set. Note that resources are still attached and you are getting charged for the resources. Use deallocate to release resources.

virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that



1208
1209
1210
1211
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1208

def begin_power_off(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  response = begin_power_off_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
  nil
end

#begin_power_off_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Concurrent::Promise

Allows you to power off (stop) virtual machines in a virtual machine scale set. Note that resources are still attached and you are getting charged for the resources. Use deallocate to release resources.

virtual machine scale set instance IDs. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1245

def begin_power_off_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_scale_set_name is nil' if vm_scale_set_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 = {}

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

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

  # Serialize Request
  request_mapper = VirtualMachineScaleSetVMInstanceIDs.mapper()
  request_content = @client.serialize(request_mapper,  vm_instance_ids, 'vm_instance_ids')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmScaleSetName' => vm_scale_set_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :post, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#begin_power_off_with_http_info(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Allows you to power off (stop) virtual machines in a virtual machine scale set. Note that resources are still attached and you are getting charged for the resources. Use deallocate to release resources.

virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1227
1228
1229
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1227

def begin_power_off_with_http_info(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  begin_power_off_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
end

#begin_reimage(resource_group_name, vm_scale_set_name, custom_headers = nil) ⇒ Object

Allows you to re-image(update the version of the installed operating system) virtual machines in a virtual machine scale set.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

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

    A hash of custom headers that



1773
1774
1775
1776
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1773

def begin_reimage(resource_group_name, vm_scale_set_name, custom_headers = nil)
  response = begin_reimage_async(resource_group_name, vm_scale_set_name, custom_headers).value!
  nil
end

#begin_reimage_async(resource_group_name, vm_scale_set_name, custom_headers = nil) ⇒ Concurrent::Promise

Allows you to re-image(update the version of the installed operating system) virtual machines in a virtual machine scale set.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1804

def begin_reimage_async(resource_group_name, vm_scale_set_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_scale_set_name is nil' if vm_scale_set_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 = {}

  # 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/virtualMachineScaleSets/{vmScaleSetName}/reimage'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmScaleSetName' => vm_scale_set_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :post, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#begin_reimage_with_http_info(resource_group_name, vm_scale_set_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Allows you to re-image(update the version of the installed operating system) virtual machines in a virtual machine scale set.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1789
1790
1791
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1789

def begin_reimage_with_http_info(resource_group_name, vm_scale_set_name, custom_headers = nil)
  begin_reimage_async(resource_group_name, vm_scale_set_name, custom_headers).value!
end

#begin_restart(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Object

Allows you to restart virtual machines in a virtual machine scale set.

virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that



1352
1353
1354
1355
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1352

def begin_restart(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  response = begin_restart_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
  nil
end

#begin_restart_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Concurrent::Promise

Allows you to restart virtual machines in a virtual machine scale set.

virtual machine scale set instance IDs. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1385

def begin_restart_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_scale_set_name is nil' if vm_scale_set_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 = {}

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

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

  # Serialize Request
  request_mapper = VirtualMachineScaleSetVMInstanceIDs.mapper()
  request_content = @client.serialize(request_mapper,  vm_instance_ids, 'vm_instance_ids')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmScaleSetName' => vm_scale_set_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :post, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#begin_restart_with_http_info(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Allows you to restart virtual machines in a virtual machine scale set.

virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1369
1370
1371
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1369

def begin_restart_with_http_info(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  begin_restart_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
end

#begin_start(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Object

Allows you to start virtual machines in a virtual machine scale set.

virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that



1492
1493
1494
1495
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1492

def begin_start(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  response = begin_start_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
  nil
end

#begin_start_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Concurrent::Promise

Allows you to start virtual machines in a virtual machine scale set.

virtual machine scale set instance IDs. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
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
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1525

def begin_start_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_scale_set_name is nil' if vm_scale_set_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 = {}

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

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

  # Serialize Request
  request_mapper = VirtualMachineScaleSetVMInstanceIDs.mapper()
  request_content = @client.serialize(request_mapper,  vm_instance_ids, 'vm_instance_ids')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmScaleSetName' => vm_scale_set_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :post, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#begin_start_with_http_info(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Allows you to start virtual machines in a virtual machine scale set.

virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1509
1510
1511
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1509

def begin_start_with_http_info(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  begin_start_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
end

#begin_update_instances(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil) ⇒ Object

Allows you to manually upgrade virtual machines in a virtual machine scale set.

list of virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceRequiredIDs) —

    The

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

    A hash of custom headers that



1634
1635
1636
1637
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1634

def begin_update_instances(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil)
  response = begin_update_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
  nil
end

#begin_update_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil) ⇒ Concurrent::Promise

Allows you to manually upgrade virtual machines in a virtual machine scale set.

list of virtual machine scale set instance IDs. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceRequiredIDs) —

    The

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1669

def begin_update_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_scale_set_name is nil' if vm_scale_set_name.nil?
  fail ArgumentError, 'vm_instance_ids is nil' if vm_instance_ids.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 = {}

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

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

  # Serialize Request
  request_mapper = VirtualMachineScaleSetVMInstanceRequiredIDs.mapper()
  request_content = @client.serialize(request_mapper,  vm_instance_ids, 'vm_instance_ids')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmScaleSetName' => vm_scale_set_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :post, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#begin_update_instances_with_http_info(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Allows you to manually upgrade virtual machines in a virtual machine scale set.

list of virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceRequiredIDs) —

    The

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1652
1653
1654
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1652

def begin_update_instances_with_http_info(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil)
  begin_update_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
end

#create_or_update(resource_group_name, name, parameters, custom_headers = nil) ⇒ VirtualMachineScaleSet

Allows you to create or update a virtual machine scale set by providing parameters or a path to pre-configured parameter file.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • name (String) —

    Parameters supplied to the Create Virtual Machine Scale

  • parameters (VirtualMachineScaleSet) —

    Parameters supplied to the Create

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

    A hash of custom headers that

Returns:



39
40
41
42
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 39

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

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

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

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • name (String) —

    Parameters supplied to the Create Virtual Machine Scale

  • parameters (VirtualMachineScaleSet) —

    Parameters supplied to the Create

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 56

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

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = VirtualMachineScaleSet.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response, 'parsed_response')
    end

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

  promise
end

#deallocate(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Object

Allows you to deallocate virtual machines in a virtual machine scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set uses.

virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that



213
214
215
216
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 213

def deallocate(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  response = deallocate_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
  nil
end

#deallocate_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Concurrent::Promise

virtual machine scale set instance IDs. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 229

def deallocate_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  # Send request
  promise = begin_deallocate_async(resource_group_name, vm_scale_set_name, vm_instance_ids, 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_scale_set_name, custom_headers = nil) ⇒ Object

Allows you to delete a virtual machine scale set.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

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

    A hash of custom headers that



360
361
362
363
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 360

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

#delete_async(resource_group_name, vm_scale_set_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_scale_set_name (String) —

    The name of the virtual machine scale set.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 374

def delete_async(resource_group_name, vm_scale_set_name, custom_headers = nil)
  # Send request
  promise = begin_delete_async(resource_group_name, vm_scale_set_name, 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_instances(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil) ⇒ Object

Allows you to delete virtual machines in a virtual machine scale set.

list of virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceRequiredIDs) —

    The

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

    A hash of custom headers that



577
578
579
580
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 577

def delete_instances(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil)
  response = delete_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
  nil
end

#delete_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil) ⇒ Concurrent::Promise

list of virtual machine scale set instance IDs. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceRequiredIDs) —

    The

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 593

def delete_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil)
  # Send request
  promise = begin_delete_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, 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

#get(resource_group_name, vm_scale_set_name, custom_headers = nil) ⇒ VirtualMachineScaleSet

Display information about a virtual machine scale set.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

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

    A hash of custom headers that

Returns:



483
484
485
486
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 483

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

#get_async(resource_group_name, vm_scale_set_name, custom_headers = nil) ⇒ Concurrent::Promise

Display information about a virtual machine scale set.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 512

def get_async(resource_group_name, vm_scale_set_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_scale_set_name is nil' if vm_scale_set_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 = {}

  # 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/virtualMachineScaleSets/{vmScaleSetName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmScaleSetName' => vm_scale_set_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = VirtualMachineScaleSet.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_instance_view(resource_group_name, vm_scale_set_name, custom_headers = nil) ⇒ VirtualMachineScaleSetInstanceView

Displays status of a virtual machine scale set instance.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

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

    A hash of custom headers that

Returns:



718
719
720
721
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 718

def get_instance_view(resource_group_name, vm_scale_set_name, custom_headers = nil)
  response = get_instance_view_async(resource_group_name, vm_scale_set_name, custom_headers).value!
  response.body unless response.nil?
end

#get_instance_view_async(resource_group_name, vm_scale_set_name, custom_headers = nil) ⇒ Concurrent::Promise

Displays status of a virtual machine scale set instance.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 747

def get_instance_view_async(resource_group_name, vm_scale_set_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_scale_set_name is nil' if vm_scale_set_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 = {}

  # 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/virtualMachineScaleSets/{vmScaleSetName}/instanceView'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmScaleSetName' => vm_scale_set_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = VirtualMachineScaleSetInstanceView.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_instance_view_with_http_info(resource_group_name, vm_scale_set_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Displays status of a virtual machine scale set instance.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



733
734
735
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 733

def get_instance_view_with_http_info(resource_group_name, vm_scale_set_name, custom_headers = nil)
  get_instance_view_async(resource_group_name, vm_scale_set_name, custom_headers).value!
end

#get_with_http_info(resource_group_name, vm_scale_set_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Display information about a virtual machine scale set.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



498
499
500
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 498

def get_with_http_info(resource_group_name, vm_scale_set_name, custom_headers = nil)
  get_async(resource_group_name, vm_scale_set_name, custom_headers).value!
end

#list(resource_group_name, custom_headers = nil) ⇒ Array<VirtualMachineScaleSet>

Lists all virtual machine scale sets under a resource group.

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:



832
833
834
835
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 832

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

#list_all(custom_headers = nil) ⇒ Array<VirtualMachineScaleSet>

Lists all Virtual Machine Scale Sets in the subscription. Use nextLink property in the response to get the next page of Virtual Machine Scale Sets. Do this till nextLink is not null to fetch all the Virtual Machine Scale Sets.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:



947
948
949
950
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 947

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

#list_all_as_lazy(custom_headers = nil) ⇒ VirtualMachineScaleSetListWithLinkResult

Lists all Virtual Machine Scale Sets in the subscription. Use nextLink property in the response to get the next page of Virtual Machine Scale Sets. Do this till nextLink is not null to fetch all the Virtual Machine Scale Sets.

will be added to the HTTP request.

to pages of the response.

Parameters:

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

    A hash of custom headers that

Returns:



925
926
927
928
929
930
931
932
933
934
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 925

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

#list_all_async(custom_headers = nil) ⇒ Concurrent::Promise

Lists all Virtual Machine Scale Sets in the subscription. Use nextLink property in the response to get the next page of Virtual Machine Scale Sets. Do this till nextLink is not null to fetch all the Virtual Machine Scale Sets.

to the HTTP request.

Parameters:

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 978

def list_all_async(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 = {}

  # 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/virtualMachineScaleSets'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = VirtualMachineScaleSetListWithLinkResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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) ⇒ VirtualMachineScaleSetListWithLinkResult

Lists all Virtual Machine Scale Sets in the subscription. Use nextLink property in the response to get the next page of Virtual Machine Scale Sets. Do this till nextLink is not null to fetch all the Virtual Machine Scale Sets.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:



1952
1953
1954
1955
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1952

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

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

Lists all Virtual Machine Scale Sets in the subscription. Use nextLink property in the response to get the next page of Virtual Machine Scale Sets. Do this till nextLink is not null to fetch all the Virtual Machine Scale Sets.

call to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
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
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1987

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 = {}

  # 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}'
  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 || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = VirtualMachineScaleSetListWithLinkResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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 Virtual Machine Scale Sets in the subscription. Use nextLink property in the response to get the next page of Virtual Machine Scale Sets. Do this till nextLink is not null to fetch all the Virtual Machine Scale Sets.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1970
1971
1972
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1970

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

#list_all_with_http_info(custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all Virtual Machine Scale Sets in the subscription. Use nextLink property in the response to get the next page of Virtual Machine Scale Sets. Do this till nextLink is not null to fetch all the Virtual Machine Scale Sets.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



963
964
965
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 963

def list_all_with_http_info(custom_headers = nil)
  list_all_async(custom_headers).value!
end

#list_as_lazy(resource_group_name, custom_headers = nil) ⇒ VirtualMachineScaleSetListResult

Lists all virtual machine scale sets under a resource group.

will be added to the HTTP request.

pages of the 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:



812
813
814
815
816
817
818
819
820
821
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 812

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

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

Lists all virtual machine scale sets under a resource group.

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.



859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
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
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 859

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 = {}

  # 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/virtualMachineScaleSets'
  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 || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = VirtualMachineScaleSetListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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(next_page_link, custom_headers = nil) ⇒ VirtualMachineScaleSetListResult

Lists all virtual machine scale sets under a resource group.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:



1859
1860
1861
1862
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1859

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

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

Lists all virtual machine scale sets under a resource group.

call to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1888

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


  request_headers = {}

  # 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}'
  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 || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = VirtualMachineScaleSetListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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 virtual machine scale sets under a resource group.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1874
1875
1876
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1874

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

#list_skus(resource_group_name, vm_scale_set_name, custom_headers = nil) ⇒ Array<VirtualMachineScaleSetSku>

Displays available skus for your virtual machine scale set including the minimum and maximum vm instances allowed for a particular sku.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

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

    A hash of custom headers that

Returns:



1065
1066
1067
1068
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1065

def list_skus(resource_group_name, vm_scale_set_name, custom_headers = nil)
  first_page = list_skus_as_lazy(resource_group_name, vm_scale_set_name, custom_headers)
  first_page.get_all_items
end

#list_skus_as_lazy(resource_group_name, vm_scale_set_name, custom_headers = nil) ⇒ VirtualMachineScaleSetListSkusResult

Displays available skus for your virtual machine scale set including the minimum and maximum vm instances allowed for a particular sku.

will be added to the HTTP request.

pages of the response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

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

    A hash of custom headers that

Returns:



1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1043

def list_skus_as_lazy(resource_group_name, vm_scale_set_name, custom_headers = nil)
  response = list_skus_async(resource_group_name, vm_scale_set_name, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_link|
      list_skus_next_async(next_link, custom_headers)
    end
    page
  end
end

#list_skus_async(resource_group_name, vm_scale_set_name, custom_headers = nil) ⇒ Concurrent::Promise

Displays available skus for your virtual machine scale set including the minimum and maximum vm instances allowed for a particular sku.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1096

def list_skus_async(resource_group_name, vm_scale_set_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_scale_set_name is nil' if vm_scale_set_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 = {}

  # 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/virtualMachineScaleSets/{vmScaleSetName}/skus'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vmScaleSetName' => vm_scale_set_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = VirtualMachineScaleSetListSkusResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_skus_next(next_page_link, custom_headers = nil) ⇒ VirtualMachineScaleSetListSkusResult

Displays available skus for your virtual machine scale set including the minimum and maximum vm instances allowed for a particular sku.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:



2049
2050
2051
2052
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 2049

def list_skus_next(next_page_link, custom_headers = nil)
  response = list_skus_next_async(next_page_link, custom_headers).value!
  response.body unless response.nil?
end

#list_skus_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise

Displays available skus for your virtual machine scale set including the minimum and maximum vm instances allowed for a particular sku.

call to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
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
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 2080

def list_skus_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}

  # 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}'
  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 || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = VirtualMachineScaleSetListSkusResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_skus_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Displays available skus for your virtual machine scale set including the minimum and maximum vm instances allowed for a particular sku.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



2065
2066
2067
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 2065

def list_skus_next_with_http_info(next_page_link, custom_headers = nil)
  list_skus_next_async(next_page_link, custom_headers).value!
end

#list_skus_with_http_info(resource_group_name, vm_scale_set_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Displays available skus for your virtual machine scale set including the minimum and maximum vm instances allowed for a particular sku.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1081
1082
1083
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1081

def list_skus_with_http_info(resource_group_name, vm_scale_set_name, custom_headers = nil)
  list_skus_async(resource_group_name, vm_scale_set_name, custom_headers).value!
end

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

Lists all virtual machine scale sets under a resource group.

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.



846
847
848
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 846

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

#power_off(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Object

Allows you to power off (stop) virtual machines in a virtual machine scale set. Note that resources are still attached and you are getting charged for the resources. Use deallocate to release resources.

virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that



1163
1164
1165
1166
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1163

def power_off(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  response = power_off_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
  nil
end

#power_off_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Concurrent::Promise

virtual machine scale set instance IDs. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1179

def power_off_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  # Send request
  promise = begin_power_off_async(resource_group_name, vm_scale_set_name, vm_instance_ids, 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_scale_set_name, custom_headers = nil) ⇒ Object

Allows you to re-image(update the version of the installed operating system) virtual machines in a virtual machine scale set.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

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

    A hash of custom headers that



1733
1734
1735
1736
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1733

def reimage(resource_group_name, vm_scale_set_name, custom_headers = nil)
  response = reimage_async(resource_group_name, vm_scale_set_name, custom_headers).value!
  nil
end

#reimage_async(resource_group_name, vm_scale_set_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_scale_set_name (String) —

    The name of the virtual machine scale set.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1747

def reimage_async(resource_group_name, vm_scale_set_name, custom_headers = nil)
  # Send request
  promise = begin_reimage_async(resource_group_name, vm_scale_set_name, 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_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Object

Allows you to restart virtual machines in a virtual machine scale set.

virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that



1309
1310
1311
1312
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1309

def restart(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  response = restart_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
  nil
end

#restart_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Concurrent::Promise

virtual machine scale set instance IDs. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1325

def restart_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  # Send request
  promise = begin_restart_async(resource_group_name, vm_scale_set_name, vm_instance_ids, 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

#start(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Object

Allows you to start virtual machines in a virtual machine scale set.

virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that



1449
1450
1451
1452
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1449

def start(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  response = start_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
  nil
end

#start_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil) ⇒ Concurrent::Promise

virtual machine scale set instance IDs. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceIDs) (defaults to: nil) —

    The list of

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1465

def start_async(resource_group_name, vm_scale_set_name, vm_instance_ids = nil, custom_headers = nil)
  # Send request
  promise = begin_start_async(resource_group_name, vm_scale_set_name, vm_instance_ids, 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_instances(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil) ⇒ Object

Allows you to manually upgrade virtual machines in a virtual machine scale set.

list of virtual machine scale set instance IDs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceRequiredIDs) —

    The

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

    A hash of custom headers that



1590
1591
1592
1593
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1590

def update_instances(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil)
  response = update_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers).value!
  nil
end

#update_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil) ⇒ Concurrent::Promise

list of virtual machine scale set instance IDs. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_scale_set_name (String) —

    The name of the virtual machine scale set.

  • vm_instance_ids (VirtualMachineScaleSetVMInstanceRequiredIDs) —

    The

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
 
# File 'lib/generated/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1606

def update_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, custom_headers = nil)
  # Send request
  promise = begin_update_instances_async(resource_group_name, vm_scale_set_name, vm_instance_ids, 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