Share via

Query interface

  • Reference
Package:
@azure/arm-costmanagement

Interface representing a Query.

Methods

usage(string, QueryDefinition, QueryUsageOptionalParams)

Query the usage data for scope defined.
usageByExternalCloudProviderType(string, string, QueryDefinition, QueryUsageByExternalCloudProviderTypeOptionalParams)

Query the usage data for external cloud provider type defined.

Method Details

usage(string, QueryDefinition, QueryUsageOptionalParams)

Query the usage data for scope defined.

function usage(scope: string, parameters: QueryDefinition, options?: QueryUsageOptionalParams): Promise<QueryResult>

Parameters

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.

parameters
QueryDefinition

Parameters supplied to the CreateOrUpdate Query Config operation.

options
QueryUsageOptionalParams

The options parameters.

Returns

Promise<QueryResult>

usageByExternalCloudProviderType(string, string, QueryDefinition, QueryUsageByExternalCloudProviderTypeOptionalParams)

Query the usage data for external cloud provider type defined.

function usageByExternalCloudProviderType(externalCloudProviderType: string, externalCloudProviderId: string, parameters: QueryDefinition, options?: QueryUsageByExternalCloudProviderTypeOptionalParams): Promise<QueryResult>

Parameters

externalCloudProviderType

string

The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.

externalCloudProviderId

string

This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations.

parameters
QueryDefinition

Parameters supplied to the CreateOrUpdate Query Config operation.

options
QueryUsageByExternalCloudProviderTypeOptionalParams

The options parameters.

Returns

Promise<QueryResult>