class Azure::CostManagement::Mgmt::V2019_03_01_preview::ExternalSubscription
Attributes
@return [CostManagementClient] reference to the CostManagementClient
Public Class Methods
Creates and initializes a new instance of the ExternalSubscription
class. @param client service class for accessing basic functionality.
# File lib/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 17 def initialize(client) @client = client end
Public Instance Methods
Get an ExternalSubscription
definition
@param external_subscription_name [String] External Subscription Name. (eg 'aws-{UsageAccountId}') @param expand [String] May be used to expand the collectionInfo property. By default, collectionInfo is not included. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [ExternalSubscriptionDefinition] operation results.
# File lib/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 212 def get(external_subscription_name, expand:nil, custom_headers:nil) response = get_async(external_subscription_name, expand:expand, custom_headers:custom_headers).value! response.body unless response.nil? end
Get an ExternalSubscription
definition
@param external_subscription_name [String] External Subscription Name. (eg 'aws-{UsageAccountId}') @param expand [String] May be used to expand the collectionInfo property. By default, collectionInfo is not included. @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/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 245 def get_async(external_subscription_name, expand:nil, custom_headers:nil) fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, 'external_subscription_name is nil' if external_subscription_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 = 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'externalSubscriptionName' => external_subscription_name}, query_params: {'api-version' => @client.api_version,'$expand' => expand}, 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::CostManagement::Mgmt::V2019_03_01_preview::Models::ExternalSubscriptionDefinition.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 an ExternalSubscription
definition
@param external_subscription_name [String] External Subscription Name. (eg 'aws-{UsageAccountId}') @param expand [String] May be used to expand the collectionInfo property. By default, collectionInfo is not included. @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/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 229 def get_with_http_info(external_subscription_name, expand:nil, custom_headers:nil) get_async(external_subscription_name, expand:expand, custom_headers:custom_headers).value! end
List all ExternalSubscription
definitions
@param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [ExternalSubscriptionDefinitionListResult] operation results.
# File lib/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 124 def list(custom_headers:nil) response = list_async(custom_headers:custom_headers).value! response.body unless response.nil? end
List all ExternalSubscription
definitions
@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/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 149 def list_async(custom_headers: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 = 'providers/Microsoft.CostManagement/externalSubscriptions' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], 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::CostManagement::Mgmt::V2019_03_01_preview::Models::ExternalSubscriptionDefinitionListResult.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 all ExternalSubscriptions by ExternalBillingAccount
definitions
@param external_billing_account_name [String] External Billing Account Name. (eg 'aws-{PayerAccountId}') @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [ExternalSubscriptionDefinitionListResult] operation results.
# File lib/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 34 def list_by_external_billing_account(external_billing_account_name, custom_headers:nil) response = list_by_external_billing_account_async(external_billing_account_name, custom_headers:custom_headers).value! response.body unless response.nil? end
List all ExternalSubscriptions by ExternalBillingAccount
definitions
@param external_billing_account_name [String] External Billing Account Name. (eg 'aws-{PayerAccountId}') @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/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 63 def list_by_external_billing_account_async(external_billing_account_name, custom_headers:nil) fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, 'external_billing_account_name is nil' if external_billing_account_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 = 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}/externalSubscriptions' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'externalBillingAccountName' => external_billing_account_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::CostManagement::Mgmt::V2019_03_01_preview::Models::ExternalSubscriptionDefinitionListResult.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 all ExternalSubscriptions by ExternalBillingAccount
definitions
@param external_billing_account_name [String] External Billing Account Name. (eg 'aws-{PayerAccountId}') @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/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 49 def list_by_external_billing_account_with_http_info(external_billing_account_name, custom_headers:nil) list_by_external_billing_account_async(external_billing_account_name, custom_headers:custom_headers).value! end
List all ExternalSubscription
definitions for Management Group
@param management_group_id [String] ManagementGroup ID @param recurse [Boolean] The $recurse=true query string parameter allows returning externalSubscriptions associated with the specified managementGroup, or any of its descendants. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [ExternalSubscriptionDefinitionListResult] operation results.
# File lib/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 310 def list_by_management_group(management_group_id, recurse:nil, custom_headers:nil) response = list_by_management_group_async(management_group_id, recurse:recurse, custom_headers:custom_headers).value! response.body unless response.nil? end
List all ExternalSubscription
definitions for Management Group
@param management_group_id [String] ManagementGroup ID @param recurse [Boolean] The $recurse=true query string parameter allows returning externalSubscriptions associated with the specified managementGroup, or any of its descendants. @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/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 343 def list_by_management_group_async(management_group_id, recurse:nil, custom_headers:nil) fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, 'management_group_id is nil' if management_group_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 = 'providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/externalSubscriptions' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'managementGroupId' => management_group_id}, query_params: {'api-version' => @client.api_version,'$recurse' => recurse}, 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::CostManagement::Mgmt::V2019_03_01_preview::Models::ExternalSubscriptionDefinitionListResult.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 all ExternalSubscription
definitions for Management Group
@param management_group_id [String] ManagementGroup ID @param recurse [Boolean] The $recurse=true query string parameter allows returning externalSubscriptions associated with the specified managementGroup, or any of its descendants. @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/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 327 def list_by_management_group_with_http_info(management_group_id, recurse:nil, custom_headers:nil) list_by_management_group_async(management_group_id, recurse:recurse, custom_headers:custom_headers).value! end
List all ExternalSubscription
definitions
@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/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 137 def list_with_http_info(custom_headers:nil) list_async(custom_headers:custom_headers).value! end
Updates the management group of an ExternalSubscription
@param management_group_id [String] ManagementGroup ID @param external_subscription_name [String] External Subscription Name. (eg 'aws-{UsageAccountId}') @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
# File lib/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 406 def update_management_group(management_group_id, external_subscription_name, custom_headers:nil) response = update_management_group_async(management_group_id, external_subscription_name, custom_headers:custom_headers).value! nil end
Updates the management group of an ExternalSubscription
@param management_group_id [String] ManagementGroup ID @param external_subscription_name [String] External Subscription Name. (eg 'aws-{UsageAccountId}') @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/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 437 def update_management_group_async(management_group_id, external_subscription_name, custom_headers:nil) fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, 'management_group_id is nil' if management_group_id.nil? fail ArgumentError, 'external_subscription_name is nil' if external_subscription_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 = 'providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'managementGroupId' => management_group_id,'externalSubscriptionName' => external_subscription_name}, query_params: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:put, 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 == 204 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? result end promise.execute end
Updates the management group of an ExternalSubscription
@param management_group_id [String] ManagementGroup ID @param external_subscription_name [String] External Subscription Name. (eg 'aws-{UsageAccountId}') @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/2019-03-01-preview/generated/azure_mgmt_cost_management/external_subscription.rb, line 422 def update_management_group_with_http_info(management_group_id, external_subscription_name, custom_headers:nil) update_management_group_async(management_group_id, external_subscription_name, custom_headers:custom_headers).value! end