query

Creates, updates, deletes, gets or lists a query resource.

Overview

Name	query
Type	Resource
Id	azure.cost_management.query

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
usage	exec	scope, type, timeframe, dataset		Query the usage data for scope defined.
usage_by_external_cloud_provider_type	exec	external_cloud_provider_type, external_cloud_provider_id, type, timeframe, dataset		Query the usage data for external cloud provider type defined.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
external_cloud_provider_id	string	This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations. Required.
external_cloud_provider_type	string	The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account. Known values are: "externalSubscriptions" and "externalBillingAccounts". Required.
scope	string	The scope associated with query and export operations. This 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, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. Required.

Lifecycle Methods

usage

Query the usage data for scope defined.

EXEC azure.cost_management.query.usage 
@scope='{{ scope }}' --required 
@@json=
'{
"type": "{{ type }}", 
"timeframe": "{{ timeframe }}", 
"timePeriod": "{{ timePeriod }}", 
"dataset": "{{ dataset }}"
}'
;

usage_by_external_cloud_provider_type

Query the usage data for external cloud provider type defined.

EXEC azure.cost_management.query.usage_by_external_cloud_provider_type 
@external_cloud_provider_type='{{ external_cloud_provider_type }}' --required, 
@external_cloud_provider_id='{{ external_cloud_provider_id }}' --required 
@@json=
'{
"type": "{{ type }}", 
"timeframe": "{{ timeframe }}", 
"timePeriod": "{{ timePeriod }}", 
"dataset": "{{ dataset }}"
}'
;