class Azure::DevTestLabs::Mgmt::V2018_09_15::ArmTemplates

The DevTest Labs Client.

Attributes

client[R]

@return [DevTestLabsClient] reference to the DevTestLabsClient

Private Class Methods

new(client) click to toggle source

Creates and initializes a new instance of the ArmTemplates class. @param client service class for accessing basic functionality.

# File lib/2018-09-15/generated/azure_mgmt_devtestlabs/arm_templates.rb, line 17
def initialize(client)
  @client = client
end

Private Instance Methods

get(resource_group_name, lab_name, artifact_source_name, name, expand:nil, custom_headers:nil) click to toggle source

Get azure resource manager template.

@param resource_group_name [String] The name of the resource group. @param lab_name [String] The name of the lab. @param artifact_source_name [String] The name of the artifact source. @param name [String] The name of the azure resource manager template. @param expand [String] Specify the $expand query. Example: 'properties($select=displayName)' @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ArmTemplate] operation results.

# File lib/2018-09-15/generated/azure_mgmt_devtestlabs/arm_templates.rb, line 160
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) click to toggle source

Get azure resource manager template.

@param resource_group_name [String] The name of the resource group. @param lab_name [String] The name of the lab. @param artifact_source_name [String] The name of the artifact source. @param name [String] The name of the azure resource manager template. @param expand [String] Specify the $expand query. Example: 'properties($select=displayName)' @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2018-09-15/generated/azure_mgmt_devtestlabs/arm_templates.rb, line 197
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?
    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::DevTestLabs::Mgmt::V2018_09_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) click to toggle source

Get azure resource manager template.

@param resource_group_name [String] The name of the resource group. @param lab_name [String] The name of the lab. @param artifact_source_name [String] The name of the artifact source. @param name [String] The name of the azure resource manager template. @param expand [String] Specify the $expand query. Example: 'properties($select=displayName)' @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2018-09-15/generated/azure_mgmt_devtestlabs/arm_templates.rb, line 179
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) click to toggle source

List azure resource manager templates in a given artifact source.

@param resource_group_name [String] The name of the resource group. @param lab_name [String] The name of the lab. @param artifact_source_name [String] The name of the artifact source. @param expand [String] Specify the $expand query. Example: 'properties($select=displayName)' @param filter [String] The filter to apply to the operation. Example: '$filter=contains(name,'myName') @param top [Integer] The maximum number of resources to return from the operation. Example: '$top=10' @param orderby [String] The ordering expression for the results, using OData notation. Example: '$orderby=name desc' @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<ArmTemplate>] operation results.

# File lib/2018-09-15/generated/azure_mgmt_devtestlabs/arm_templates.rb, line 43
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) click to toggle source

List azure resource manager templates in a given artifact source.

@param resource_group_name [String] The name of the resource group. @param lab_name [String] The name of the lab. @param artifact_source_name [String] The name of the artifact source. @param expand [String] Specify the $expand query. Example: 'properties($select=displayName)' @param filter [String] The filter to apply to the operation. Example: '$filter=contains(name,'myName') @param top [Integer] The maximum number of resources to return from the operation. Example: '$top=10' @param orderby [String] The ordering expression for the results, using OData notation. Example: '$orderby=name desc' @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ArmTemplateList] which provide lazy access to pages of the response.

# File lib/2018-09-15/generated/azure_mgmt_devtestlabs/arm_templates.rb, line 363
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) click to toggle source

List azure resource manager templates in a given artifact source.

@param resource_group_name [String] The name of the resource group. @param lab_name [String] The name of the lab. @param artifact_source_name [String] The name of the artifact source. @param expand [String] Specify the $expand query. Example: 'properties($select=displayName)' @param filter [String] The filter to apply to the operation. Example: '$filter=contains(name,'myName') @param top [Integer] The maximum number of resources to return from the operation. Example: '$top=10' @param orderby [String] The ordering expression for the results, using OData notation. Example: '$orderby=name desc' @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2018-09-15/generated/azure_mgmt_devtestlabs/arm_templates.rb, line 90
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?
    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::DevTestLabs::Mgmt::V2018_09_15::Models::ArmTemplateList.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) click to toggle source

List azure resource manager templates in a given artifact source.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ArmTemplateList] operation results.

# File lib/2018-09-15/generated/azure_mgmt_devtestlabs/arm_templates.rb, line 264
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) click to toggle source

List azure resource manager templates in a given artifact source.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2018-09-15/generated/azure_mgmt_devtestlabs/arm_templates.rb, line 293
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?
    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::DevTestLabs::Mgmt::V2018_09_15::Models::ArmTemplateList.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) click to toggle source

List azure resource manager templates in a given artifact source.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2018-09-15/generated/azure_mgmt_devtestlabs/arm_templates.rb, line 279
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) click to toggle source

List azure resource manager templates in a given artifact source.

@param resource_group_name [String] The name of the resource group. @param lab_name [String] The name of the lab. @param artifact_source_name [String] The name of the artifact source. @param expand [String] Specify the $expand query. Example: 'properties($select=displayName)' @param filter [String] The filter to apply to the operation. Example: '$filter=contains(name,'myName') @param top [Integer] The maximum number of resources to return from the operation. Example: '$top=10' @param orderby [String] The ordering expression for the results, using OData notation. Example: '$orderby=name desc' @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2018-09-15/generated/azure_mgmt_devtestlabs/arm_templates.rb, line 67
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