Query Billing Account - Query Billing Account

Dienst:: Cost Management

API-Version:: 2018-05-31

Listet die Nutzungsdaten für das Abrechnungskonto auf.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
billingAccountId	path	True	string	BillingAccount-ID
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2018-05-31.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
timeframe	True	TimeframeType	Der Zeitrahmen zum Abrufen von Daten für den Bericht. Wenn benutzerdefiniert, muss ein bestimmter Zeitraum angegeben werden.
type	True	ReportType	Der Typ des Berichts.
dataset		ReportConfigDataset	Enthält definition für Daten in dieser Berichtskonfiguration.
timePeriod		ReportConfigTimePeriod	Hat einen Zeitraum für das Abrufen von Daten für den Bericht.

Antworten

Name	Typ	Beschreibung
200 OK	QueryResult	OKAY. Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

BillingAccountQuery

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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
          ]
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
ErrorDetails	Die Details des Fehlers.
ErrorResponse	Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.
FunctionType	Der Name der zu verwendenden Aggregationsfunktion.
GranularityType	Die Granularität der Zeilen im Bericht.
OperatorType	Der für den Vergleich zu verwendende Operator.
Query
QueryColumn
QueryResult	Ergebnis der Abfrage. Sie enthält alle Spalten, die unter Gruppierungen und Aggregation aufgeführt sind.
ReportConfigAggregation	Der Aggregationsausdruck, der im Bericht verwendet werden soll.
ReportConfigColumnType	Der Typ der Spalte im Bericht.
ReportConfigComparisonExpression	Der im Bericht zu verwendende Vergleichsausdruck.
ReportConfigDataset	Die Definition der daten, die im Bericht vorhanden sind.
ReportConfigDatasetConfiguration	Die Konfiguration des Datasets im Bericht.
ReportConfigDefinition	Die Definition einer Berichtskonfiguration.
ReportConfigFilter	Der filterausdruck, der im Bericht verwendet werden soll.
ReportConfigGrouping	Die Gruppe nach Ausdruck, die im Bericht verwendet werden soll.
ReportConfigTimePeriod	Das Start- und Enddatum für das Abrufen von Daten für den Bericht.
ReportType	Der Typ des Berichts.
TimeframeType	Der Zeitrahmen zum Abrufen von Daten für den Bericht. Wenn benutzerdefiniert, muss ein bestimmter Zeitraum angegeben werden.

ErrorDetails

Objekt

Die Details des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Objekt

Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Name	Typ	Beschreibung
error	ErrorDetails	Die Details des Fehlers.

FunctionType

Enumeration

Der Name der zu verwendenden Aggregationsfunktion.

Wert	Beschreibung
Sum

GranularityType

Enumeration

Die Granularität der Zeilen im Bericht.

Wert	Beschreibung
Daily

OperatorType

Enumeration

Der für den Vergleich zu verwendende Operator.

Wert	Beschreibung
In

Query

Objekt

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
name	string	Ressourcenname.
properties.columns	QueryColumn[]	Array von Spalten
properties.nextLink	string
properties.rows	Rows[]
tags	object	Ressourcentags.
type	string	Ressourcentyp.

QueryColumn

Objekt

Name	Typ	Beschreibung
name	string
type	string

QueryResult

Objekt

Ergebnis der Abfrage. Sie enthält alle Spalten, die unter Gruppierungen und Aggregation aufgeführt sind.

Name	Typ	Beschreibung
value	Query[]	Die Liste der Nutzungsdaten.

ReportConfigAggregation

Objekt

Der Aggregationsausdruck, der im Bericht verwendet werden soll.

Name	Typ	Beschreibung
function	FunctionType	Der Name der zu verwendenden Aggregationsfunktion.
name	string	Der Name der zu aggregierenden Spalte.

ReportConfigColumnType

Enumeration

Der Typ der Spalte im Bericht.

Wert	Beschreibung
Tag
Dimension

ReportConfigComparisonExpression

Objekt

Der im Bericht zu verwendende Vergleichsausdruck.

Name	Typ	Beschreibung
name	string	Der Name der Spalte, die im Vergleich verwendet werden soll.
operator	OperatorType	Der für den Vergleich zu verwendende Operator.
values	string[]	Array von Werten, die für den Vergleich verwendet werden sollen

ReportConfigDataset

Objekt

Die Definition der daten, die im Bericht vorhanden sind.

Name	Typ	Beschreibung
aggregation	<string, ReportConfigAggregation>	Wörterbuch des Aggregationsausdrucks, der im Bericht verwendet werden soll. Der Schlüssel der einzelnen Elemente im Wörterbuch ist der Alias für die aggregierte Spalte. Der Bericht kann bis zu 2 Aggregationsklauseln aufweisen.
configuration	ReportConfigDatasetConfiguration	Enthält Konfigurationsinformationen für die Daten im Bericht. Die Konfiguration wird ignoriert, wenn Aggregation und Gruppierung bereitgestellt werden.
filter	ReportConfigFilter	Hat Filterausdruck, der im Bericht verwendet werden soll.
granularity	GranularityType	Die Granularität der Zeilen im Bericht.
grouping	ReportConfigGrouping[]	Array von Gruppieren nach Ausdruck, das im Bericht verwendet werden soll. Der Bericht kann bis zu 2 Gruppen nach Klauseln aufweisen.

ReportConfigDatasetConfiguration

Objekt

Die Konfiguration des Datasets im Bericht.

Name	Typ	Beschreibung
columns	string[]	Array von Spaltennamen, die in den Bericht aufgenommen werden sollen. Ein beliebiger gültiger Berichtsspaltenname ist zulässig. Wenn nicht angegeben, enthält der Bericht alle Spalten.

ReportConfigDefinition

Objekt

Die Definition einer Berichtskonfiguration.

Name	Typ	Beschreibung
dataset	ReportConfigDataset	Enthält definition für Daten in dieser Berichtskonfiguration.
timePeriod	ReportConfigTimePeriod	Hat einen Zeitraum für das Abrufen von Daten für den Bericht.
timeframe	TimeframeType	Der Zeitrahmen zum Abrufen von Daten für den Bericht. Wenn benutzerdefiniert, muss ein bestimmter Zeitraum angegeben werden.
type	ReportType	Der Typ des Berichts.

ReportConfigFilter

Objekt

Der filterausdruck, der im Bericht verwendet werden soll.

Name	Typ	Beschreibung
and	ReportConfigFilter[]	Der logische Ausdruck "AND". Mindestens 2 Elemente müssen enthalten sein.
dimension	ReportConfigComparisonExpression	Hat einen Vergleichsausdruck für eine Dimension
not	ReportConfigFilter	Der logische "NOT"-Ausdruck.
or	ReportConfigFilter[]	Der logische "OR"-Ausdruck. Mindestens 2 Elemente müssen enthalten sein.
tag	ReportConfigComparisonExpression	Hat einen Vergleichsausdruck für ein Tag

ReportConfigGrouping

Objekt

Die Gruppe nach Ausdruck, die im Bericht verwendet werden soll.

Name	Typ	Beschreibung
columnType	ReportConfigColumnType	Weist den Typ der zu gruppierenden Spalte auf.
name	string	Der Name der spalte, die gruppiert werden soll.

ReportConfigTimePeriod

Objekt

Das Start- und Enddatum für das Abrufen von Daten für den Bericht.

Name	Typ	Beschreibung
from	string (date-time)	Das Startdatum, aus dem Daten abgerufen werden sollen.
to	string (date-time)	Das Enddatum, in das Daten abgerufen werden sollen.

ReportType

Enumeration

Der Typ des Berichts.

Wert	Beschreibung
Usage

TimeframeType

Enumeration

Der Zeitrahmen zum Abrufen von Daten für den Bericht. Wenn benutzerdefiniert, muss ein bestimmter Zeitraum angegeben werden.

Wert	Beschreibung
WeekToDate
MonthToDate
YearToDate
Custom

Freigeben über

Query Billing Account - Query Billing Account

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

BillingAccountQuery

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorDetails

ErrorResponse

FunctionType

GranularityType

OperatorType

Query

QueryColumn

QueryResult

ReportConfigAggregation

ReportConfigColumnType

ReportConfigComparisonExpression

ReportConfigDataset

ReportConfigDatasetConfiguration

ReportConfigDefinition

ReportConfigFilter

ReportConfigGrouping

ReportConfigTimePeriod

ReportType

TimeframeType