Query Billing Account - Query Billing Account

Servizio:: Cost Management

Versione API:: 2018-05-31

Elenca i dati di utilizzo per l'account di fatturazione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
billingAccountId	path	True	string	ID account di fatturazione
api-version	query	True	string	Versione dell'API da usare con la richiesta client. La versione corrente è 2018-05-31.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
timeframe	True	TimeframeType	Intervallo di tempo per il pull dei dati per il report. Se personalizzato, è necessario specificare un periodo di tempo specifico.
type	True	ReportType	Tipo del report.
dataset		ReportConfigDataset	Ha una definizione per i dati in questa configurazione del report.
timePeriod		ReportConfigTimePeriod	Periodo di tempo per il pull dei dati per il report.

Risposte

Nome	Tipo	Descrizione
200 OK	QueryResult	OK. La richiesta ha avuto esito positivo.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

BillingAccountQuery

Esempio di richiesta

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"
            ]
          }
        }
      ]
    }
  }
}

Risposta di esempio

Codice di stato:: 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
          ]
        ]
      }
    }
  ]
}

Definizioni

Nome	Descrizione
ErrorDetails	Dettagli dell'errore.
ErrorResponse	La risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.
FunctionType	Nome della funzione di aggregazione da usare.
GranularityType	Granularità delle righe nel report.
OperatorType	Operatore da utilizzare per il confronto.
Query
QueryColumn
QueryResult	Risultato della query. Contiene tutte le colonne elencate in raggruppamenti e aggregazioni.
ReportConfigAggregation	Espressione di aggregazione da utilizzare nel report.
ReportConfigColumnType	Tipo della colonna nel report.
ReportConfigComparisonExpression	Espressione di confronto da utilizzare nel report.
ReportConfigDataset	Definizione dei dati presenti nel report.
ReportConfigDatasetConfiguration	Configurazione del set di dati nel report.
ReportConfigDefinition	Definizione di una configurazione del report.
ReportConfigFilter	Espressione di filtro da utilizzare nel report.
ReportConfigGrouping	Gruppo per espressione da utilizzare nel report.
ReportConfigTimePeriod	Data di inizio e fine per il pull dei dati per il report.
ReportType	Tipo del report.
TimeframeType	Intervallo di tempo per il pull dei dati per il report. Se personalizzato, è necessario specificare un periodo di tempo specifico.

ErrorDetails

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

ErrorResponse

Object

La risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli dell'errore.

FunctionType

Enumerazione

Nome della funzione di aggregazione da usare.

Valore	Descrizione
Sum

GranularityType

Enumerazione

Granularità delle righe nel report.

Valore	Descrizione
Daily

OperatorType

Enumerazione

Operatore da utilizzare per il confronto.

Valore	Descrizione
In

Query

Object

Nome	Tipo	Descrizione
id	string	ID risorsa.
name	string	Nome risorsa.
properties.columns	QueryColumn[]	Matrice di colonne
properties.nextLink	string
properties.rows	Rows[]
tags	object	Tag di risorsa.
type	string	Tipo di risorsa.

QueryColumn

Object

Nome	Tipo	Descrizione
name	string
type	string

QueryResult

Object

Risultato della query. Contiene tutte le colonne elencate in raggruppamenti e aggregazioni.

Nome	Tipo	Descrizione
value	Query[]	Elenco dei dati di utilizzo.

ReportConfigAggregation

Object

Espressione di aggregazione da utilizzare nel report.

Nome	Tipo	Descrizione
function	FunctionType	Nome della funzione di aggregazione da usare.
name	string	Nome della colonna da aggregare.

ReportConfigColumnType

Enumerazione

Tipo della colonna nel report.

Valore	Descrizione
Tag
Dimension

ReportConfigComparisonExpression

Object

Espressione di confronto da utilizzare nel report.

Nome	Tipo	Descrizione
name	string	Nome della colonna da utilizzare in confronto.
operator	OperatorType	Operatore da utilizzare per il confronto.
values	string[]	Matrice di valori da usare per il confronto

ReportConfigDataset

Object

Definizione dei dati presenti nel report.

Nome	Tipo	Descrizione
aggregation	<string, ReportConfigAggregation>	Dizionario dell'espressione di aggregazione da usare nel report. La chiave di ogni elemento nel dizionario è l'alias per la colonna aggregata. Il report può avere fino a 2 clausole di aggregazione.
configuration	ReportConfigDatasetConfiguration	Contiene informazioni di configurazione per i dati nel report. La configurazione verrà ignorata se vengono fornite aggregazioni e raggruppamento.
filter	ReportConfigFilter	Dispone dell'espressione di filtro da utilizzare nel report.
granularity	GranularityType	Granularità delle righe nel report.
grouping	ReportConfigGrouping[]	Matrice di raggruppamento per espressione da usare nel report. Il report può avere fino a 2 clausole group by.

ReportConfigDatasetConfiguration

Object

Configurazione del set di dati nel report.

Nome	Tipo	Descrizione
columns	string[]	Matrice di nomi di colonna da includere nel report. È consentito qualsiasi nome di colonna del report valido. Se non specificato, il report include tutte le colonne.

ReportConfigDefinition

Object

Definizione di una configurazione del report.

Nome	Tipo	Descrizione
dataset	ReportConfigDataset	Ha una definizione per i dati in questa configurazione del report.
timePeriod	ReportConfigTimePeriod	Periodo di tempo per il pull dei dati per il report.
timeframe	TimeframeType	Intervallo di tempo per il pull dei dati per il report. Se personalizzato, è necessario specificare un periodo di tempo specifico.
type	ReportType	Tipo del report.

ReportConfigFilter

Object

Espressione di filtro da utilizzare nel report.

Nome	Tipo	Descrizione
and	ReportConfigFilter[]	Espressione logica "AND". Deve contenere almeno 2 elementi.
dimension	ReportConfigComparisonExpression	Espressione di confronto per una dimensione
not	ReportConfigFilter	Espressione logica "NOT".
or	ReportConfigFilter[]	Espressione logica "OR". Deve contenere almeno 2 elementi.
tag	ReportConfigComparisonExpression	Ha un'espressione di confronto per un tag

ReportConfigGrouping

Object

Gruppo per espressione da utilizzare nel report.

Nome	Tipo	Descrizione
columnType	ReportConfigColumnType	Tipo della colonna da raggruppare.
name	string	Nome della colonna da raggruppare.

ReportConfigTimePeriod

Object

Data di inizio e fine per il pull dei dati per il report.

Nome	Tipo	Descrizione
from	string (date-time)	Data di inizio da cui estrarre i dati.
to	string (date-time)	Data di fine in cui eseguire il pull dei dati.

ReportType

Enumerazione

Tipo del report.

Valore	Descrizione
Usage

TimeframeType

Enumerazione

Intervallo di tempo per il pull dei dati per il report. Se personalizzato, è necessario specificare un periodo di tempo specifico.

Valore	Descrizione
WeekToDate
MonthToDate
YearToDate
Custom

Condividi tramite

Query Billing Account - Query Billing Account

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

BillingAccountQuery

Esempio di richiesta

Risposta di esempio

Definizioni

ErrorDetails

ErrorResponse

FunctionType

GranularityType

OperatorType

Query

QueryColumn

QueryResult

ReportConfigAggregation

ReportConfigColumnType

ReportConfigComparisonExpression

ReportConfigDataset

ReportConfigDatasetConfiguration

ReportConfigDefinition

ReportConfigFilter

ReportConfigGrouping

ReportConfigTimePeriod

ReportType

TimeframeType