Query Billing Account - Query Billing Account

Usługa:: Cost Management

Wersja interfejsu API:: 2018-05-31

Wyświetla listę danych użycia dla konta rozliczeniowego.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
billingAccountId	path	True	string	Identyfikator konta rozliczeniowego
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta. Bieżąca wersja to 2018-05-31.

Treść żądania

Nazwa	Wymagane	Typ	Opis
timeframe	True	TimeframeType	Przedział czasu na ściąganie danych dla raportu. Jeśli jest to niestandardowe, należy podać określony okres.
type	True	ReportType	Typ raportu.
dataset		ReportConfigDataset	Zawiera definicję danych w tej konfiguracji raportu.
timePeriod		ReportConfigTimePeriod	Zawiera okres czasu na ściąganie danych dla raportu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	QueryResult	OK. Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

BillingAccountQuery

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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
          ]
        ]
      }
    }
  ]
}

Definicje

Nazwa	Opis
ErrorDetails	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie.
FunctionType	Nazwa funkcji agregacji do użycia.
GranularityType	Stopień szczegółowości wierszy w raporcie.
OperatorType	Operator, który ma być używany do porównania.
Query
QueryColumn
QueryResult	Wynik zapytania. Zawiera wszystkie kolumny wymienione w obszarze grupowania i agregacji.
ReportConfigAggregation	Wyrażenie agregacji, które ma być używane w raporcie.
ReportConfigColumnType	Typ kolumny w raporcie.
ReportConfigComparisonExpression	Wyrażenie porównania, które ma być używane w raporcie.
ReportConfigDataset	Definicja danych znajdujących się w raporcie.
ReportConfigDatasetConfiguration	Konfiguracja zestawu danych w raporcie.
ReportConfigDefinition	Definicja konfiguracji raportu.
ReportConfigFilter	Wyrażenie filtru do użycia w raporcie.
ReportConfigGrouping	Grupa według wyrażenia, która ma być używana w raporcie.
ReportConfigTimePeriod	Data rozpoczęcia i zakończenia ściągania danych dla raportu.
ReportType	Typ raportu.
TimeframeType	Przedział czasu na ściąganie danych dla raportu. Jeśli jest to niestandardowe, należy podać określony okres.

ErrorDetails

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponse

Objekt

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie.

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu.

FunctionType

Wyliczanie

Nazwa funkcji agregacji do użycia.

Wartość	Opis
Sum

GranularityType

Wyliczanie

Stopień szczegółowości wierszy w raporcie.

Wartość	Opis
Daily

OperatorType

Wyliczanie

Operator, który ma być używany do porównania.

Wartość	Opis
In

Query

Objekt

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.columns	QueryColumn[]	Tablica kolumn
properties.nextLink	string
properties.rows	Rows[]
tags	object	Tagi zasobów.
type	string	Typ zasobu.

QueryColumn

Objekt

Nazwa	Typ	Opis
name	string
type	string

QueryResult

Objekt

Wynik zapytania. Zawiera wszystkie kolumny wymienione w obszarze grupowania i agregacji.

Nazwa	Typ	Opis
value	Query[]	Lista danych użycia.

ReportConfigAggregation

Objekt

Wyrażenie agregacji, które ma być używane w raporcie.

Nazwa	Typ	Opis
function	FunctionType	Nazwa funkcji agregacji do użycia.
name	string	Nazwa kolumny do agregowania.

ReportConfigColumnType

Wyliczanie

Typ kolumny w raporcie.

Wartość	Opis
Tag
Dimension

ReportConfigComparisonExpression

Objekt

Wyrażenie porównania, które ma być używane w raporcie.

Nazwa	Typ	Opis
name	string	Nazwa kolumny do użycia w porównaniu.
operator	OperatorType	Operator, który ma być używany do porównania.
values	string[]	Tablica wartości do użycia do porównania

ReportConfigDataset

Objekt

Definicja danych znajdujących się w raporcie.

Nazwa	Typ	Opis
aggregation	<string, ReportConfigAggregation>	Słownik wyrażenia agregacji do użycia w raporcie. Kluczem każdego elementu w słowniku jest alias kolumny zagregowanej. Raport może mieć maksymalnie 2 klauzule agregacji.
configuration	ReportConfigDatasetConfiguration	Zawiera informacje o konfiguracji danych w raporcie. Konfiguracja zostanie zignorowana, jeśli podano agregację i grupowanie.
filter	ReportConfigFilter	Zawiera wyrażenie filtru do użycia w raporcie.
granularity	GranularityType	Stopień szczegółowości wierszy w raporcie.
grouping	ReportConfigGrouping[]	Tablica grupowania według wyrażenia do użycia w raporcie. Raport może mieć maksymalnie 2 klauzule grupowania.

ReportConfigDatasetConfiguration

Objekt

Konfiguracja zestawu danych w raporcie.

Nazwa	Typ	Opis
columns	string[]	Tablica nazw kolumn, które mają być uwzględnione w raporcie. Dowolna prawidłowa nazwa kolumny raportu jest dozwolona. Jeśli nie zostanie podany, raport zawiera wszystkie kolumny.

ReportConfigDefinition

Objekt

Definicja konfiguracji raportu.

Nazwa	Typ	Opis
dataset	ReportConfigDataset	Zawiera definicję danych w tej konfiguracji raportu.
timePeriod	ReportConfigTimePeriod	Zawiera okres czasu na ściąganie danych dla raportu.
timeframe	TimeframeType	Przedział czasu na ściąganie danych dla raportu. Jeśli jest to niestandardowe, należy podać określony okres.
type	ReportType	Typ raportu.

ReportConfigFilter

Objekt

Wyrażenie filtru do użycia w raporcie.

Nazwa	Typ	Opis
and	ReportConfigFilter[]	Logiczne wyrażenie "AND". Musi zawierać co najmniej 2 elementy.
dimension	ReportConfigComparisonExpression	Zawiera wyrażenie porównania dla wymiaru
not	ReportConfigFilter	Wyrażenie logiczne "NOT".
or	ReportConfigFilter[]	Logiczne wyrażenie "OR". Musi zawierać co najmniej 2 elementy.
tag	ReportConfigComparisonExpression	Zawiera wyrażenie porównania dla tagu

ReportConfigGrouping

Objekt

Grupa według wyrażenia, która ma być używana w raporcie.

Nazwa	Typ	Opis
columnType	ReportConfigColumnType	Ma typ kolumny do grupy.
name	string	Nazwa kolumny do grupy.

ReportConfigTimePeriod

Objekt

Data rozpoczęcia i zakończenia ściągania danych dla raportu.

Nazwa	Typ	Opis
from	string (date-time)	Data rozpoczęcia ściągania danych.
to	string (date-time)	Data zakończenia do ściągnięcia danych.

ReportType

Wyliczanie

Typ raportu.

Wartość	Opis
Usage

TimeframeType

Wyliczanie

Przedział czasu na ściąganie danych dla raportu. Jeśli jest to niestandardowe, należy podać określony okres.

Wartość	Opis
WeekToDate
MonthToDate
YearToDate
Custom

Udostępnij za pośrednictwem

Query Billing Account - Query Billing Account

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

BillingAccountQuery

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ErrorDetails

ErrorResponse

FunctionType

GranularityType

OperatorType

Query

QueryColumn

QueryResult

ReportConfigAggregation

ReportConfigColumnType

ReportConfigComparisonExpression

ReportConfigDataset

ReportConfigDatasetConfiguration

ReportConfigDefinition

ReportConfigFilter

ReportConfigGrouping

ReportConfigTimePeriod

ReportType

TimeframeType