Query Billing Account - Query Billing Account

Služba:: Cost Management

Verze rozhraní API:: 2018-05-31

Zobrazí seznam dat o využití pro fakturační účet.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
billingAccountId	path	True	string	ID fakturačního účtu
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuální verze je 31. 5. 2018.

Text požadavku

Name	Vyžadováno	Typ	Description
timeframe	True	TimeframeType	Časový rámec pro vyžádání dat pro sestavu. Pokud je vlastní, je nutné zadat konkrétní časové období.
type	True	ReportType	Typ sestavy.
dataset		ReportConfigDataset	Obsahuje definici dat v této konfiguraci sestavy.
timePeriod		ReportConfigTimePeriod	Má časové období pro načítání dat pro sestavu.

Odpovědi

Name	Typ	Description
200 OK	QueryResult	OK. Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

BillingAccountQuery

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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
          ]
        ]
      }
    }
  ]
}

Definice

Name	Description
ErrorDetails	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.
FunctionType	Název agregační funkce, která se má použít.
GranularityType	Členitost řádků v sestavě
OperatorType	Operátor, který se má použít pro porovnání.
Query
QueryColumn
QueryResult	Výsledek dotazu Obsahuje všechny sloupce uvedené pod seskupením a agregací.
ReportConfigAggregation	Výraz agregace, který se má použít v sestavě.
ReportConfigColumnType	Typ sloupce v sestavě
ReportConfigComparisonExpression	Výraz porovnání, který se má použít v sestavě.
ReportConfigDataset	Definice dat, která jsou v sestavě přítomna.
ReportConfigDatasetConfiguration	Konfigurace datové sady v sestavě
ReportConfigDefinition	Definice konfigurace sestavy.
ReportConfigFilter	Výraz filtru, který se má použít v sestavě.
ReportConfigGrouping	Seskupit podle výrazu, který se má použít v sestavě.
ReportConfigTimePeriod	Počáteční a koncové datum pro načtení dat pro sestavu.
ReportType	Typ sestavy.
TimeframeType	Časový rámec pro vyžádání dat pro sestavu. Pokud je vlastní, je nutné zadat konkrétní časové období.

ErrorDetails

Objekt

Podrobnosti o chybě.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

ErrorResponse

Objekt

Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.

Name	Typ	Description
error	ErrorDetails	Podrobnosti o chybě.

FunctionType

Výčet

Název agregační funkce, která se má použít.

Hodnota	Description
Sum

GranularityType

Výčet

Členitost řádků v sestavě

Hodnota	Description
Daily

OperatorType

Výčet

Operátor, který se má použít pro porovnání.

Hodnota	Description
In

Query

Objekt

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku
properties.columns	QueryColumn[]	Pole sloupců
properties.nextLink	string
properties.rows	Rows[]
tags	object	Značky prostředků
type	string	Typ prostředku.

QueryColumn

Objekt

Name	Typ	Description
name	string
type	string

QueryResult

Objekt

Výsledek dotazu Obsahuje všechny sloupce uvedené pod seskupením a agregací.

Name	Typ	Description
value	Query[]	Seznam dat o využití

ReportConfigAggregation

Objekt

Výraz agregace, který se má použít v sestavě.

Name	Typ	Description
function	FunctionType	Název agregační funkce, která se má použít.
name	string	Název sloupce, který se má agregovat.

ReportConfigColumnType

Výčet

Typ sloupce v sestavě

Hodnota	Description
Tag
Dimension

ReportConfigComparisonExpression

Objekt

Výraz porovnání, který se má použít v sestavě.

Name	Typ	Description
name	string	Název sloupce, který se má použít při porovnání.
operator	OperatorType	Operátor, který se má použít pro porovnání.
values	string[]	Pole hodnot, které se mají použít k porovnání

ReportConfigDataset

Objekt

Definice dat, která jsou v sestavě přítomna.

Name	Typ	Description
aggregation	<string, ReportConfigAggregation>	Slovník agregačního výrazu, který se má použít v sestavě. Klíč každé položky ve slovníku je alias agregovaného sloupce. Sestava může mít až 2 agregační klauzule.
configuration	ReportConfigDatasetConfiguration	Obsahuje informace o konfiguraci dat v sestavě. Konfigurace bude ignorována, pokud jsou k dispozici agregace a seskupení.
filter	ReportConfigFilter	Obsahuje výraz filtru, který se má použít v sestavě.
granularity	GranularityType	Členitost řádků v sestavě
grouping	ReportConfigGrouping[]	Pole seskupování podle výrazu pro použití v sestavě Sestava může mít až 2 klauzule seskupit podle.

ReportConfigDatasetConfiguration

Objekt

Konfigurace datové sady v sestavě

Name	Typ	Description
columns	string[]	Pole názvů sloupců, které se mají zahrnout do sestavy. Je povolený libovolný platný název sloupce sestavy. Pokud není zadaný, sestava obsahuje všechny sloupce.

ReportConfigDefinition

Objekt

Definice konfigurace sestavy.

Name	Typ	Description
dataset	ReportConfigDataset	Obsahuje definici dat v této konfiguraci sestavy.
timePeriod	ReportConfigTimePeriod	Má časové období pro načítání dat pro sestavu.
timeframe	TimeframeType	Časový rámec pro vyžádání dat pro sestavu. Pokud je vlastní, je nutné zadat konkrétní časové období.
type	ReportType	Typ sestavy.

ReportConfigFilter

Objekt

Výraz filtru, který se má použít v sestavě.

Name	Typ	Description
and	ReportConfigFilter[]	Logický výraz AND. Musí obsahovat alespoň 2 položky.
dimension	ReportConfigComparisonExpression	Obsahuje porovnávací výraz pro dimenzi.
not	ReportConfigFilter	Logický výraz NOT.
or	ReportConfigFilter[]	Logický výraz OR. Musí obsahovat alespoň 2 položky.
tag	ReportConfigComparisonExpression	Obsahuje výraz porovnání pro značku.

ReportConfigGrouping

Objekt

Seskupit podle výrazu, který se má použít v sestavě.

Name	Typ	Description
columnType	ReportConfigColumnType	Má typ sloupce, který se má seskupit.
name	string	Název sloupce, který se má seskupit.

ReportConfigTimePeriod

Objekt

Počáteční a koncové datum pro načtení dat pro sestavu.

Name	Typ	Description
from	string (date-time)	Počáteční datum pro načtení dat.
to	string (date-time)	Koncové datum pro načtení dat.

ReportType

Výčet

Typ sestavy.

Hodnota	Description
Usage

TimeframeType

Výčet

Časový rámec pro vyžádání dat pro sestavu. Pokud je vlastní, je nutné zadat konkrétní časové období.

Hodnota	Description
WeekToDate
MonthToDate
YearToDate
Custom

Sdílet prostřednictvím

Query Billing Account - Query Billing Account

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

BillingAccountQuery

Ukázkový požadavek

Ukázková odpověď

Definice

ErrorDetails

ErrorResponse

FunctionType

GranularityType

OperatorType

Query

QueryColumn

QueryResult

ReportConfigAggregation

ReportConfigColumnType

ReportConfigComparisonExpression

ReportConfigDataset

ReportConfigDatasetConfiguration

ReportConfigDefinition

ReportConfigFilter

ReportConfigGrouping

ReportConfigTimePeriod

ReportType

TimeframeType