Class: Azure::CostManagement::Mgmt::V2019_01_01::QueryOperations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-01-01/generated/azure_mgmt_cost_management/query_operations.rb

Overview

QueryOperations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ QueryOperations

Creates and initializes a new instance of the QueryOperations class.

Parameters:

  • client —

    service class for accessing basic functionality.

[View source]

17
18
19
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/query_operations.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ CostManagementClient (readonly)

Returns reference to the CostManagementClient.

Returns:


22
23
24
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/query_operations.rb', line 22

def client
  @client
end

Instance Method Details

#usage_by_scope(scope, parameters, custom_headers: nil) ⇒ QueryResult

Query the usage data for scope defined.

includes '/subscriptions/subscriptionId/' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId for Management Group scope.. Query Config operation. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with query operations. This

  • parameters (QueryDefinition) —

    Parameters supplied to the CreateOrUpdate

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

    A hash of custom headers that

Returns:

  • (QueryResult) —

    operation results.

[View source]

46
47
48
49
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/query_operations.rb', line 46

def usage_by_scope(scope, parameters, custom_headers:nil)
  response = usage_by_scope_async(scope, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#usage_by_scope_async(scope, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Query the usage data for scope defined.

includes '/subscriptions/subscriptionId/' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId for Management Group scope.. Query Config operation. to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with query operations. This

  • parameters (QueryDefinition) —

    Parameters supplied to the CreateOrUpdate

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.

[View source]

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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/query_operations.rb', line 99

def usage_by_scope_async(scope, parameters, custom_headers:nil)
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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?

  # Serialize Request
  request_mapper = Azure::CostManagement::Mgmt::V2019_01_01::Models::QueryDefinition.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '{scope}/providers/Microsoft.CostManagement/query'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'scope' => scope},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      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 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_01_01::Models::QueryResult.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

#usage_by_scope_with_http_info(scope, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Query the usage data for scope defined.

includes '/subscriptions/subscriptionId/' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId for Management Group scope.. Query Config operation. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with query operations. This

  • parameters (QueryDefinition) —

    Parameters supplied to the CreateOrUpdate

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.

[View source]

73
74
75
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/query_operations.rb', line 73

def usage_by_scope_with_http_info(scope, parameters, custom_headers:nil)
  usage_by_scope_async(scope, parameters, custom_headers:custom_headers).value!
end