Query Billing Account - Query Billing Account

Tjänst:: Cost Management

API-version:: 2018-05-31

Visar en lista över användningsdata för faktureringskontot.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
billingAccountId	path	True	string	FaktureringKonto-ID
api-version	query	True	string	Version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2018-05-31.

Begärandetext

Name	Obligatorisk	Typ	Description
timeframe	True	TimeframeType	Tidsramen för att hämta data för rapporten. Om det är anpassat måste en viss tidsperiod anges.
type	True	ReportType	Rapportens typ.
dataset		ReportConfigDataset	Har definition för data i den här rapportkonfigurationen.
timePeriod		ReportConfigTimePeriod	Har en tidsperiod för att hämta data för rapporten.

Svar

Name	Typ	Description
200 OK	QueryResult	OKEJ. Begäran har slutförts.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

BillingAccountQuery

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
ErrorDetails	Information om felet.
ErrorResponse	Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.
FunctionType	Namnet på den sammansättningsfunktion som ska användas.
GranularityType	Kornigheten för rader i rapporten.
OperatorType	Operatorn som ska användas för jämförelse.
Query
QueryColumn
QueryResult	Resultatet av frågan. Den innehåller alla kolumner som anges under gruppering och sammansättning.
ReportConfigAggregation	Det sammansättningsuttryck som ska användas i rapporten.
ReportConfigColumnType	Typen av kolumn i rapporten.
ReportConfigComparisonExpression	Jämförelseuttrycket som ska användas i rapporten.
ReportConfigDataset	Definitionen av data som finns i rapporten.
ReportConfigDatasetConfiguration	Konfigurationen av datamängden i rapporten.
ReportConfigDefinition	Definitionen av en rapportkonfiguration.
ReportConfigFilter	Filteruttrycket som ska användas i rapporten.
ReportConfigGrouping	Gruppen efter uttryck som ska användas i rapporten.
ReportConfigTimePeriod	Start- och slutdatumet för att hämta data för rapporten.
ReportType	Rapportens typ.
TimeframeType	Tidsramen för att hämta data för rapporten. Om det är anpassat måste en viss tidsperiod anges.

ErrorDetails

Objekt

Information om felet.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponse

Objekt

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Name	Typ	Description
error	ErrorDetails	Information om felet.

FunctionType

Uppräkning

Namnet på den sammansättningsfunktion som ska användas.

Värde	Description
Sum

GranularityType

Uppräkning

Kornigheten för rader i rapporten.

Värde	Description
Daily

OperatorType

Uppräkning

Operatorn som ska användas för jämförelse.

Värde	Description
In

Query

Objekt

Name	Typ	Description
id	string	Resurs-ID.
name	string	Resursnamn.
properties.columns	QueryColumn[]	Matris med kolumner
properties.nextLink	string
properties.rows	Rows[]
tags	object	Resurstaggar.
type	string	Resurstyp.

QueryColumn

Objekt

Name	Typ	Description
name	string
type	string

QueryResult

Objekt

Resultatet av frågan. Den innehåller alla kolumner som anges under gruppering och sammansättning.

Name	Typ	Description
value	Query[]	Listan över användningsdata.

ReportConfigAggregation

Objekt

Det sammansättningsuttryck som ska användas i rapporten.

Name	Typ	Description
function	FunctionType	Namnet på den sammansättningsfunktion som ska användas.
name	string	Namnet på kolumnen som ska aggregeras.

ReportConfigColumnType

Uppräkning

Typen av kolumn i rapporten.

Värde	Description
Tag
Dimension

ReportConfigComparisonExpression

Objekt

Jämförelseuttrycket som ska användas i rapporten.

Name	Typ	Description
name	string	Namnet på kolumnen som ska användas i jämförelse.
operator	OperatorType	Operatorn som ska användas för jämförelse.
values	string[]	Matris med värden som ska användas för jämförelse

ReportConfigDataset

Objekt

Definitionen av data som finns i rapporten.

Name	Typ	Description
aggregation	<string, ReportConfigAggregation>	Ordlista med sammansättningsuttryck som ska användas i rapporten. Nyckeln för varje objekt i ordlistan är aliaset för den aggregerade kolumnen. Rapporten kan ha upp till 2 aggregeringssatser.
configuration	ReportConfigDatasetConfiguration	Har konfigurationsinformation för data i rapporten. Konfigurationen ignoreras om sammansättning och gruppering tillhandahålls.
filter	ReportConfigFilter	Har filteruttryck att använda i rapporten.
granularity	GranularityType	Kornigheten för rader i rapporten.
grouping	ReportConfigGrouping[]	Matris med grupper efter uttryck som ska användas i rapporten. Rapporten kan ha upp till 2 gruppera efter-satser.

ReportConfigDatasetConfiguration

Objekt

Konfigurationen av datamängden i rapporten.

Name	Typ	Description
columns	string[]	Matris med kolumnnamn som ska ingå i rapporten. Alla giltiga rapportkolumnnamn tillåts. Om det inte anges innehåller rapporten alla kolumner.

ReportConfigDefinition

Objekt

Definitionen av en rapportkonfiguration.

Name	Typ	Description
dataset	ReportConfigDataset	Har definition för data i den här rapportkonfigurationen.
timePeriod	ReportConfigTimePeriod	Har en tidsperiod för att hämta data för rapporten.
timeframe	TimeframeType	Tidsramen för att hämta data för rapporten. Om det är anpassat måste en viss tidsperiod anges.
type	ReportType	Rapportens typ.

ReportConfigFilter

Objekt

Filteruttrycket som ska användas i rapporten.

Name	Typ	Description
and	ReportConfigFilter[]	Det logiska "AND"-uttrycket. Måste ha minst 2 objekt.
dimension	ReportConfigComparisonExpression	Har jämförelseuttryck för en dimension
not	ReportConfigFilter	Det logiska "NOT"-uttrycket.
or	ReportConfigFilter[]	Det logiska "OR"-uttrycket. Måste ha minst 2 objekt.
tag	ReportConfigComparisonExpression	Har jämförelseuttryck för en tagg

ReportConfigGrouping

Objekt

Gruppen efter uttryck som ska användas i rapporten.

Name	Typ	Description
columnType	ReportConfigColumnType	Har typen av kolumn som ska grupperas.
name	string	Namnet på kolumnen som ska grupperas.

ReportConfigTimePeriod

Objekt

Start- och slutdatumet för att hämta data för rapporten.

Name	Typ	Description
from	string (date-time)	Startdatumet för att hämta data från.
to	string (date-time)	Slutdatumet för att hämta data till.

ReportType

Uppräkning

Rapportens typ.

Värde	Description
Usage

TimeframeType

Uppräkning

Tidsramen för att hämta data för rapporten. Om det är anpassat måste en viss tidsperiod anges.

Värde	Description
WeekToDate
MonthToDate
YearToDate
Custom

Dela via

Query Billing Account - Query Billing Account

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

BillingAccountQuery

Exempelbegäran

Exempelsvar

Definitioner

ErrorDetails

ErrorResponse

FunctionType

GranularityType

OperatorType

Query

QueryColumn

QueryResult

ReportConfigAggregation

ReportConfigColumnType

ReportConfigComparisonExpression

ReportConfigDataset

ReportConfigDatasetConfiguration

ReportConfigDefinition

ReportConfigFilter

ReportConfigGrouping

ReportConfigTimePeriod

ReportType

TimeframeType