Class: Azure::DevTestLabs::Mgmt::V2016_05_15::ArmTemplates

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-05-15/generated/azure_mgmt_devtestlabs/arm_templates.rb

Overview

The DevTest Labs Client.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ArmTemplates

Creates and initializes a new instance of the ArmTemplates class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/arm_templates.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ DevTestLabsClient (readonly)

Returns reference to the DevTestLabsClient.

Returns:



22
23
24
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/arm_templates.rb', line 22

def client
  @client
end

Instance Method Details

#get(resource_group_name, lab_name, artifact_source_name, name, expand: nil, custom_headers: nil) ⇒ ArmTemplate

Get azure resource manager template.

‘properties($select=displayName)’ will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • artifact_source_name (String) —

    The name of the artifact source.

  • name (String) —

    The name of the azure Resource Manager template.

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

    Specify the $expand query. Example:

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

    A hash of custom headers that

Returns:

  • (ArmTemplate) —

    operation results.



155
156
157
158
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/arm_templates.rb', line 155

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

#get_async(resource_group_name, lab_name, artifact_source_name, name, expand: nil, custom_headers: nil) ⇒ Concurrent::Promise

Get azure resource manager template.

‘properties($select=displayName)’ to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • artifact_source_name (String) —

    The name of the artifact source.

  • name (String) —

    The name of the azure Resource Manager template.

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

    Specify the $expand query. Example:

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
237
238
239
240
241
242
243
244
245
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/arm_templates.rb', line 192

def get_async(resource_group_name, lab_name, artifact_source_name, name, expand:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'lab_name is nil' if lab_name.nil?
  fail ArgumentError, 'artifact_source_name is nil' if artifact_source_name.nil?
  fail ArgumentError, 'name is nil' if 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/armtemplates/{name}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'labName' => lab_name,'artifactSourceName' => artifact_source_name,'name' => name},
      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::DevTestLabs::Mgmt::V2016_05_15::Models::ArmTemplate.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, lab_name, artifact_source_name, name, expand: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get azure resource manager template.

‘properties($select=displayName)’ will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • artifact_source_name (String) —

    The name of the artifact source.

  • name (String) —

    The name of the azure Resource Manager template.

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

    Specify the $expand query. Example:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



174
175
176
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/arm_templates.rb', line 174

def get_with_http_info(resource_group_name, lab_name, artifact_source_name, name, expand:nil, custom_headers:nil)
  get_async(resource_group_name, lab_name, artifact_source_name, name, expand:expand, custom_headers:custom_headers).value!
end

#list(resource_group_name, lab_name, artifact_source_name, expand: nil, filter: nil, top: nil, orderby: nil, custom_headers: nil) ⇒ Array<ArmTemplate>

List azure resource manager templates in a given artifact source.

‘properties($select=displayName)’ operation. notation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • artifact_source_name (String) —

    The name of the artifact source.

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

    Specify the $expand query. Example:

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

    The filter to apply to the operation.

  • top (Integer) (defaults to: nil) —

    The maximum number of resources to return from the

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

    The ordering expression for the results, using OData

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

    A hash of custom headers that

Returns:

  • (Array<ArmTemplate>) —

    operation results.



42
43
44
45
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/arm_templates.rb', line 42

def list(resource_group_name, lab_name, artifact_source_name, expand:nil, filter:nil, top:nil, orderby:nil, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, lab_name, artifact_source_name, expand:expand, filter:filter, top:top, orderby:orderby, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(resource_group_name, lab_name, artifact_source_name, expand: nil, filter: nil, top: nil, orderby: nil, custom_headers: nil) ⇒ ResponseWithContinuationArmTemplate

List azure resource manager templates in a given artifact source.

‘properties($select=displayName)’ operation. notation. will be added to the HTTP request.

pages of the response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • artifact_source_name (String) —

    The name of the artifact source.

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

    Specify the $expand query. Example:

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

    The filter to apply to the operation.

  • top (Integer) (defaults to: nil) —

    The maximum number of resources to return from the

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

    The ordering expression for the results, using OData

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

    A hash of custom headers that

Returns:

  • (ResponseWithContinuationArmTemplate) —

    which provide lazy access to



354
355
356
357
358
359
360
361
362
363
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/arm_templates.rb', line 354

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

#list_async(resource_group_name, lab_name, artifact_source_name, expand: nil, filter: nil, top: nil, orderby: nil, custom_headers: nil) ⇒ Concurrent::Promise

List azure resource manager templates in a given artifact source.

‘properties($select=displayName)’ operation. notation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • artifact_source_name (String) —

    The name of the artifact source.

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

    Specify the $expand query. Example:

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

    The filter to apply to the operation.

  • top (Integer) (defaults to: nil) —

    The maximum number of resources to return from the

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

    The ordering expression for the results, using OData

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/arm_templates.rb', line 87

def list_async(resource_group_name, lab_name, artifact_source_name, expand:nil, filter:nil, top:nil, orderby:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'lab_name is nil' if lab_name.nil?
  fail ArgumentError, 'artifact_source_name is nil' if artifact_source_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}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/armtemplates'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'labName' => lab_name,'artifactSourceName' => artifact_source_name},
      query_params: {'$expand' => expand,'$filter' => filter,'$top' => top,'$orderby' => orderby,'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::DevTestLabs::Mgmt::V2016_05_15::Models::ResponseWithContinuationArmTemplate.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) ⇒ ResponseWithContinuationArmTemplate

List azure resource manager templates in a given artifact source.

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:

  • (ResponseWithContinuationArmTemplate) —

    operation results.



257
258
259
260
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/arm_templates.rb', line 257

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

List azure resource manager templates in a given artifact source.

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.



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
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/arm_templates.rb', line 286

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


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

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

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::DevTestLabs::Mgmt::V2016_05_15::Models::ResponseWithContinuationArmTemplate.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

List azure resource manager templates in a given artifact source.

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.



272
273
274
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/arm_templates.rb', line 272

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

#list_with_http_info(resource_group_name, lab_name, artifact_source_name, expand: nil, filter: nil, top: nil, orderby: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List azure resource manager templates in a given artifact source.

‘properties($select=displayName)’ operation. notation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • artifact_source_name (String) —

    The name of the artifact source.

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

    Specify the $expand query. Example:

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

    The filter to apply to the operation.

  • top (Integer) (defaults to: nil) —

    The maximum number of resources to return from the

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

    The ordering expression for the results, using OData

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



65
66
67
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/arm_templates.rb', line 65

def list_with_http_info(resource_group_name, lab_name, artifact_source_name, expand:nil, filter:nil, top:nil, orderby:nil, custom_headers:nil)
  list_async(resource_group_name, lab_name, artifact_source_name, expand:expand, filter:filter, top:top, orderby:orderby, custom_headers:custom_headers).value!
end