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 do URI

Name	Em	Necessário	Tipo	Description
billingAccountId	path	True	string	FaturaçãoID da conta
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 do Pedido

Name	Necessário	Tipo	Description
timeframe	True	TimeframeType	O período de tempo para extrair dados para o relatório. Se for habitual, deve ser fornecido um período de tempo específico.
type	True	ReportType	O tipo de relatório.
dataset		ReportConfigDataset	Tem definição para dados nesta configuração de relatório.
timePeriod		ReportConfigTimePeriod	Tem período de tempo para extrair dados para o relatório.

Respostas

Name	Tipo	Description
200 OK	QueryResult	OK. O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

BillingAccountQuery

Pedido de amostra

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 da amostra

Código de estado:: 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

Name	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 utilizar 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 de coluna no relatório.
ReportConfigComparisonExpression	A expressão de comparação a utilizar no relatório.
ReportConfigDataset	A definição dos 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	As datas de início e término para extrair dados para o relatório.
ReportType	O tipo de relatório.
TimeframeType	O período de tempo para extrair dados para o relatório. Se for habitual, deve ser fornecido um período de tempo específico.

ErrorDetails

Object

Os detalhes do erro.

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

ErrorResponse

Object

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.

Name	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 utilizar para comparação.

Valor	Description
In

Query

Object

Name	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	Tags de recursos.
type	string	Tipo de recurso.

QueryColumn

Object

Name	Tipo	Description
name	string
type	string

QueryResult

Object

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

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

ReportConfigAggregation

Object

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

Name	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 de coluna no relatório.

Valor	Description
Tag
Dimension

ReportConfigComparisonExpression

Object

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

Name	Tipo	Description
name	string	O nome da coluna a ser usada na comparação.
operator	OperatorType	O operador a utilizar para comparação.
values	string[]	Matriz de valores a ser usada para comparação

ReportConfigDataset

Object

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

Name	Tipo	Description
aggregation	<string, ReportConfigAggregation>	Dicionário de expressão de agregação a utilizar no relatório. A chave de cada item no dicionário é o alias para a 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 para usar 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. Relatório pode ter até 2 grupos por cláusulas.

ReportConfigDatasetConfiguration

Object

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

Name	Tipo	Description
columns	string[]	Matriz de nomes de colunas 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 incluirá todas as colunas.

ReportConfigDefinition

Object

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

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

ReportConfigFilter

Object

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

Name	Tipo	Description
and	ReportConfigFilter[]	A expressão lógica "E". 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 "NÃO".
or	ReportConfigFilter[]	A expressão lógica "OR". Deve ter pelo menos 2 itens.
tag	ReportConfigComparisonExpression	Tem expressão de comparação para uma tag

ReportConfigGrouping

Object

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

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

ReportConfigTimePeriod

Object

As datas de início e término para extrair dados para o relatório.

Name	Tipo	Description
from	string (date-time)	A data de início a partir da qual extrair dados.
to	string (date-time)	A data final para a qual extrair dados.

ReportType

Enumeração

O tipo de relatório.

Valor	Description
Usage

TimeframeType

Enumeração

O período de tempo para extrair dados para o relatório. Se for habitual, deve ser fornecido um período de tempo específico.

Valor	Description
WeekToDate
MonthToDate
YearToDate
Custom

Partilhar via

Query Billing Account - Query Billing Account

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

BillingAccountQuery

Pedido de amostra

Resposta da amostra

Definições

ErrorDetails

ErrorResponse

FunctionType

GranularityType

OperatorType

Query

QueryColumn

QueryResult

ReportConfigAggregation

ReportConfigColumnType

ReportConfigComparisonExpression

ReportConfigDataset

ReportConfigDatasetConfiguration

ReportConfigDefinition

ReportConfigFilter

ReportConfigGrouping

ReportConfigTimePeriod

ReportType

TimeframeType