class Azure::Resources::Mgmt::V2016_02_01::Providers

Providers

Attributes

client[R]

@return [ResourceManagementClient] reference to the ResourceManagementClient

Private Class Methods

new(client) click to toggle source

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

# File lib/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 17
def initialize(client)
  @client = client
end

Private Instance Methods

get(resource_provider_namespace, expand:nil, custom_headers:nil) click to toggle source

Gets a resource provider.

@param resource_provider_namespace [String] Namespace of the resource provider. @param expand [String] The $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Provider] operation results.

# File lib/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 320
def get(resource_provider_namespace, expand:nil, custom_headers:nil)
  response = get_async(resource_provider_namespace, expand:expand, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_async(resource_provider_namespace, expand:nil, custom_headers:nil) click to toggle source

Gets a resource provider.

@param resource_provider_namespace [String] Namespace of the resource provider. @param expand [String] The $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases. @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/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 353
def get_async(resource_provider_namespace, expand:nil, custom_headers:nil)
  fail ArgumentError, 'resource_provider_namespace is nil' if resource_provider_namespace.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 = {}
  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/{resourceProviderNamespace}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceProviderNamespace' => resource_provider_namespace,'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?
    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::Resources::Mgmt::V2016_02_01::Models::Provider.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_provider_namespace, expand:nil, custom_headers:nil) click to toggle source

Gets a resource provider.

@param resource_provider_namespace [String] Namespace of the resource provider. @param expand [String] The $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases. @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/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 337
def get_with_http_info(resource_provider_namespace, expand:nil, custom_headers:nil)
  get_async(resource_provider_namespace, expand:expand, custom_headers:custom_headers).value!
end
list(top:nil, expand:nil, custom_headers:nil) click to toggle source

Gets a list of resource providers.

@param top [Integer] Query parameters. If null is passed returns all deployments. @param expand [String] The $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<Provider>] operation results.

# File lib/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 222
def list(top:nil, expand:nil, custom_headers:nil)
  first_page = list_as_lazy(top:top, expand:expand, custom_headers:custom_headers)
  first_page.get_all_items
end
list_as_lazy(top:nil, expand:nil, custom_headers:nil) click to toggle source

Gets a list of resource providers.

@param top [Integer] Query parameters. If null is passed returns all deployments. @param expand [String] The $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

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

# File lib/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 510
def list_as_lazy(top:nil, expand:nil, custom_headers:nil)
  response = list_async(top:top, expand:expand, 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(top:nil, expand:nil, custom_headers:nil) click to toggle source

Gets a list of resource providers.

@param top [Integer] Query parameters. If null is passed returns all deployments. @param expand [String] The $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases. @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/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 255
def list_async(top:nil, expand:nil, 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 = {}
  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'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'$top' => top,'$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::Resources::Mgmt::V2016_02_01::Models::ProviderListResult.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

Gets a list of resource providers.

@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 [ProviderListResult] operation results.

# File lib/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 417
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

Gets a list of resource providers.

@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/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 446
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::Resources::Mgmt::V2016_02_01::Models::ProviderListResult.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

Gets a list of resource providers.

@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/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 432
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(top:nil, expand:nil, custom_headers:nil) click to toggle source

Gets a list of resource providers.

@param top [Integer] Query parameters. If null is passed returns all deployments. @param expand [String] The $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases. @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/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 239
def list_with_http_info(top:nil, expand:nil, custom_headers:nil)
  list_async(top:top, expand:expand, custom_headers:custom_headers).value!
end
register(resource_provider_namespace, custom_headers:nil) click to toggle source

Registers provider to be used with a subscription.

@param resource_provider_namespace [String] Namespace of the resource provider. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Provider] operation results.

# File lib/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 127
def register(resource_provider_namespace, custom_headers:nil)
  response = register_async(resource_provider_namespace, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
register_async(resource_provider_namespace, custom_headers:nil) click to toggle source

Registers provider to be used with a subscription.

@param resource_provider_namespace [String] Namespace of the resource provider. @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/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 156
def register_async(resource_provider_namespace, custom_headers:nil)
  fail ArgumentError, 'resource_provider_namespace is nil' if resource_provider_namespace.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 = {}
  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/{resourceProviderNamespace}/register'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceProviderNamespace' => resource_provider_namespace,'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(:post, 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::Resources::Mgmt::V2016_02_01::Models::Provider.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
register_with_http_info(resource_provider_namespace, custom_headers:nil) click to toggle source

Registers provider to be used with a subscription.

@param resource_provider_namespace [String] Namespace of the resource provider. @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/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 142
def register_with_http_info(resource_provider_namespace, custom_headers:nil)
  register_async(resource_provider_namespace, custom_headers:custom_headers).value!
end
unregister(resource_provider_namespace, custom_headers:nil) click to toggle source

Unregisters provider from a subscription.

@param resource_provider_namespace [String] Namespace of the resource provider. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Provider] operation results.

# File lib/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 34
def unregister(resource_provider_namespace, custom_headers:nil)
  response = unregister_async(resource_provider_namespace, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
unregister_async(resource_provider_namespace, custom_headers:nil) click to toggle source

Unregisters provider from a subscription.

@param resource_provider_namespace [String] Namespace of the resource provider. @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/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 63
def unregister_async(resource_provider_namespace, custom_headers:nil)
  fail ArgumentError, 'resource_provider_namespace is nil' if resource_provider_namespace.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 = {}
  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/{resourceProviderNamespace}/unregister'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceProviderNamespace' => resource_provider_namespace,'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(:post, 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::Resources::Mgmt::V2016_02_01::Models::Provider.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
unregister_with_http_info(resource_provider_namespace, custom_headers:nil) click to toggle source

Unregisters provider from a subscription.

@param resource_provider_namespace [String] Namespace of the resource provider. @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/2016-02-01/generated/azure_mgmt_resources/providers.rb, line 49
def unregister_with_http_info(resource_provider_namespace, custom_headers:nil)
  unregister_async(resource_provider_namespace, custom_headers:custom_headers).value!
end