Class: Azure::VMwareCloudSimple::Mgmt::V2019_04_01::VirtualMachineTemplates

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machine_templates.rb

Overview

Description of the new service

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VirtualMachineTemplates

Creates and initializes a new instance of the VirtualMachineTemplates class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machine_templates.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ VMwareCloudSimpleClient (readonly)

Returns reference to the VMwareCloudSimpleClient.

Returns:



22
23
24
 
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machine_templates.rb', line 22

def client
  @client
end

Instance Method Details

#get(region_id, pc_name, virtual_machine_template_name, custom_headers: nil) ⇒ VirtualMachineTemplate

Implements virtual machine template GET method

Returns virtual machine templates by its name

(vsphereId) will be added to the HTTP request.

Parameters:

  • region_id (String) —

    The region Id (westus, eastus)

  • pc_name (String) —

    The private cloud name

  • virtual_machine_template_name (String) —

    virtual machine template id

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

    A hash of custom headers that

Returns:

  • (VirtualMachineTemplate) —

    operation results.



145
146
147
148
 
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machine_templates.rb', line 145

def get(region_id, pc_name, virtual_machine_template_name, custom_headers:nil)
  response = get_async(region_id, pc_name, virtual_machine_template_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(region_id, pc_name, virtual_machine_template_name, custom_headers: nil) ⇒ Concurrent::Promise

Implements virtual machine template GET method

Returns virtual machine templates by its name

(vsphereId) to the HTTP request.

Parameters:

  • region_id (String) —

    The region Id (westus, eastus)

  • pc_name (String) —

    The private cloud name

  • virtual_machine_template_name (String) —

    virtual machine template id

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machine_templates.rb', line 182

def get_async(region_id, pc_name, virtual_machine_template_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'region_id is nil' if region_id.nil?
  fail ArgumentError, 'pc_name is nil' if pc_name.nil?
  fail ArgumentError, 'virtual_machine_template_name is nil' if virtual_machine_template_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/virtualMachineTemplates/{virtualMachineTemplateName}'

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::VMwareCloudSimple::Mgmt::V2019_04_01::Models::VirtualMachineTemplate.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(region_id, pc_name, virtual_machine_template_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Implements virtual machine template GET method

Returns virtual machine templates by its name

(vsphereId) will be added to the HTTP request.

Parameters:

  • region_id (String) —

    The region Id (westus, eastus)

  • pc_name (String) —

    The private cloud name

  • virtual_machine_template_name (String) —

    virtual machine template id

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



164
165
166
 
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machine_templates.rb', line 164

def get_with_http_info(region_id, pc_name, virtual_machine_template_name, custom_headers:nil)
  get_async(region_id, pc_name, virtual_machine_template_name, custom_headers:custom_headers).value!
end

#list(pc_name, region_id, resource_pool_name, custom_headers: nil) ⇒ Array<VirtualMachineTemplate>

Implements list of available VM templates

Returns list of virtual machine templates in region for private cloud

cluster which contains VM templates will be added to the HTTP request.

Parameters:

  • pc_name (String) —

    The private cloud name

  • region_id (String) —

    The region Id (westus, eastus)

  • resource_pool_name (String) —

    Resource pool used to derive vSphere

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

    A hash of custom headers that

Returns:

  • (Array<VirtualMachineTemplate>) —

    operation results.



38
39
40
41
 
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machine_templates.rb', line 38

def list(pc_name, region_id, resource_pool_name, custom_headers:nil)
  first_page = list_as_lazy(pc_name, region_id, resource_pool_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(pc_name, region_id, resource_pool_name, custom_headers: nil) ⇒ VirtualMachineTemplateListResponse

Implements list of available VM templates

Returns list of virtual machine templates in region for private cloud

cluster which contains VM templates will be added to the HTTP request.

pages of the response.

Parameters:

  • pc_name (String) —

    The private cloud name

  • region_id (String) —

    The region Id (westus, eastus)

  • resource_pool_name (String) —

    Resource pool used to derive vSphere

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

    A hash of custom headers that

Returns:

  • (VirtualMachineTemplateListResponse) —

    which provide lazy access to



349
350
351
352
353
354
355
356
357
358
 
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machine_templates.rb', line 349

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

#list_async(pc_name, region_id, resource_pool_name, custom_headers: nil) ⇒ Concurrent::Promise

Implements list of available VM templates

Returns list of virtual machine templates in region for private cloud

cluster which contains VM templates to the HTTP request.

Parameters:

  • pc_name (String) —

    The private cloud name

  • region_id (String) —

    The region Id (westus, eastus)

  • resource_pool_name (String) —

    Resource pool used to derive vSphere

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machine_templates.rb', line 75

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


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

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'pcName' => pc_name,'regionId' => region_id},
      query_params: {'api-version' => @client.api_version,'resourcePoolName' => resource_pool_name},
      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 MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

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

    result
  end

  promise.execute
end

#list_next(next_page_link, custom_headers: nil) ⇒ VirtualMachineTemplateListResponse

Implements list of available VM templates

Returns list of virtual machine templates in region for private cloud

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (VirtualMachineTemplateListResponse) —

    operation results.



250
251
252
253
 
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machine_templates.rb', line 250

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

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

Implements list of available VM templates

Returns list of virtual machine templates in region for private cloud

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machine_templates.rb', line 283

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


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

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

  request_url = @base_url || @client.base_url

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

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

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

    result
  end

  promise.execute
end

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

Implements list of available VM templates

Returns list of virtual machine templates in region for private cloud

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



267
268
269
 
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machine_templates.rb', line 267

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

#list_with_http_info(pc_name, region_id, resource_pool_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Implements list of available VM templates

Returns list of virtual machine templates in region for private cloud

cluster which contains VM templates will be added to the HTTP request.

Parameters:

  • pc_name (String) —

    The private cloud name

  • region_id (String) —

    The region Id (westus, eastus)

  • resource_pool_name (String) —

    Resource pool used to derive vSphere

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



57
58
59
 
# File 'lib/2019-04-01/generated/azure_mgmt_vmware_cloudsimple/virtual_machine_templates.rb', line 57

def list_with_http_info(pc_name, region_id, resource_pool_name, custom_headers:nil)
  list_async(pc_name, region_id, resource_pool_name, custom_headers:custom_headers).value!
end