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

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/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/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/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:



77
78
79
80
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 77

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.



114
115
116
117
118
119
120
121
122
123
124
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
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 114

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?
  parameters.validate unless 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?

  # Serialize Request
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  unless parameters.nil?
    parameters = VirtualMachineScaleSet.serialize_object(parameters)
  end
  request_content = parameters != nil ? JSON.generate(parameters, 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)
        unless parsed_response.nil?
          parsed_response = VirtualMachineScaleSet.deserialize_object(parsed_response)
        end
        result.body = parsed_response
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        unless parsed_response.nil?
          parsed_response = VirtualMachineScaleSet.deserialize_object(parsed_response)
        end
        result.body = parsed_response
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_create_or_update_with_http_info(resource_group_name, 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.



96
97
98
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 96

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



234
235
236
237
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 234

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.



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
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
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 273

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?
  vm_instance_ids.validate unless 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?

  # Serialize Request
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  unless vm_instance_ids.nil?
    vm_instance_ids = VirtualMachineScaleSetVMInstanceIDs.serialize_object(vm_instance_ids)
  end
  request_content = vm_instance_ids != nil ? JSON.generate(vm_instance_ids, 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.



254
255
256
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 254

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



358
359
360
361
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 358

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.



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 387

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



561
562
563
564
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 561

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.



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 594

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?
  vm_instance_ids.validate unless 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?

  # Serialize Request
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  unless vm_instance_ids.nil?
    vm_instance_ids = VirtualMachineScaleSetVMInstanceRequiredIDs.serialize_object(vm_instance_ids)
  end
  request_content = vm_instance_ids != nil ? JSON.generate(vm_instance_ids, 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.



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

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.



373
374
375
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 373

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



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

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.



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
1150
1151
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1101

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?
  vm_instance_ids.validate unless 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?

  # Serialize Request
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  unless vm_instance_ids.nil?
    vm_instance_ids = VirtualMachineScaleSetVMInstanceIDs.serialize_object(vm_instance_ids)
  end
  request_content = vm_instance_ids != nil ? JSON.generate(vm_instance_ids, 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.



1083
1084
1085
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1083

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



1559
1560
1561
1562
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1559

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.



1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1590

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.



1575
1576
1577
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1575

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



1190
1191
1192
1193
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1190

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.



1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
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
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1223

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?
  vm_instance_ids.validate unless 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?

  # Serialize Request
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  unless vm_instance_ids.nil?
    vm_instance_ids = VirtualMachineScaleSetVMInstanceIDs.serialize_object(vm_instance_ids)
  end
  request_content = vm_instance_ids != nil ? JSON.generate(vm_instance_ids, 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.



1207
1208
1209
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1207

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



1312
1313
1314
1315
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1312

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.



1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1345

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?
  vm_instance_ids.validate unless 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?

  # Serialize Request
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  unless vm_instance_ids.nil?
    vm_instance_ids = VirtualMachineScaleSetVMInstanceIDs.serialize_object(vm_instance_ids)
  end
  request_content = vm_instance_ids != nil ? JSON.generate(vm_instance_ids, 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.



1329
1330
1331
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1329

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



1436
1437
1438
1439
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1436

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.



1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1471

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?
  vm_instance_ids.validate unless 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?

  # Serialize Request
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  unless vm_instance_ids.nil?
    vm_instance_ids = VirtualMachineScaleSetVMInstanceRequiredIDs.serialize_object(vm_instance_ids)
  end
  request_content = vm_instance_ids != nil ? JSON.generate(vm_instance_ids, 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.



1454
1455
1456
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1454

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) ⇒ 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. uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. for the response.

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

  • @client.api_version (String) —

    Client Api Version.

  • @client.subscription_id (String) —

    Gets subscription credentials which

  • @client.accept_language (String) —

    Gets or sets the preferred language

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 44

def create_or_update(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|
      unless parsed_response.nil?
        parsed_response = VirtualMachineScaleSet.deserialize_object(parsed_response)
      end
    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) ⇒ 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. 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

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 204

def deallocate(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) ⇒ Concurrent::Promise

Allows you to delete a virtual machine scale set.

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.

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 333

def delete(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) ⇒ Concurrent::Promise

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

list of virtual machine scale set instance IDs. response.

Parameters:

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 534

def delete_instances(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:



440
441
442
443
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 440

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.



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 469

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)
        unless parsed_response.nil?
          parsed_response = VirtualMachineScaleSet.deserialize_object(parsed_response)
        end
        result.body = parsed_response
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_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:



657
658
659
660
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 657

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.



686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 686

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)
        unless parsed_response.nil?
          parsed_response = VirtualMachineScaleSetInstanceView.deserialize_object(parsed_response)
        end
        result.body = parsed_response
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_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.



672
673
674
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 672

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.



455
456
457
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 455

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) ⇒ VirtualMachineScaleSetListResult

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:



750
751
752
753
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 750

def list(resource_group_name, custom_headers = nil)
  response = list_async(resource_group_name, custom_headers).value!
  response.body unless response.nil?
end

#list_all(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.

Parameters:

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

    A hash of custom headers that

Returns:



842
843
844
845
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 842

def list_all(custom_headers = nil)
  response = list_all_async(custom_headers).value!
  response.body unless response.nil?
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.



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
912
913
914
915
916
917
918
919
920
921
922
923
924
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 873

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)
        unless parsed_response.nil?
          parsed_response = VirtualMachineScaleSetListWithLinkResult.deserialize_object(parsed_response)
        end
        result.body = parsed_response
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_all_next(next_page_link, custom_headers = nil) ⇒ 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:



1736
1737
1738
1739
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1736

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.



1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1771

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)
        unless parsed_response.nil?
          parsed_response = VirtualMachineScaleSetListWithLinkResult.deserialize_object(parsed_response)
        end
        result.body = parsed_response
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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

Lists all 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.



1754
1755
1756
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1754

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.



858
859
860
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 858

def list_all_with_http_info(custom_headers = nil)
  list_all_async(custom_headers).value!
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.



777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 777

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)
        unless parsed_response.nil?
          parsed_response = VirtualMachineScaleSetListResult.deserialize_object(parsed_response)
        end
        result.body = parsed_response
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next(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:



1643
1644
1645
1646
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1643

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.



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
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1672

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)
        unless parsed_response.nil?
          parsed_response = VirtualMachineScaleSetListResult.deserialize_object(parsed_response)
        end
        result.body = parsed_response
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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

Lists all 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.



1658
1659
1660
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1658

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) ⇒ 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.

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:



937
938
939
940
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 937

def list_skus(resource_group_name, vm_scale_set_name, custom_headers = nil)
  response = list_skus_async(resource_group_name, vm_scale_set_name, custom_headers).value!
  response.body unless response.nil?
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.



968
969
970
971
972
973
974
975
976
977
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
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 968

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)
        unless parsed_response.nil?
          parsed_response = VirtualMachineScaleSetListSkusResult.deserialize_object(parsed_response)
        end
        result.body = parsed_response
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_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:



1833
1834
1835
1836
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1833

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.



1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
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
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1864

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)
        unless parsed_response.nil?
          parsed_response = VirtualMachineScaleSetListSkusResult.deserialize_object(parsed_response)
        end
        result.body = parsed_response
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_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.



1849
1850
1851
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1849

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.



953
954
955
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 953

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.



764
765
766
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 764

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) ⇒ 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. 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

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1035

def power_off(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) ⇒ Concurrent::Promise

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

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.

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1533

def reimage(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) ⇒ Concurrent::Promise

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

virtual machine scale set instance IDs. 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

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1163

def restart(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) ⇒ Concurrent::Promise

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

virtual machine scale set instance IDs. 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

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1285

def start(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) ⇒ Concurrent::Promise

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

list of virtual machine scale set instance IDs. response.

Parameters:

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
 
# File 'lib/azure_mgmt_compute/virtual_machine_scale_sets.rb', line 1408

def update_instances(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