Class: Azure::Consumption::Mgmt::V2019_05_01_preview::UsageDetails
- Inherits:
-
Object
- Object
- Azure::Consumption::Mgmt::V2019_05_01_preview::UsageDetails
- Includes:
- MsRestAzure
- Defined in:
- lib/2019-05-01-preview/generated/azure_mgmt_consumption/usage_details.rb
Overview
Consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.
Instance Attribute Summary collapse
-
#client ⇒ ConsumptionManagementClient
readonly
Reference to the ConsumptionManagementClient.
Instance Method Summary collapse
-
#begin_download(scope, metric: nil, filter: nil, custom_headers: nil) ⇒ UsageDetailsDownloadResponse
Download usage details data.
-
#begin_download_async(scope, metric: nil, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise
Download usage details data.
-
#begin_download_with_http_info(scope, metric: nil, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Download usage details data.
-
#download(scope, metric: nil, filter: nil, custom_headers: nil) ⇒ UsageDetailsDownloadResponse
Download usage details data.
-
#download_async(scope, metric: nil, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise
This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope.
-
#initialize(client) ⇒ UsageDetails
constructor
Creates and initializes a new instance of the UsageDetails class.
-
#list(scope, expand: nil, filter: nil, skiptoken: nil, top: nil, metric: nil, custom_headers: nil) ⇒ Array<UsageDetail>
Lists the usage details for the defined scope.
-
#list_as_lazy(scope, expand: nil, filter: nil, skiptoken: nil, top: nil, metric: nil, custom_headers: nil) ⇒ UsageDetailsListResult
Lists the usage details for the defined scope.
-
#list_async(scope, expand: nil, filter: nil, skiptoken: nil, top: nil, metric: nil, custom_headers: nil) ⇒ Concurrent::Promise
Lists the usage details for the defined scope.
-
#list_next(next_page_link, custom_headers: nil) ⇒ UsageDetailsListResult
Lists the usage details for the defined scope.
-
#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists the usage details for the defined scope.
-
#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the usage details for the defined scope.
-
#list_with_http_info(scope, expand: nil, filter: nil, skiptoken: nil, top: nil, metric: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the usage details for the defined scope.
Constructor Details
#initialize(client) ⇒ UsageDetails
Creates and initializes a new instance of the UsageDetails class.
18 19 20 |
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 18 def initialize(client) @client = client end |
Instance Attribute Details
#client ⇒ ConsumptionManagementClient (readonly)
Returns reference to the ConsumptionManagementClient.
23 24 25 |
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 23 def client @client end |
Instance Method Details
#begin_download(scope, metric: nil, filter: nil, custom_headers: nil) ⇒ UsageDetailsDownloadResponse
Download usage details data.
This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId, properties/publisherType or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type will be added to the HTTP request.
339 340 341 342 |
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 339 def begin_download(scope, metric:nil, filter:nil, custom_headers:nil) response = begin_download_async(scope, metric:metric, filter:filter, custom_headers:custom_headers).value! response.body unless response.nil? end |
#begin_download_async(scope, metric: nil, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise
Download usage details data.
This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId, properties/publisherType or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type to the HTTP request.
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 |
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 414 def begin_download_async(scope, metric:nil, filter:nil, custom_headers:nil) fail ArgumentError, 'scope is nil' if scope.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 = '{scope}/providers/Microsoft.Consumption/usageDetails/download' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], skip_encoding_path_params: {'scope' => scope}, query_params: {'api-version' => @client.api_version,'metric' => metric,'$filter' => filter}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:post, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 || status_code == 202 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::Consumption::Mgmt::V2019_05_01_preview::Models::UsageDetailsDownloadResponse.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#begin_download_with_http_info(scope, metric: nil, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Download usage details data.
This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId, properties/publisherType or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type will be added to the HTTP request.
377 378 379 |
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 377 def begin_download_with_http_info(scope, metric:nil, filter:nil, custom_headers:nil) begin_download_async(scope, metric:metric, filter:filter, custom_headers:custom_headers).value! end |
#download(scope, metric: nil, filter: nil, custom_headers: nil) ⇒ UsageDetailsDownloadResponse
Download usage details data.
This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId, properties/publisherType or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type will be added to the HTTP request.
251 252 253 254 |
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 251 def download(scope, metric:nil, filter:nil, custom_headers:nil) response = download_async(scope, metric:metric, filter:filter, custom_headers:custom_headers).value! response.body unless response.nil? end |
#download_async(scope, metric: nil, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise
This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId, properties/publisherType or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type will be added to the HTTP request.
response.
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 |
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 288 def download_async(scope, metric:nil, filter:nil, custom_headers:nil) # Send request promise = begin_download_async(scope, metric:metric, filter:filter, custom_headers:custom_headers) promise = promise.then do |response| # Defining deserialization method. deserialize_method = lambda do |parsed_response| result_mapper = Azure::Consumption::Mgmt::V2019_05_01_preview::Models::UsageDetailsDownloadResponse.mapper() parsed_response = @client.deserialize(result_mapper, parsed_response) end # Waiting for response. @client.get_long_running_operation_result(response, deserialize_method, FinalStateVia::LOCATION) end promise end |
#list(scope, expand: nil, filter: nil, skiptoken: nil, top: nil, metric: nil, custom_headers: nil) ⇒ Array<UsageDetail>
Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.
This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId, properties/publisherType or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N usageDetails. records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' will be added to the HTTP request.
68 69 70 71 |
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 68 def list(scope, expand:nil, filter:nil, skiptoken:nil, top:nil, metric:nil, custom_headers:nil) first_page = list_as_lazy(scope, expand:, filter:filter, skiptoken:skiptoken, top:top, metric:metric, custom_headers:custom_headers) first_page.get_all_items end |
#list_as_lazy(scope, expand: nil, filter: nil, skiptoken: nil, top: nil, metric: nil, custom_headers: nil) ⇒ UsageDetailsListResult
Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.
This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId, properties/publisherType or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N usageDetails. records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' will be added to the HTTP request.
response.
604 605 606 607 608 609 610 611 612 613 |
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 604 def list_as_lazy(scope, expand:nil, filter:nil, skiptoken:nil, top:nil, metric:nil, custom_headers:nil) response = list_async(scope, expand:, filter:filter, skiptoken:skiptoken, top:top, metric:metric, 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(scope, expand: nil, filter: nil, skiptoken: nil, top: nil, metric: nil, custom_headers: nil) ⇒ Concurrent::Promise
Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.
This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId, properties/publisherType or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N usageDetails. records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' to the HTTP request.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 163 def list_async(scope, expand:nil, filter:nil, skiptoken:nil, top:nil, metric:nil, custom_headers:nil) fail ArgumentError, 'scope is nil' if scope.nil? fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMaximum': '1000'" if !top.nil? && top > 1000 fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMinimum': '1'" if !top.nil? && top < 1 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 = '{scope}/providers/Microsoft.Consumption/usageDetails' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], skip_encoding_path_params: {'scope' => scope}, query_params: {'$expand' => ,'$filter' => filter,'$skiptoken' => skiptoken,'$top' => top,'api-version' => @client.api_version,'metric' => metric}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) 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::Consumption::Mgmt::V2019_05_01_preview::Models::UsageDetailsListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#list_next(next_page_link, custom_headers: nil) ⇒ UsageDetailsListResult
Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.
to List operation. will be added to the HTTP request.
478 479 480 481 |
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 478 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) ⇒ Concurrent::Promise
Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.
to List operation. to the HTTP request.
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 |
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 509 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 = { 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, ) 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::Consumption::Mgmt::V2019_05_01_preview::Models::UsageDetailsListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.
to List operation. will be added to the HTTP request.
494 495 496 |
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 494 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(scope, expand: nil, filter: nil, skiptoken: nil, top: nil, metric: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.
This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId, properties/publisherType or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N usageDetails. records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' will be added to the HTTP request.
116 117 118 |
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 116 def list_with_http_info(scope, expand:nil, filter:nil, skiptoken:nil, top:nil, metric:nil, custom_headers:nil) list_async(scope, expand:, filter:filter, skiptoken:skiptoken, top:top, metric:metric, custom_headers:custom_headers).value! end |