Query - Usage By External Cloud Provider Type

Referência

Service:: Cost Management

API Version:: 2023-11-01

Consulte os dados de uso para o tipo de provedor de nuvem externo definido.

POST https://management.azure.com/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/query?api-version=2023-11-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
externalCloudProviderId	path	True	string	Isso pode ser '{externalSubscriptionId}' para a conta vinculada ou '{externalBillingAccountId}' para a conta consolidada usada com operações de dimensão/consulta.
externalCloudProviderType	path	True	externalCloudProviderType	O tipo de provedor de nuvem externo associado a operações de dimensão/consulta. Isso inclui 'externalSubscriptions' para a conta vinculada e 'externalBillingAccounts' para a conta consolidada.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
dataset	True	QueryDataset	Tem definição para dados nesta consulta.
timeframe	True	TimeframeType	O período para efetuar pull de dados para a consulta. Se personalizado, um período de tempo específico deve ser fornecido.
type	True	ExportType	O tipo da consulta.
timePeriod		QueryTimePeriod	Tem um período de tempo para efetuar pull de dados para a consulta.

Respostas

Nome	Tipo	Description
200 OK	QueryResult	OK. A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ExternalBillingAccountQueryList

ExternalSubscriptionsQuery

ExternalBillingAccountQueryList

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.CostManagement/externalBillingAccounts/100/query?api-version=2023-11-01

{
  "type": "Usage",
  "timeframe": "MonthToDate",
  "dataset": {
    "granularity": "Daily",
    "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"
            ]
          }
        }
      ]
    }
  }
}

Sample Response

Status code:: 200

{
  "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d",
  "name": "6dc7b06a-d90a-4df5-b655-ce6cf1c0814d",
  "type": "Microsoft.CostManagement/query",
  "properties": {
    "nextLink": null,
    "columns": [
      {
        "name": "PreTaxCost",
        "type": "Number"
      },
      {
        "name": "ServiceName",
        "type": "String"
      },
      {
        "name": "Currency",
        "type": "String"
      }
    ],
    "rows": [
      [
        0,
        "abc db",
        "USD"
      ],
      [
        30.2572751438,
        "abc compute cloud",
        "USD"
      ],
      [
        0.07675760200000002,
        "abc file system",
        "USD"
      ],
      [
        50.43096419040001,
        "abc elasticache",
        "USD"
      ]
    ]
  }
}

ExternalSubscriptionsQuery

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.CostManagement/externalSubscriptions/100/query?api-version=2023-11-01

{
  "type": "Usage",
  "timeframe": "MonthToDate",
  "dataset": {
    "granularity": "Daily",
    "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"
            ]
          }
        }
      ]
    }
  }
}

Sample Response

Status code:: 200

{
  "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d",
  "name": "d99477af-7510-40ee-aca2-e59bdca0d10d",
  "type": "Microsoft.CostManagement/query",
  "properties": {
    "nextLink": null,
    "columns": [
      {
        "name": "PreTaxCost",
        "type": "Number"
      },
      {
        "name": "UsageDate",
        "type": "Number"
      },
      {
        "name": "Currency",
        "type": "String"
      }
    ],
    "rows": []
  }
}

Definições

Nome	Description
ErrorDetails	Os detalhes do erro.
ErrorResponse	A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro. Algumas respostas de erro: 429 TooManyRequests - A solicitação é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable - O serviço está temporariamente indisponível. Repita depois de aguardar o tempo especificado no cabeçalho "Retry-After".
ExportType	O tipo da consulta.
externalCloudProviderType	O tipo de provedor de nuvem externo associado a operações de dimensão/consulta. Isso inclui 'externalSubscriptions' para a conta vinculada e 'externalBillingAccounts' para a conta consolidada.
FunctionType	O nome da função de agregação a ser usada.
GranularityType	A granularidade das linhas na previsão.
QueryAggregation	A expressão de agregação a ser usada na consulta.
QueryColumn	Propriedades de QueryColumn
QueryColumnType	O tipo da coluna na exportação.
QueryComparisonExpression	A expressão de comparação a ser usada na consulta.
QueryDataset	A definição de dados presentes na consulta.
QueryDatasetConfiguration	A configuração do conjunto de dados na consulta.
QueryDefinition	A definição de uma consulta.
QueryFilter	A expressão de filtro a ser usada na exportação.
QueryGrouping	A expressão group by a ser usada na consulta.
QueryOperatorType	O operador a ser usado para comparação.
QueryResult	Resultado da consulta. Ele contém todas as colunas listadas em agrupamentos e agregação.
QueryTimePeriod	A data de início e término para efetuar pull de dados para a consulta.
TimeframeType	O período para efetuar pull de dados para a consulta. Se personalizado, um período de tempo específico deve ser fornecido.

ErrorDetails

Os detalhes do erro.

Nome	Tipo	Description
code	string	Código do erro.
message	string	Mensagem de erro indicando por que a operação falhou.

ErrorResponse

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Algumas respostas de erro:

429 TooManyRequests - A solicitação é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable - O serviço está temporariamente indisponível. Repita depois de aguardar o tempo especificado no cabeçalho "Retry-After".

Nome	Tipo	Description
error	ErrorDetails	Os detalhes do erro.

ExportType

O tipo da consulta.

Nome	Tipo	Description
ActualCost	string
AmortizedCost	string
Usage	string

externalCloudProviderType

O tipo de provedor de nuvem externo associado a operações de dimensão/consulta. Isso inclui 'externalSubscriptions' para a conta vinculada e 'externalBillingAccounts' para a conta consolidada.

Nome	Tipo	Description
externalBillingAccounts	string
externalSubscriptions	string

FunctionType

O nome da função de agregação a ser usada.

Nome	Tipo	Description
Sum	string

GranularityType

A granularidade das linhas na previsão.

Nome	Tipo	Description
Daily	string

QueryAggregation

A expressão de agregação a ser usada na consulta.

Nome	Tipo	Description
function	FunctionType	O nome da função de agregação a ser usada.
name	string	O nome da coluna a ser agregada.

QueryColumn

Propriedades de QueryColumn

Nome	Tipo	Description
name	string	O nome da coluna.
type	string	O tipo de coluna.

QueryColumnType

O tipo da coluna na exportação.

Nome	Tipo	Description
Dimension	string	A dimensão dos dados de custo.
TagKey	string	A marca associada aos dados de custo.

QueryComparisonExpression

A expressão de comparação a ser usada na consulta.

Nome	Tipo	Description
name	string	O nome da coluna a ser usada em comparação.
operator	QueryOperatorType	O operador a ser usado para comparação.
values	string[]	Matriz de valores a serem usados para comparação

QueryDataset

A definição de dados presentes na consulta.

Nome	Tipo	Description
aggregation	<string, QueryAggregation>	Dicionário de expressão de agregação a ser usado na consulta. A chave de cada item no dicionário é o alias da coluna agregada. A consulta pode ter até duas cláusulas de agregação.
configuration	QueryDatasetConfiguration	Tem informações de configuração para os dados na exportação. A configuração será ignorada se a agregação e o agrupamento forem fornecidos.
filter	QueryFilter	A expressão de filtro a ser usada na consulta. Consulte nossa documentação REST da API de Consulta para saber como formatar corretamente o filtro.
granularity	GranularityType	A granularidade de linhas na consulta.
grouping	QueryGrouping[]	Matriz de grupo por expressão a ser usada na consulta. A consulta pode ter até 2 cláusulas group by.

QueryDatasetConfiguration

A configuração do conjunto de dados na consulta.

Nome	Tipo	Description
columns	string[]	Matriz de nomes de coluna a serem incluídos na consulta. Qualquer nome de coluna de consulta válido é permitido. Se não for fornecido, a consulta incluirá todas as colunas.

QueryDefinition

A definição de uma consulta.

Nome	Tipo	Description
dataset	QueryDataset	Tem definição para dados nesta consulta.
timePeriod	QueryTimePeriod	Tem um período de tempo para efetuar pull de dados para a consulta.
timeframe	TimeframeType	O período para efetuar pull de dados para a consulta. Se personalizado, um período de tempo específico deve ser fornecido.
type	ExportType	O tipo da consulta.

QueryFilter

A expressão de filtro a ser usada na exportação.

Nome	Tipo	Description
and	QueryFilter[]	A expressão lógica "AND". Deve ter pelo menos 2 itens.
dimensions	QueryComparisonExpression	Tem expressão de comparação para uma dimensão
or	QueryFilter[]	A expressão lógica "OR". Deve ter pelo menos 2 itens.
tags	QueryComparisonExpression	Tem expressão de comparação para uma marca

QueryGrouping

A expressão group by a ser usada na consulta.

Nome	Tipo	Description
name	string	O nome da coluna a ser agrupada.
type	QueryColumnType	Tem o tipo da coluna a ser agrupada.

QueryOperatorType

O operador a ser usado para comparação.

Nome	Tipo	Description
In	string

QueryResult

Resultado da consulta. Ele contém todas as colunas listadas em agrupamentos e agregação.

Nome	Tipo	Description
eTag	string	ETag do recurso.
id	string	ID do recurso.
location	string	Local do recurso.
name	string	Nome do recurso.
properties.columns	QueryColumn[]	Matriz de colunas
properties.nextLink	string	O link (URL) para a próxima página de resultados.
properties.rows	Rows[]	Matriz de linhas
sku	string	SKU do recurso.
tags	object	Marcas de recurso.
type	string	Tipo de recurso.

QueryTimePeriod

A data de início e término para efetuar pull de dados para a consulta.

Nome	Tipo	Description
from	string	A data de início da qual extrair dados.
to	string	A data de término para a qual efetuar pull de dados.

TimeframeType

O período para efetuar pull de dados para a consulta. Se personalizado, um período de tempo específico deve ser fornecido.

Nome	Tipo	Description
BillingMonthToDate	string
Custom	string
MonthToDate	string
TheLastBillingMonth	string
TheLastMonth	string
WeekToDate	string

Share via

Query - Usage By External Cloud Provider Type

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Scopes

Exemplos

ExternalBillingAccountQueryList

Sample Request

Sample Response

ExternalSubscriptionsQuery

Sample Request

Sample Response

Definições

ErrorDetails

ErrorResponse

ExportType

externalCloudProviderType

FunctionType

GranularityType

QueryAggregation

QueryColumn

QueryColumnType

QueryComparisonExpression

QueryDataset

QueryDatasetConfiguration

QueryDefinition

QueryFilter

QueryGrouping

QueryOperatorType

QueryResult

QueryTimePeriod

TimeframeType

Recursos adicionais