Query Billing Account - Query Billing Account

Serviço:: Cost Management

Versão da API:: 2018-05-31

Lista os dados de uso da conta de cobrança.

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/Query?api-version=2018-05-31

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
billingAccountId	path	True	string	ID da conta de cobrança
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente. A versão atual é 2018-05-31.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
timeframe	True	TimeframeType	O período para efetuar pull de dados para o relatório. Se personalizado, um período de tempo específico deve ser fornecido.
type	True	ReportType	O tipo do relatório.
dataset		ReportConfigDataset	Tem definição de dados nesta configuração de relatório.
timePeriod		ReportConfigTimePeriod	Tem um período de tempo para efetuar pull de dados para o relatório.

Respostas

Nome	Tipo	Description
200 OK	QueryResult	OKEY. 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.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

BillingAccountQuery

Solicitação de exemplo

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2018-05-31

{
  "type": "Usage",
  "timeframe": "MonthToDate",
  "dataset": {
    "granularity": "Daily",
    "configuration": {
      "columns": [
        "PreTaxCost",
        "ResourceGroup",
        "UsageDate"
      ]
    },
    "filter": {
      "and": [
        {
          "or": [
            {
              "dimension": {
                "name": "ResourceLocation",
                "operator": "In",
                "values": [
                  "East US",
                  "West Europe"
                ]
              }
            },
            {
              "tag": {
                "name": "Environment",
                "operator": "In",
                "values": [
                  "UAT",
                  "Prod"
                ]
              }
            }
          ]
        },
        {
          "dimension": {
            "name": "ResourceGroup",
            "operator": "In",
            "values": [
              "API"
            ]
          }
        }
      ]
    }
  }
}

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
      "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
      "type": "microsoft.costmanagement/Query",
      "properties": {
        "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2018-05-31&$skiptoken=AQAAAA%3D%3D",
        "columns": [
          {
            "name": "PreTaxCost",
            "type": "Number"
          },
          {
            "name": "ResourceGroup",
            "type": "String"
          },
          {
            "name": "UsageDate",
            "type": "Number"
          }
        ],
        "rows": [
          [
            19.545363672276512,
            "JapanUnifia-Trial",
            20180331
          ],
          [
            173.41979241290323,
            "RVIIOT-TRIAL",
            20180331
          ],
          [
            20.35941656262545,
            "VSTSHOL-1595322048000",
            20180331
          ],
          [
            0.16677720329728665,
            "gs-stms-dev",
            20180331
          ]
        ]
      }
    }
  ]
}

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.
FunctionType	O nome da função de agregação a ser usada.
GranularityType	A granularidade das linhas no relatório.
OperatorType	O operador a ser usado para comparação.
Query
QueryColumn
QueryResult	Resultado da consulta. Ele contém todas as colunas listadas em agrupamentos e agregação.
ReportConfigAggregation	A expressão de agregação a ser usada no relatório.
ReportConfigColumnType	O tipo da coluna no relatório.
ReportConfigComparisonExpression	A expressão de comparação a ser usada no relatório.
ReportConfigDataset	A definição de dados presentes no relatório.
ReportConfigDatasetConfiguration	A configuração do conjunto de dados no relatório.
ReportConfigDefinition	A definição de uma configuração de relatório.
ReportConfigFilter	A expressão de filtro a ser usada no relatório.
ReportConfigGrouping	O grupo por expressão a ser usado no relatório.
ReportConfigTimePeriod	A data de início e término para efetuar pull de dados para o relatório.
ReportType	O tipo do relatório.
TimeframeType	O período para efetuar pull de dados para o relatório. Se personalizado, um período de tempo específico deve ser fornecido.

ErrorDetails

Objeto

Os detalhes do erro.

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

ErrorResponse

Objeto

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.

Nome	Tipo	Description
error	ErrorDetails	Os detalhes do erro.

FunctionType

Enumeração

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

Valor	Description
Sum

GranularityType

Enumeração

A granularidade das linhas no relatório.

Valor	Description
Daily

OperatorType

Enumeração

O operador a ser usado para comparação.

Valor	Description
In

Query

Objeto

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.columns	QueryColumn[]	Matriz de colunas
properties.nextLink	string
properties.rows	Rows[]
tags	object	Marcas de recurso.
type	string	Tipo de recurso.

QueryColumn

Objeto

Nome	Tipo	Description
name	string
type	string

QueryResult

Objeto

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

Nome	Tipo	Description
value	Query[]	A lista de dados de uso.

ReportConfigAggregation

Objeto

A expressão de agregação a ser usada no relatório.

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.

ReportConfigColumnType

Enumeração

O tipo da coluna no relatório.

Valor	Description
Tag
Dimension

ReportConfigComparisonExpression

Objeto

A expressão de comparação a ser usada no relatório.

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

ReportConfigDataset

Objeto

A definição de dados presentes no relatório.

Nome	Tipo	Description
aggregation	<string, ReportConfigAggregation>	Dicionário de expressão de agregação a ser usado no relatório. A chave de cada item no dicionário é o alias da coluna agregada. O relatório pode ter até 2 cláusulas de agregação.
configuration	ReportConfigDatasetConfiguration	Tem informações de configuração para os dados no relatório. A configuração será ignorada se a agregação e o agrupamento forem fornecidos.
filter	ReportConfigFilter	Tem expressão de filtro a ser usada no relatório.
granularity	GranularityType	A granularidade das linhas no relatório.
grouping	ReportConfigGrouping[]	Matriz de grupo por expressão a ser usada no relatório. O relatório pode ter até 2 cláusulas de grupo por.

ReportConfigDatasetConfiguration

Objeto

A configuração do conjunto de dados no relatório.

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

ReportConfigDefinition

Objeto

A definição de uma configuração de relatório.

Nome	Tipo	Description
dataset	ReportConfigDataset	Tem definição de dados nesta configuração de relatório.
timePeriod	ReportConfigTimePeriod	Tem um período de tempo para efetuar pull de dados para o relatório.
timeframe	TimeframeType	O período para efetuar pull de dados para o relatório. Se personalizado, um período de tempo específico deve ser fornecido.
type	ReportType	O tipo do relatório.

ReportConfigFilter

Objeto

A expressão de filtro a ser usada no relatório.

Nome	Tipo	Description
and	ReportConfigFilter[]	A expressão lógica "AND". Deve ter pelo menos 2 itens.
dimension	ReportConfigComparisonExpression	Tem expressão de comparação para uma dimensão
not	ReportConfigFilter	A expressão lógica "NOT".
or	ReportConfigFilter[]	A expressão lógica "OR". Deve ter pelo menos 2 itens.
tag	ReportConfigComparisonExpression	Tem expressão de comparação para uma marca

ReportConfigGrouping

Objeto

O grupo por expressão a ser usado no relatório.

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

ReportConfigTimePeriod

Objeto

A data de início e término para efetuar pull de dados para o relatório.

Nome	Tipo	Description
from	string (date-time)	A data de início da qual os dados serão extraídos.
to	string (date-time)	A data de término para a qual efetuar pull de dados.

ReportType

Enumeração

O tipo do relatório.

Valor	Description
Usage

TimeframeType

Enumeração

O período para efetuar pull de dados para o relatório. Se personalizado, um período de tempo específico deve ser fornecido.

Valor	Description
WeekToDate
MonthToDate
YearToDate
Custom

Compartilhar via

Query Billing Account - Query Billing Account

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

BillingAccountQuery

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorDetails

ErrorResponse

FunctionType

GranularityType

OperatorType

Query

QueryColumn

QueryResult

ReportConfigAggregation

ReportConfigColumnType

ReportConfigComparisonExpression

ReportConfigDataset

ReportConfigDatasetConfiguration

ReportConfigDefinition

ReportConfigFilter

ReportConfigGrouping

ReportConfigTimePeriod

ReportType

TimeframeType