Class: Azure::Compute::Mgmt::V2016_03_30::VirtualMachineExtensions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-03-30/generated/azure_mgmt_compute/virtual_machine_extensions.rb

Overview

Compute Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VirtualMachineExtensions

Creates and initializes a new instance of the VirtualMachineExtensions class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2016-03-30/generated/azure_mgmt_compute/virtual_machine_extensions.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ComputeManagementClient (readonly)

Returns reference to the ComputeManagementClient.

Returns:



22
23
24
 
# File 'lib/2016-03-30/generated/azure_mgmt_compute/virtual_machine_extensions.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, vm_name, vm_extension_name, extension_parameters, custom_headers = nil) ⇒ VirtualMachineExtension

The operation to create or update the extension.

should be create or updated. the Create Virtual Machine Extension operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_name (String) —

    The name of the virtual machine where the extension

  • vm_extension_name (String) —

    The name of the virtual machine extension.

  • extension_parameters (VirtualMachineExtension) —

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (VirtualMachineExtension) —

    operation results.



235
236
237
238
 
# File 'lib/2016-03-30/generated/azure_mgmt_compute/virtual_machine_extensions.rb', line 235

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

#begin_create_or_update_async(resource_group_name, vm_name, vm_extension_name, extension_parameters, custom_headers = nil) ⇒ Concurrent::Promise

The operation to create or update the extension.

should be create or updated. the Create Virtual Machine Extension operation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_name (String) —

    The name of the virtual machine where the extension

  • vm_extension_name (String) —

    The name of the virtual machine extension.

  • extension_parameters (VirtualMachineExtension) —

    Parameters supplied to

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



272
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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/2016-03-30/generated/azure_mgmt_compute/virtual_machine_extensions.rb', line 272

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


  request_headers = {}

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

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

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

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

  request_url = @base_url || @client.base_url

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

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

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

    result
  end

  promise.execute
end

#begin_create_or_update_with_http_info(resource_group_name, vm_name, vm_extension_name, extension_parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The operation to create or update the extension.

should be create or updated. the Create Virtual Machine Extension operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_name (String) —

    The name of the virtual machine where the extension

  • vm_extension_name (String) —

    The name of the virtual machine extension.

  • extension_parameters (VirtualMachineExtension) —

    Parameters supplied to

  • 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/2016-03-30/generated/azure_mgmt_compute/virtual_machine_extensions.rb', line 254

def begin_create_or_update_with_http_info(resource_group_name, vm_name, vm_extension_name, extension_parameters, custom_headers = nil)
  begin_create_or_update_async(resource_group_name, vm_name, vm_extension_name, extension_parameters, custom_headers).value!
end

#begin_delete(resource_group_name, vm_name, vm_extension_name, custom_headers = nil) ⇒ OperationStatusResponse

The operation to delete the extension.

should be deleted. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_name (String) —

    The name of the virtual machine where the extension

  • vm_extension_name (String) —

    The name of the virtual machine extension.

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

    A hash of custom headers that

Returns:

  • (OperationStatusResponse) —

    operation results.



357
358
359
360
 
# File 'lib/2016-03-30/generated/azure_mgmt_compute/virtual_machine_extensions.rb', line 357

def begin_delete(resource_group_name, vm_name, vm_extension_name, custom_headers = nil)
  response = begin_delete_async(resource_group_name, vm_name, vm_extension_name, custom_headers).value!
  response.body unless response.nil?
end

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

The operation to delete the extension.

should be deleted. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_name (String) —

    The name of the virtual machine where the extension

  • vm_extension_name (String) —

    The name of the virtual machine extension.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/2016-03-30/generated/azure_mgmt_compute/virtual_machine_extensions.rb', line 390

def begin_delete_async(resource_group_name, vm_name, vm_extension_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, 'vm_extension_name is nil' if vm_extension_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/virtualMachines/{vmName}/extensions/{vmExtensionName}'

  request_url = @base_url || @client.base_url

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

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

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

    result
  end

  promise.execute
end

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

The operation to delete the extension.

should be deleted. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_name (String) —

    The name of the virtual machine where the extension

  • vm_extension_name (String) —

    The name of the virtual machine extension.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



374
375
376
 
# File 'lib/2016-03-30/generated/azure_mgmt_compute/virtual_machine_extensions.rb', line 374

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

#create_or_update(resource_group_name, vm_name, vm_extension_name, extension_parameters, custom_headers = nil) ⇒ VirtualMachineExtension

The operation to create or update the extension.

should be create or updated. the Create Virtual Machine Extension operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_name (String) —

    The name of the virtual machine where the extension

  • vm_extension_name (String) —

    The name of the virtual machine extension.

  • extension_parameters (VirtualMachineExtension) —

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (VirtualMachineExtension) —

    operation results.



38
39
40
41
 
# File 'lib/2016-03-30/generated/azure_mgmt_compute/virtual_machine_extensions.rb', line 38

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

#create_or_update_async(resource_group_name, vm_name, vm_extension_name, extension_parameters, custom_headers = nil) ⇒ Concurrent::Promise

should be create or updated. the Create Virtual Machine Extension operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_name (String) —

    The name of the virtual machine where the extension

  • vm_extension_name (String) —

    The name of the virtual machine extension.

  • extension_parameters (VirtualMachineExtension) —

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



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

def create_or_update_async(resource_group_name, vm_name, vm_extension_name, extension_parameters, custom_headers = nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, vm_name, vm_extension_name, extension_parameters, custom_headers)

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

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

  promise
end

#delete(resource_group_name, vm_name, vm_extension_name, custom_headers = nil) ⇒ OperationStatusResponse

The operation to delete the extension.

should be deleted. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_name (String) —

    The name of the virtual machine where the extension

  • vm_extension_name (String) —

    The name of the virtual machine extension.

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

    A hash of custom headers that

Returns:

  • (OperationStatusResponse) —

    operation results.



86
87
88
89
 
# File 'lib/2016-03-30/generated/azure_mgmt_compute/virtual_machine_extensions.rb', line 86

def delete(resource_group_name, vm_name, vm_extension_name, custom_headers = nil)
  response = delete_async(resource_group_name, vm_name, vm_extension_name, custom_headers).value!
  response.body unless response.nil?
end

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

should be deleted. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_name (String) —

    The name of the virtual machine where the extension

  • vm_extension_name (String) —

    The name of the virtual machine extension.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/2016-03-30/generated/azure_mgmt_compute/virtual_machine_extensions.rb', line 102

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

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

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

  promise
end

#get(resource_group_name, vm_name, vm_extension_name, expand = nil, custom_headers = nil) ⇒ VirtualMachineExtension

The operation to get the extension.

extension. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_name (String) —

    The name of the virtual machine containing the

  • vm_extension_name (String) —

    The name of the virtual machine extension.

  • expand (String) (defaults to: nil) —

    The expand expression to apply on the operation.

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

    A hash of custom headers that

Returns:

  • (VirtualMachineExtension) —

    operation results.



133
134
135
136
 
# File 'lib/2016-03-30/generated/azure_mgmt_compute/virtual_machine_extensions.rb', line 133

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

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

The operation to get the extension.

extension. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_name (String) —

    The name of the virtual machine containing the

  • vm_extension_name (String) —

    The name of the virtual machine extension.

  • expand (String) (defaults to: nil) —

    The expand expression to apply on the operation.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/2016-03-30/generated/azure_mgmt_compute/virtual_machine_extensions.rb', line 168

def get_async(resource_group_name, vm_name, vm_extension_name, expand = nil, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vm_name is nil' if vm_name.nil?
  fail ArgumentError, 'vm_extension_name is nil' if vm_extension_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/virtualMachines/{vmName}/extensions/{vmExtensionName}'

  request_url = @base_url || @client.base_url

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

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

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

    result
  end

  promise.execute
end

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

The operation to get the extension.

extension. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • vm_name (String) —

    The name of the virtual machine containing the

  • vm_extension_name (String) —

    The name of the virtual machine extension.

  • expand (String) (defaults to: nil) —

    The expand expression to apply on the operation.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



151
152
153
 
# File 'lib/2016-03-30/generated/azure_mgmt_compute/virtual_machine_extensions.rb', line 151

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