class Azure::Resources::Mgmt::V2016_09_01::Providers


Provides operations for working with resources and resource groups.

def get(resource_provider_namespace, expand:nil, custom_headers:nil)

Returns:
  • (Provider) - operation results.

Parameters:
  • custom_headers (Hash{String => String}) -- A hash of custom headers that
  • expand (String) -- The $expand query parameter. For example, to include
  • resource_provider_namespace (String) -- The namespace of the resource 
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

def get_async(resource_provider_namespace, expand:nil, custom_headers:nil)

Returns:
  • (Concurrent::Promise) - Promise object which holds the HTTP response.

Parameters:
  • A (Hash{String => String}) -- hash of custom headers that will be added
  • expand (String) -- The $expand query parameter. For example, to include
  • resource_provider_namespace (String) -- The namespace of the resource 
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_09_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

def get_with_http_info(resource_provider_namespace, expand:nil, custom_headers:nil)

Returns:
  • (MsRestAzure::AzureOperationResponse) - HTTP response information.

Parameters:
  • custom_headers (Hash{String => String}) -- A hash of custom headers that
  • expand (String) -- The $expand query parameter. For example, to include
  • resource_provider_namespace (String) -- The namespace of the resource 
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

def initialize(client)

Parameters:
  • client () -- service class for accessing basic functionality. 
def initialize(client)
  @client = client
end

def list(top:nil, expand:nil, custom_headers:nil)

Returns:
  • (Array) - operation results.

Parameters:
  • custom_headers (Hash{String => String}) -- A hash of custom headers that
  • expand (String) -- The properties to include in the results. For example,
  • top (Integer) -- The number of results to return. If null is passed 
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

def list_as_lazy(top:nil, expand:nil, custom_headers:nil)

Returns:
  • (ProviderListResult) - which provide lazy access to pages of the

Parameters:
  • custom_headers (Hash{String => String}) -- A hash of custom headers that
  • expand (String) -- The properties to include in the results. For example,
  • top (Integer) -- The number of results to return. If null is passed 
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

def list_async(top:nil, expand:nil, custom_headers:nil)

Returns:
  • (Concurrent::Promise) - Promise object which holds the HTTP response.

Parameters:
  • A (Hash{String => String}) -- hash of custom headers that will be added
  • expand (String) -- The properties to include in the results. For example,
  • top (Integer) -- The number of results to return. If null is passed 
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_09_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

def list_next(next_page_link, custom_headers:nil)

Returns:
  • (ProviderListResult) - operation results.

Parameters:
  • custom_headers (Hash{String => String}) -- A hash of custom headers that
  • next_page_link (String) -- The NextLink from the previous successful call 
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

def list_next_async(next_page_link, custom_headers:nil)

Returns:
  • (Concurrent::Promise) - Promise object which holds the HTTP response.

Parameters:
  • A (Hash{String => String}) -- hash of custom headers that will be added
  • next_page_link (String) -- The NextLink from the previous successful call 
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_09_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

def list_next_with_http_info(next_page_link, custom_headers:nil)

Returns:
  • (MsRestAzure::AzureOperationResponse) - HTTP response information.

Parameters:
  • custom_headers (Hash{String => String}) -- A hash of custom headers that
  • next_page_link (String) -- The NextLink from the previous successful call 
def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

def list_with_http_info(top:nil, expand:nil, custom_headers:nil)

Returns:
  • (MsRestAzure::AzureOperationResponse) - HTTP response information.

Parameters:
  • custom_headers (Hash{String => String}) -- A hash of custom headers that
  • expand (String) -- The properties to include in the results. For example,
  • top (Integer) -- The number of results to return. If null is passed 
def list_with_http_info(top:nil, expand:nil, custom_headers:nil)
  list_async(top:top, expand:expand, custom_headers:custom_headers).value!
end

def register(resource_provider_namespace, custom_headers:nil)

Returns:
  • (Provider) - operation results.

Parameters:
  • custom_headers (Hash{String => String}) -- A hash of custom headers that
  • resource_provider_namespace (String) -- The namespace of the resource 
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

def register_async(resource_provider_namespace, custom_headers:nil)

Returns:
  • (Concurrent::Promise) - Promise object which holds the HTTP response.

Parameters:
  • A (Hash{String => String}) -- hash of custom headers that will be added
  • resource_provider_namespace (String) -- The namespace of the resource 
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_09_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

def register_with_http_info(resource_provider_namespace, custom_headers:nil)

Returns:
  • (MsRestAzure::AzureOperationResponse) - HTTP response information.

Parameters:
  • custom_headers (Hash{String => String}) -- A hash of custom headers that
  • resource_provider_namespace (String) -- The namespace of the resource 
def register_with_http_info(resource_provider_namespace, custom_headers:nil)
  register_async(resource_provider_namespace, custom_headers:custom_headers).value!
end

def unregister(resource_provider_namespace, custom_headers:nil)

Returns:
  • (Provider) - operation results.

Parameters:
  • custom_headers (Hash{String => String}) -- A hash of custom headers that
  • resource_provider_namespace (String) -- The namespace of the resource 
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

def unregister_async(resource_provider_namespace, custom_headers:nil)

Returns:
  • (Concurrent::Promise) - Promise object which holds the HTTP response.

Parameters:
  • A (Hash{String => String}) -- hash of custom headers that will be added
  • resource_provider_namespace (String) -- The namespace of the resource 
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_09_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

def unregister_with_http_info(resource_provider_namespace, custom_headers:nil)

Returns:
  • (MsRestAzure::AzureOperationResponse) - HTTP response information.

Parameters:
  • custom_headers (Hash{String => String}) -- A hash of custom headers that
  • resource_provider_namespace (String) -- The namespace of the resource 
def unregister_with_http_info(resource_provider_namespace, custom_headers:nil)
  unregister_async(resource_provider_namespace, custom_headers:custom_headers).value!
end