Consulte los datos de uso para el ámbito definido.
POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/query?api-version=2025-03-01
Parámetros de identificador URI
| Nombre |
En |
Requerido |
Tipo |
Description |
|
scope
|
path |
True
|
string
|
Ámbito asociado a las operaciones de consulta y exportación. Esto incluye '/subscriptions/{subscriptionId}/' para el ámbito de la suscripción, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para el ámbito resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para el ámbito de la cuenta de facturación y '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para el ámbito del departamento, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' para el ámbito EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId} para el ámbito del grupo de administración, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para el ámbito billingProfile, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' para el ámbito invoiceSection y '/providers/Microsoft. Billing/billingAccounts/{billingAccountId}/customers/{customerId}' específico para los partners.
|
|
api-version
|
query |
True
|
string
minLength: 1
|
Versión de la API que se va a usar para esta operación.
|
Cuerpo de la solicitud
| Nombre |
Requerido |
Tipo |
Description |
|
dataset
|
True
|
QueryDataset
|
Tiene una definición para los datos de esta consulta.
|
|
timeframe
|
True
|
TimeframeType
|
Período de tiempo para extraer datos de la consulta. Si es personalizado, se debe proporcionar un período de tiempo específico.
|
|
type
|
True
|
ExportType
|
Tipo de la consulta.
|
|
timePeriod
|
|
QueryTimePeriod
|
Tiene un período de tiempo para extraer datos de la consulta.
|
Respuestas
| Nombre |
Tipo |
Description |
|
200 OK
|
QueryResult
|
La operación de Azure se completó correctamente.
|
|
204 No Content
|
|
No hay contenido que enviar para esta solicitud, pero los encabezados pueden ser útiles.
|
|
Other Status Codes
|
ErrorResponse
|
Una respuesta de error inesperada.
|
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
| Nombre |
Description |
|
user_impersonation
|
suplantar la cuenta de usuario
|
Ejemplos
BillingAccountQuery-Legacy
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
},
"granularity": "Daily"
},
"timeframe": "MonthToDate"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/BillingAccountQuery.json
func ExampleQueryClient_Usage_billingAccountQueryLegacy() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Billing/billingAccounts/70664866", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Filter: &armcostmanagement.QueryFilter{
And: []*armcostmanagement.QueryFilter{
{
Or: []*armcostmanagement.QueryFilter{
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceLocation"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("East US"),
to.Ptr("West Europe"),
},
},
},
{
Tags: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("Environment"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("UAT"),
to.Ptr("Prod"),
},
},
},
},
},
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceGroup"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("API"),
},
},
},
},
},
Granularity: to.Ptr(armcostmanagement.GranularityTypeDaily),
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeMonthToDate),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("UsageDate"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// 20180331,
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// 20180331,
// "USD",
// },
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// 20180331,
// "USD",
// },
// []any{
// 0.16677720329728665,
// "gs-stms-dev",
// 20180331,
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
],
[
0.16677720329728665,
"gs-stms-dev",
20180331,
"USD"
]
]
}
}
BillingAccountQuery-MCA
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
},
"granularity": "Daily"
},
"timeframe": "MonthToDate"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/MCABillingAccountQuery.json
func ExampleQueryClient_Usage_billingAccountQueryMca() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Billing/billingAccounts/12345:6789", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Filter: &armcostmanagement.QueryFilter{
And: []*armcostmanagement.QueryFilter{
{
Or: []*armcostmanagement.QueryFilter{
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceLocation"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("East US"),
to.Ptr("West Europe"),
},
},
},
{
Tags: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("Environment"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("UAT"),
to.Ptr("Prod"),
},
},
},
},
},
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceGroup"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("API"),
},
},
},
},
},
Granularity: to.Ptr(armcostmanagement.GranularityTypeDaily),
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeMonthToDate),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("UsageDate"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// 20180331,
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// 20180331,
// "USD",
// },
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// 20180331,
// "USD",
// },
// []any{
// 0.16677720329728665,
// "gs-stms-dev",
// 20180331,
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
],
[
0.16677720329728665,
"gs-stms-dev",
20180331,
"USD"
]
]
}
}
BillingAccountQueryGrouping-Legacy
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"granularity": "None",
"grouping": [
{
"name": "ResourceGroup",
"type": "Dimension"
}
]
},
"timeframe": "TheLastMonth"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/BillingAccountQueryGrouping.json
func ExampleQueryClient_Usage_billingAccountQueryGroupingLegacy() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Billing/billingAccounts/70664866", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Aggregation: map[string]*armcostmanagement.QueryAggregation{
"totalCost": {
Name: to.Ptr("PreTaxCost"),
Function: to.Ptr(armcostmanagement.FunctionTypeSum),
},
},
Granularity: to.Ptr(armcostmanagement.GranularityType("None")),
Grouping: []*armcostmanagement.QueryGrouping{
{
Name: to.Ptr("ResourceGroup"),
Type: to.Ptr(armcostmanagement.QueryColumnTypeDimension),
},
},
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeTheLastMonth),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// "USD",
// },
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
"USD"
]
]
}
}
BillingAccountQueryGrouping-MCA
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"granularity": "None",
"grouping": [
{
"name": "ResourceGroup",
"type": "Dimension"
}
]
},
"timeframe": "TheLastMonth"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/MCABillingAccountQueryGrouping.json
func ExampleQueryClient_Usage_billingAccountQueryGroupingMca() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Billing/billingAccounts/12345:6789", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Aggregation: map[string]*armcostmanagement.QueryAggregation{
"totalCost": {
Name: to.Ptr("PreTaxCost"),
Function: to.Ptr(armcostmanagement.FunctionTypeSum),
},
},
Granularity: to.Ptr(armcostmanagement.GranularityType("None")),
Grouping: []*armcostmanagement.QueryGrouping{
{
Name: to.Ptr("ResourceGroup"),
Type: to.Ptr(armcostmanagement.QueryColumnTypeDimension),
},
},
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeTheLastMonth),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// "USD",
// },
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
"USD"
]
]
}
}
BillingProfileQuery-MCA
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
},
"granularity": "Daily"
},
"timeframe": "MonthToDate"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/MCABillingProfileQuery.json
func ExampleQueryClient_Usage_billingProfileQueryMca() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Filter: &armcostmanagement.QueryFilter{
And: []*armcostmanagement.QueryFilter{
{
Or: []*armcostmanagement.QueryFilter{
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceLocation"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("East US"),
to.Ptr("West Europe"),
},
},
},
{
Tags: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("Environment"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("UAT"),
to.Ptr("Prod"),
},
},
},
},
},
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceGroup"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("API"),
},
},
},
},
},
Granularity: to.Ptr(armcostmanagement.GranularityTypeDaily),
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeMonthToDate),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("UsageDate"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// 20180331,
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// 20180331,
// "USD",
// },
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// 20180331,
// "USD",
// },
// []any{
// 0.16677720329728665,
// "gs-stms-dev",
// 20180331,
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
],
[
0.16677720329728665,
"gs-stms-dev",
20180331,
"USD"
]
]
}
}
BillingProfileQueryGrouping-MCA
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"granularity": "None",
"grouping": [
{
"name": "ResourceGroup",
"type": "Dimension"
}
]
},
"timeframe": "TheLastMonth"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/MCABillingProfileQueryGrouping.json
func ExampleQueryClient_Usage_billingProfileQueryGroupingMca() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Aggregation: map[string]*armcostmanagement.QueryAggregation{
"totalCost": {
Name: to.Ptr("PreTaxCost"),
Function: to.Ptr(armcostmanagement.FunctionTypeSum),
},
},
Granularity: to.Ptr(armcostmanagement.GranularityType("None")),
Grouping: []*armcostmanagement.QueryGrouping{
{
Name: to.Ptr("ResourceGroup"),
Type: to.Ptr(armcostmanagement.QueryColumnTypeDimension),
},
},
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeTheLastMonth),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// "USD",
// },
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
"USD"
]
]
}
}
CustomerQuery-MCA
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
},
"granularity": "Daily"
},
"timeframe": "MonthToDate"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/MCACustomerQuery.json
func ExampleQueryClient_Usage_customerQueryMca() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Filter: &armcostmanagement.QueryFilter{
And: []*armcostmanagement.QueryFilter{
{
Or: []*armcostmanagement.QueryFilter{
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceLocation"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("East US"),
to.Ptr("West Europe"),
},
},
},
{
Tags: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("Environment"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("UAT"),
to.Ptr("Prod"),
},
},
},
},
},
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceGroup"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("API"),
},
},
},
},
},
Granularity: to.Ptr(armcostmanagement.GranularityTypeDaily),
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeMonthToDate),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("UsageDate"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// 20180331,
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// 20180331,
// "USD",
// },
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// 20180331,
// "USD",
// },
// []any{
// 0.16677720329728665,
// "gs-stms-dev",
// 20180331,
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
],
[
0.16677720329728665,
"gs-stms-dev",
20180331,
"USD"
]
]
}
}
CustomerQueryGrouping-MCA
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"granularity": "None",
"grouping": [
{
"name": "ResourceGroup",
"type": "Dimension"
}
]
},
"timeframe": "TheLastMonth"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/MCACustomerQueryGrouping.json
func ExampleQueryClient_Usage_customerQueryGroupingMca() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Aggregation: map[string]*armcostmanagement.QueryAggregation{
"totalCost": {
Name: to.Ptr("PreTaxCost"),
Function: to.Ptr(armcostmanagement.FunctionTypeSum),
},
},
Granularity: to.Ptr(armcostmanagement.GranularityType("None")),
Grouping: []*armcostmanagement.QueryGrouping{
{
Name: to.Ptr("ResourceGroup"),
Type: to.Ptr(armcostmanagement.QueryColumnTypeDimension),
},
},
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeTheLastMonth),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// "USD",
// },
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
"USD"
]
]
}
}
DepartmentQuery-Legacy
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
},
"granularity": "Daily"
},
"timeframe": "MonthToDate"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/DepartmentQuery.json
func ExampleQueryClient_Usage_departmentQueryLegacy() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Billing/billingAccounts/100/departments/123", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Filter: &armcostmanagement.QueryFilter{
And: []*armcostmanagement.QueryFilter{
{
Or: []*armcostmanagement.QueryFilter{
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceLocation"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("East US"),
to.Ptr("West Europe"),
},
},
},
{
Tags: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("Environment"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("UAT"),
to.Ptr("Prod"),
},
},
},
},
},
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceGroup"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("API"),
},
},
},
},
},
Granularity: to.Ptr(armcostmanagement.GranularityTypeDaily),
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeMonthToDate),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("UsageDate"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// 20180331,
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// 20180331,
// "USD",
// },
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// 20180331,
// "USD",
// },
// []any{
// 0.16677720329728665,
// "gs-stms-dev",
// 20180331,
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
],
[
0.16677720329728665,
"gs-stms-dev",
20180331,
"USD"
]
]
}
}
DepartmentQueryGrouping-Legacy
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"granularity": "None",
"grouping": [
{
"name": "ResourceGroup",
"type": "Dimension"
}
]
},
"timeframe": "TheLastMonth"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/DepartmentQueryGrouping.json
func ExampleQueryClient_Usage_departmentQueryGroupingLegacy() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Billing/billingAccounts/100/departments/123", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Aggregation: map[string]*armcostmanagement.QueryAggregation{
"totalCost": {
Name: to.Ptr("PreTaxCost"),
Function: to.Ptr(armcostmanagement.FunctionTypeSum),
},
},
Granularity: to.Ptr(armcostmanagement.GranularityType("None")),
Grouping: []*armcostmanagement.QueryGrouping{
{
Name: to.Ptr("ResourceGroup"),
Type: to.Ptr(armcostmanagement.QueryColumnTypeDimension),
},
},
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeTheLastMonth),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// "USD",
// },
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
"USD"
]
]
}
}
EnrollmentAccountQuery-Legacy
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
},
"granularity": "Daily"
},
"timeframe": "MonthToDate"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/EnrollmentAccountQuery.json
func ExampleQueryClient_Usage_enrollmentAccountQueryLegacy() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Filter: &armcostmanagement.QueryFilter{
And: []*armcostmanagement.QueryFilter{
{
Or: []*armcostmanagement.QueryFilter{
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceLocation"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("East US"),
to.Ptr("West Europe"),
},
},
},
{
Tags: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("Environment"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("UAT"),
to.Ptr("Prod"),
},
},
},
},
},
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceGroup"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("API"),
},
},
},
},
},
Granularity: to.Ptr(armcostmanagement.GranularityTypeDaily),
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeMonthToDate),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("UsageDate"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// 20180331,
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// 20180331,
// "USD",
// },
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// 20180331,
// "USD",
// },
// []any{
// 0.16677720329728665,
// "gs-stms-dev",
// 20180331,
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
],
[
0.16677720329728665,
"gs-stms-dev",
20180331,
"USD"
]
]
}
}
EnrollmentAccountQueryGrouping-Legacy
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"granularity": "Daily",
"grouping": [
{
"name": "ResourceGroup",
"type": "Dimension"
}
]
},
"timeframe": "TheLastMonth"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/EnrollmentAccountQueryGrouping.json
func ExampleQueryClient_Usage_enrollmentAccountQueryGroupingLegacy() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Aggregation: map[string]*armcostmanagement.QueryAggregation{
"totalCost": {
Name: to.Ptr("PreTaxCost"),
Function: to.Ptr(armcostmanagement.FunctionTypeSum),
},
},
Granularity: to.Ptr(armcostmanagement.GranularityTypeDaily),
Grouping: []*armcostmanagement.QueryGrouping{
{
Name: to.Ptr("ResourceGroup"),
Type: to.Ptr(armcostmanagement.QueryColumnTypeDimension),
},
},
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeTheLastMonth),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("UsageDate"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// 20180331,
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// 20180331,
// "USD",
// },
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// 20180331,
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
]
]
}
}
InvoiceSectionQuery-MCA
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
},
"granularity": "Daily"
},
"timeframe": "MonthToDate"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/MCAInvoiceSectionQuery.json
func ExampleQueryClient_Usage_invoiceSectionQueryMca() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Filter: &armcostmanagement.QueryFilter{
And: []*armcostmanagement.QueryFilter{
{
Or: []*armcostmanagement.QueryFilter{
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceLocation"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("East US"),
to.Ptr("West Europe"),
},
},
},
{
Tags: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("Environment"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("UAT"),
to.Ptr("Prod"),
},
},
},
},
},
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceGroup"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("API"),
},
},
},
},
},
Granularity: to.Ptr(armcostmanagement.GranularityTypeDaily),
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeMonthToDate),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("UsageDate"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// 20180331,
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// 20180331,
// "USD",
// },
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// 20180331,
// "USD",
// },
// []any{
// 0.16677720329728665,
// "gs-stms-dev",
// 20180331,
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
],
[
0.16677720329728665,
"gs-stms-dev",
20180331,
"USD"
]
]
}
}
InvoiceSectionQueryGrouping-MCA
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"granularity": "None",
"grouping": [
{
"name": "ResourceGroup",
"type": "Dimension"
}
]
},
"timeframe": "TheLastMonth"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/MCAInvoiceSectionQueryGrouping.json
func ExampleQueryClient_Usage_invoiceSectionQueryGroupingMca() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Aggregation: map[string]*armcostmanagement.QueryAggregation{
"totalCost": {
Name: to.Ptr("PreTaxCost"),
Function: to.Ptr(armcostmanagement.FunctionTypeSum),
},
},
Granularity: to.Ptr(armcostmanagement.GranularityType("None")),
Grouping: []*armcostmanagement.QueryGrouping{
{
Name: to.Ptr("ResourceGroup"),
Type: to.Ptr(armcostmanagement.QueryColumnTypeDimension),
},
},
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeTheLastMonth),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// "USD",
// },
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
"USD"
]
]
}
}
ManagementGroupQuery-Legacy
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
},
"granularity": "Daily"
},
"timeframe": "MonthToDate"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/ManagementGroupQuery.json
func ExampleQueryClient_Usage_managementGroupQueryLegacy() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Management/managementGroups/MyMgId", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Filter: &armcostmanagement.QueryFilter{
And: []*armcostmanagement.QueryFilter{
{
Or: []*armcostmanagement.QueryFilter{
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceLocation"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("East US"),
to.Ptr("West Europe"),
},
},
},
{
Tags: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("Environment"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("UAT"),
to.Ptr("Prod"),
},
},
},
},
},
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceGroup"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("API"),
},
},
},
},
},
Granularity: to.Ptr(armcostmanagement.GranularityTypeDaily),
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeMonthToDate),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("UsageDate"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// 20180331,
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// 20180331,
// "USD",
// },
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// 20180331,
// "USD",
// },
// []any{
// 0.16677720329728665,
// "gs-stms-dev",
// 20180331,
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
],
[
0.16677720329728665,
"gs-stms-dev",
20180331,
"USD"
]
]
}
}
ManagementGroupQueryGrouping-Legacy
Solicitud de ejemplo
POST https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"granularity": "None",
"grouping": [
{
"name": "ResourceGroup",
"type": "Dimension"
}
]
},
"timeframe": "TheLastMonth"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/ManagementGroupQueryGrouping.json
func ExampleQueryClient_Usage_managementGroupQueryGroupingLegacy() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "providers/Microsoft.Management/managementGroups/MyMgId", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Aggregation: map[string]*armcostmanagement.QueryAggregation{
"totalCost": {
Name: to.Ptr("PreTaxCost"),
Function: to.Ptr(armcostmanagement.FunctionTypeSum),
},
},
Granularity: to.Ptr(armcostmanagement.GranularityType("None")),
Grouping: []*armcostmanagement.QueryGrouping{
{
Name: to.Ptr("ResourceGroup"),
Type: to.Ptr(armcostmanagement.QueryColumnTypeDimension),
},
},
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeTheLastMonth),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("UsageDate"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// NextLink: to.Ptr("https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D"),
// Rows: [][]any{
// []any{
// 20.35941656262545,
// "VSTSHOL-1595322048000",
// 20180331,
// "USD",
// },
// []any{
// 173.41979241290323,
// "RVIIOT-TRIAL",
// 20180331,
// "USD",
// },
// []any{
// 19.545363672276512,
// "JapanUnifia-Trial",
// 20180331,
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"rows": [
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
]
]
}
}
ResourceGroupQuery-Legacy
Solicitud de ejemplo
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
},
"granularity": "Daily"
},
"timeframe": "MonthToDate"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/ResourceGroupQuery.json
func ExampleQueryClient_Usage_resourceGroupQueryLegacy() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Filter: &armcostmanagement.QueryFilter{
And: []*armcostmanagement.QueryFilter{
{
Or: []*armcostmanagement.QueryFilter{
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceLocation"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("East US"),
to.Ptr("West Europe"),
},
},
},
{
Tags: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("Environment"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("UAT"),
to.Ptr("Prod"),
},
},
},
},
},
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceGroup"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("API"),
},
},
},
},
},
Granularity: to.Ptr(armcostmanagement.GranularityTypeDaily),
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeMonthToDate),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("9af9459d-441d-4055-9ed0-83d4c4a363fb"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/subscriptions/55312978-ba1b-415c-9304-c4b9c43c0481/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("UsageDate"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// Rows: [][]any{
// []any{
// 2.10333307059661,
// "ScreenSharingTest-peer",
// 20180417,
// "USD",
// },
// []any{
// 20.10333307059661,
// "ScreenSharingTest-peer",
// 20180418,
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "9af9459d-441d-4055-9ed0-83d4c4a363fb",
"type": "microsoft.costmanagement/Query",
"id": "/subscriptions/55312978-ba1b-415c-9304-c4b9c43c0481/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": null,
"rows": [
[
2.10333307059661,
"ScreenSharingTest-peer",
20180417,
"USD"
],
[
20.10333307059661,
"ScreenSharingTest-peer",
20180418,
"USD"
]
]
}
}
ResourceGroupQueryGrouping-Legacy
Solicitud de ejemplo
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"granularity": "Daily",
"grouping": [
{
"name": "ResourceType",
"type": "Dimension"
}
]
},
"timeframe": "TheLastMonth"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/ResourceGroupQueryGrouping.json
func ExampleQueryClient_Usage_resourceGroupQueryGroupingLegacy() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Aggregation: map[string]*armcostmanagement.QueryAggregation{
"totalCost": {
Name: to.Ptr("PreTaxCost"),
Function: to.Ptr(armcostmanagement.FunctionTypeSum),
},
},
Granularity: to.Ptr(armcostmanagement.GranularityTypeDaily),
Grouping: []*armcostmanagement.QueryGrouping{
{
Name: to.Ptr("ResourceType"),
Type: to.Ptr(armcostmanagement.QueryColumnTypeDimension),
},
},
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeTheLastMonth),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("9af9459d-441d-4055-9ed0-83d4c4a363fb"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceType"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("UsageDate"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// Rows: [][]any{
// []any{
// 2.10333307059661,
// "Microsoft.SqlServer",
// 20180417,
// "USD",
// },
// []any{
// 20.10333307059661,
// "Microsoft.Compute",
// 20180418,
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "9af9459d-441d-4055-9ed0-83d4c4a363fb",
"type": "microsoft.costmanagement/Query",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceType",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": null,
"rows": [
[
2.10333307059661,
"Microsoft.SqlServer",
20180417,
"USD"
],
[
20.10333307059661,
"Microsoft.Compute",
20180418,
"USD"
]
]
}
}
SubscriptionQuery-Legacy
Solicitud de ejemplo
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
},
"granularity": "Daily"
},
"timeframe": "MonthToDate"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/SubscriptionQuery.json
func ExampleQueryClient_Usage_subscriptionQueryLegacy() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "subscriptions/00000000-0000-0000-0000-000000000000", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Filter: &armcostmanagement.QueryFilter{
And: []*armcostmanagement.QueryFilter{
{
Or: []*armcostmanagement.QueryFilter{
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceLocation"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("East US"),
to.Ptr("West Europe"),
},
},
},
{
Tags: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("Environment"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("UAT"),
to.Ptr("Prod"),
},
},
},
},
},
{
Dimensions: &armcostmanagement.QueryComparisonExpression{
Name: to.Ptr("ResourceGroup"),
Operator: to.Ptr(armcostmanagement.QueryOperatorTypeIn),
Values: []*string{
to.Ptr("API"),
},
},
},
},
},
Granularity: to.Ptr(armcostmanagement.GranularityTypeDaily),
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeMonthToDate),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("55312978-ba1b-415c-9304-cfd9c43c0481"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("UsageDate"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// Rows: [][]any{
// []any{
// 2.10333307059661,
// "ScreenSharingTest-peer",
// 20180331,
// "USD",
// },
// []any{
// 218.68795741935486,
// "Ict_StratAndPlan_GoldSprova_Prod",
// 20180331,
// "USD",
// },
// []any{
// 0.14384913581657052,
// "ssbciotelement01",
// 20180401,
// "USD",
// },
// []any{
// 0.009865586851323632,
// "ict_stratandplan_goldsprova_prod",
// 20180429,
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "55312978-ba1b-415c-9304-cfd9c43c0481",
"type": "microsoft.costmanagement/Query",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": null,
"rows": [
[
2.10333307059661,
"ScreenSharingTest-peer",
20180331,
"USD"
],
[
218.68795741935486,
"Ict_StratAndPlan_GoldSprova_Prod",
20180331,
"USD"
],
[
0.14384913581657052,
"ssbciotelement01",
20180401,
"USD"
],
[
0.009865586851323632,
"ict_stratandplan_goldsprova_prod",
20180429,
"USD"
]
]
}
}
SubscriptionQueryGrouping-Legacy
Solicitud de ejemplo
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/query?api-version=2025-03-01
{
"type": "Usage",
"dataset": {
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"granularity": "None",
"grouping": [
{
"name": "ResourceGroup",
"type": "Dimension"
}
]
},
"timeframe": "TheLastMonth"
}
package armcostmanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)
// Generated from example definition: 2025-03-01/SubscriptionQueryGrouping.json
func ExampleQueryClient_Usage_subscriptionQueryGroupingLegacy() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryClient().Usage(ctx, "subscriptions/00000000-0000-0000-0000-000000000000", armcostmanagement.QueryDefinition{
Type: to.Ptr(armcostmanagement.ExportTypeUsage),
Dataset: &armcostmanagement.QueryDataset{
Aggregation: map[string]*armcostmanagement.QueryAggregation{
"totalCost": {
Name: to.Ptr("PreTaxCost"),
Function: to.Ptr(armcostmanagement.FunctionTypeSum),
},
},
Granularity: to.Ptr(armcostmanagement.GranularityType("None")),
Grouping: []*armcostmanagement.QueryGrouping{
{
Name: to.Ptr("ResourceGroup"),
Type: to.Ptr(armcostmanagement.QueryColumnTypeDimension),
},
},
},
Timeframe: to.Ptr(armcostmanagement.TimeframeTypeTheLastMonth),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armcostmanagement.QueryClientUsageResponse{
// QueryResult: armcostmanagement.QueryResult{
// Name: to.Ptr("55312978-ba1b-415c-9304-cfd9c43c0481"),
// Type: to.Ptr("microsoft.costmanagement/Query"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000"),
// Properties: &armcostmanagement.QueryProperties{
// Columns: []*armcostmanagement.QueryColumn{
// {
// Name: to.Ptr("PreTaxCost"),
// Type: to.Ptr("Number"),
// },
// {
// Name: to.Ptr("ResourceGroup"),
// Type: to.Ptr("String"),
// },
// {
// Name: to.Ptr("Currency"),
// Type: to.Ptr("String"),
// },
// },
// Rows: [][]any{
// []any{
// 0.009865586851323632,
// "Ict_StratAndPlan_GoldSprova_Prod_0",
// "USD",
// },
// []any{
// 218.68795741935486,
// "Ict_StratAndPlan_GoldSprova_Prod_1",
// "USD",
// },
// []any{
// 2.10333307059661,
// "ScreenSharingTest-peer1",
// "USD",
// },
// []any{
// 0.14384913581657052,
// "Ssbciotelement01",
// "USD",
// },
// },
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Respuesta de muestra
{
"name": "55312978-ba1b-415c-9304-cfd9c43c0481",
"type": "microsoft.costmanagement/Query",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000",
"properties": {
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"nextLink": null,
"rows": [
[
0.009865586851323632,
"Ict_StratAndPlan_GoldSprova_Prod_0",
"USD"
],
[
218.68795741935486,
"Ict_StratAndPlan_GoldSprova_Prod_1",
"USD"
],
[
2.10333307059661,
"ScreenSharingTest-peer1",
"USD"
],
[
0.14384913581657052,
"Ssbciotelement01",
"USD"
]
]
}
}
Definiciones
| Nombre |
Description |
|
ErrorDetails
|
Detalles del error.
|
|
ErrorResponse
|
La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error. \n\nAlgunas respuestas a errores: \n\n * 429 TooManyRequests - La solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after". \n\n * 503 ServiceNo disponible - El servicio está temporalmente no disponible. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Retry-After".
|
|
ExportType
|
Tipo de la exportación. Tenga en cuenta que "Uso" es equivalente a "ActualCost" y es aplicable a las exportaciones que aún no proporcionan datos de cargos o amortización para las reservas de servicio.
|
|
FunctionType
|
Nombre de la función de agregación que se va a usar.
|
|
GranularityType
|
Granularidad de las filas de la exportación. Actualmente se admite "Daily" para la mayoría de los casos.
|
|
QueryAggregation
|
Expresión de agregación que se va a usar en la consulta.
|
|
QueryColumn
|
Propiedades queryColumn
|
|
QueryColumnType
|
El tipo de columna en el informe.
|
|
QueryComparisonExpression
|
Expresión de comparación que se va a usar en la consulta.
|
|
QueryDataset
|
Definición de los datos presentes en la consulta.
|
|
QueryDatasetConfiguration
|
Configuración del conjunto de datos en la consulta.
|
|
QueryDefinition
|
Definición de una consulta.
|
|
QueryFilter
|
Expresión de filtro que se va a usar en la exportación.
|
|
QueryGrouping
|
Grupo por expresión que se va a usar en la consulta.
|
|
QueryOperatorType
|
Operador que se va a usar para la comparación.
|
|
QueryResult
|
Resultado de la consulta. Contiene todas las columnas enumeradas en agrupaciones y agregaciones.
|
|
QueryTimePeriod
|
Fecha de inicio y finalización para extraer datos de la consulta.
|
|
TimeframeType
|
Período de tiempo para extraer datos para la exportación. Si es personalizado, se debe proporcionar un período de tiempo específico.
|
ErrorDetails
Objeto
Detalles del error.
| Nombre |
Tipo |
Description |
|
code
|
string
|
Código de error.
|
|
message
|
string
|
Mensaje de error que indica por qué se produjo un error en la operación.
|
ErrorResponse
Objeto
La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error. \n\nAlgunas respuestas a errores: \n\n * 429 TooManyRequests - La solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after". \n\n * 503 ServiceNo disponible - El servicio está temporalmente no disponible. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Retry-After".
| Nombre |
Tipo |
Description |
|
error
|
ErrorDetails
|
Detalles del error.
|
ExportType
Enumeración
Tipo de la exportación. Tenga en cuenta que "Uso" es equivalente a "ActualCost" y es aplicable a las exportaciones que aún no proporcionan datos de cargos o amortización para las reservas de servicio.
| Valor |
Description |
|
Usage
|
|
|
ActualCost
|
|
|
AmortizedCost
|
|
|
FocusCost
|
|
|
PriceSheet
|
|
|
ReservationTransactions
|
|
|
ReservationRecommendations
|
|
|
ReservationDetails
|
|
FunctionType
Enumeración
Nombre de la función de agregación que se va a usar.
GranularityType
Enumeración
Granularidad de las filas de la exportación. Actualmente se admite "Daily" para la mayoría de los casos.
| Valor |
Description |
|
Daily
|
|
|
Monthly
|
|
QueryAggregation
Objeto
Expresión de agregación que se va a usar en la consulta.
| Nombre |
Tipo |
Description |
|
function
|
FunctionType
|
Nombre de la función de agregación que se va a usar.
|
|
name
|
string
|
Nombre de la columna que se va a agregar.
|
QueryColumn
Objeto
Propiedades queryColumn
| Nombre |
Tipo |
Description |
|
name
|
string
|
Nombre de la columna.
|
|
type
|
string
|
Tipo de columna.
|
QueryColumnType
Enumeración
El tipo de columna en el informe.
| Valor |
Description |
|
TagKey
|
Etiqueta asociada a los datos de costo.
|
|
Dimension
|
Dimensión de los datos de costo.
|
QueryComparisonExpression
Objeto
Expresión de comparación que se va a usar en la consulta.
| Nombre |
Tipo |
Description |
|
name
|
string
|
Nombre de la columna que se va a usar en comparación.
|
|
operator
|
QueryOperatorType
|
Operador que se va a usar para la comparación.
|
|
values
|
string[]
|
Matriz de valores que se van a usar para la comparación
|
QueryDataset
Objeto
Definición de los datos presentes en la consulta.
| Nombre |
Tipo |
Description |
|
aggregation
|
<string,
QueryAggregation>
|
Diccionario de expresiones de agregación que se van a usar en la consulta. La clave de cada elemento del diccionario es el alias de la columna agregada. La consulta puede tener hasta 2 cláusulas de agregación.
|
|
configuration
|
QueryDatasetConfiguration
|
Tiene información de configuración para los datos de la exportación. La configuración se omitirá si se proporcionan la agregación y la agrupación.
|
|
filter
|
QueryFilter
|
Expresión de filtro que se va a utilizar en la consulta. Consulte nuestra documentación de REST de la API de consulta para saber cómo formatear correctamente el filtro.
|
|
granularity
|
GranularityType
|
Granularidad de las filas de la consulta.
|
|
grouping
|
QueryGrouping[]
|
Matriz de agrupación por expresión que se va a usar en la consulta. La consulta puede tener hasta 2 cláusulas group by.
|
QueryDatasetConfiguration
Objeto
Configuración del conjunto de datos en la consulta.
| Nombre |
Tipo |
Description |
|
columns
|
string[]
|
Matriz de nombres de columna que se van a incluir en la consulta. Se permite cualquier nombre de columna de consulta válido. Si no se proporciona, la consulta incluye todas las columnas.
|
QueryDefinition
Objeto
Definición de una consulta.
| Nombre |
Tipo |
Description |
|
dataset
|
QueryDataset
|
Tiene una definición para los datos de esta consulta.
|
|
timePeriod
|
QueryTimePeriod
|
Tiene un período de tiempo para extraer datos de la consulta.
|
|
timeframe
|
TimeframeType
|
Período de tiempo para extraer datos de la consulta. Si es personalizado, se debe proporcionar un período de tiempo específico.
|
|
type
|
ExportType
|
Tipo de la consulta.
|
QueryFilter
Objeto
Expresión de filtro que se va a usar en la exportación.
QueryGrouping
Objeto
Grupo por expresión que se va a usar en la consulta.
| Nombre |
Tipo |
Description |
|
name
|
string
|
Nombre de la columna que se va a agrupar.
|
|
type
|
QueryColumnType
|
Tiene el tipo de columna que se va a agrupar.
|
QueryOperatorType
Enumeración
Operador que se va a usar para la comparación.
QueryResult
Objeto
Resultado de la consulta. Contiene todas las columnas enumeradas en agrupaciones y agregaciones.
| Nombre |
Tipo |
Description |
|
eTag
|
string
|
ETag del recurso.
|
|
id
|
string
|
Identificador de recurso.
|
|
location
|
string
|
Ubicación del recurso.
|
|
name
|
string
|
Nombre del recurso.
|
|
properties.columns
|
QueryColumn[]
|
Matriz de columnas
|
|
properties.nextLink
|
string
|
Vínculo (url) a la página siguiente de resultados.
|
|
properties.rows
|
Rows[]
|
Matriz de filas
|
|
sku
|
string
|
SKU del recurso.
|
|
tags
|
object
|
Etiquetas de recursos.
|
|
type
|
string
|
Tipo de recurso.
|
QueryTimePeriod
Objeto
Fecha de inicio y finalización para extraer datos de la consulta.
| Nombre |
Tipo |
Description |
|
from
|
string
(date-time)
|
Fecha de inicio de la que se van a extraer datos.
|
|
to
|
string
(date-time)
|
Fecha de finalización a la que se van a extraer los datos.
|
TimeframeType
Enumeración
Período de tiempo para extraer datos para la exportación. Si es personalizado, se debe proporcionar un período de tiempo específico.
| Valor |
Description |
|
MonthToDate
|
|
|
BillingMonthToDate
|
|
|
TheLastMonth
|
|
|
TheLastBillingMonth
|
|
|
WeekToDate
|
|
|
Custom
|
|
|
TheCurrentMonth
|
|