Query Billing Account - Query Billing Account

Szolgáltatás:: Cost Management

API-verzió:: 2018-05-31

A számlázási fiók használati adatait sorolja fel.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
billingAccountId	path	True	string	BillingAccount azonosítója
api-version	query	True	string	Az ügyfélkéréshez használandó API verziója. A jelenlegi verzió: 2018-05-31.

Kérelem törzse

Name	Kötelező	Típus	Description
timeframe	True	TimeframeType	A jelentés adatainak lekérésének időkerete. Ha egyéni, akkor meg kell adni egy adott időtartamot.
type	True	ReportType	A jelentés típusa.
dataset		ReportConfigDataset	A jelentés konfigurációjában található adatok definíciója.
timePeriod		ReportConfigTimePeriod	Rendelkezik a jelentés adatainak lekéréséhez szükséges idővel.

Válaszok

Name	Típus	Description
200 OK	QueryResult	OKÉ. A kérés sikeres volt.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

BillingAccountQuery

Mintakérelem

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

Mintaválasz

Állapotkó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
          ]
        ]
      }
    }
  ]
}

Definíciók

Name	Description
ErrorDetails	A hiba részletei.
ErrorResponse	A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.
FunctionType	A használni kívánt összesítő függvény neve.
GranularityType	A jelentés sorainak részletessége.
OperatorType	Az összehasonlításhoz használni kívánt operátor.
Query
QueryColumn
QueryResult	A lekérdezés eredménye. A csoportosítások és összesítések alatt felsorolt összes oszlopot tartalmazza.
ReportConfigAggregation	A jelentésben használandó összesítési kifejezés.
ReportConfigColumnType	A jelentés oszlopának típusa.
ReportConfigComparisonExpression	A jelentésben használandó összehasonlító kifejezés.
ReportConfigDataset	A jelentésben szereplő adatok definíciója.
ReportConfigDatasetConfiguration	Az adathalmaz konfigurációja a jelentésben.
ReportConfigDefinition	A jelentéskonfiguráció definíciója.
ReportConfigFilter	A jelentésben használandó szűrőkifejezés.
ReportConfigGrouping	A jelentésben használandó kifejezés szerinti csoportosítás.
ReportConfigTimePeriod	A jelentés adatainak lekérésének kezdő és záró dátuma.
ReportType	A jelentés típusa.
TimeframeType	A jelentés adatainak lekérésének időkerete. Ha egyéni, akkor meg kell adni egy adott időtartamot.

ErrorDetails

Objektum

A hiba részletei.

Name	Típus	Description
code	string	Hibakód.
message	string	A művelet sikertelen voltát jelző hibaüzenet.

ErrorResponse

Objektum

A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Name	Típus	Description
error	ErrorDetails	A hiba részletei.

FunctionType

Enumerálás

A használni kívánt összesítő függvény neve.

Érték	Description
Sum

GranularityType

Enumerálás

A jelentés sorainak részletessége.

Érték	Description
Daily

OperatorType

Enumerálás

Az összehasonlításhoz használni kívánt operátor.

Érték	Description
In

Query

Objektum

Name	Típus	Description
id	string	Erőforrás-azonosító.
name	string	Erőforrás neve.
properties.columns	QueryColumn[]	Oszlopok tömbje
properties.nextLink	string
properties.rows	Rows[]
tags	object	Erőforráscímkék.
type	string	Erőforrás típusa.

QueryColumn

Objektum

Name	Típus	Description
name	string
type	string

QueryResult

Objektum

A lekérdezés eredménye. A csoportosítások és összesítések alatt felsorolt összes oszlopot tartalmazza.

Name	Típus	Description
value	Query[]	A használati adatok listája.

ReportConfigAggregation

Objektum

A jelentésben használandó összesítési kifejezés.

Name	Típus	Description
function	FunctionType	A használni kívánt összesítő függvény neve.
name	string	Az összesítendő oszlop neve.

ReportConfigColumnType

Enumerálás

A jelentés oszlopának típusa.

Érték	Description
Tag
Dimension

ReportConfigComparisonExpression

Objektum

A jelentésben használandó összehasonlító kifejezés.

Name	Típus	Description
name	string	Az összehasonlítandó oszlop neve.
operator	OperatorType	Az összehasonlításhoz használni kívánt operátor.
values	string[]	Összehasonlításhoz használandó értékek tömbje

ReportConfigDataset

Objektum

A jelentésben szereplő adatok definíciója.

Name	Típus	Description
aggregation	<string, ReportConfigAggregation>	A jelentésben használandó összesítési kifejezés szótára. A szótár minden elemének kulcsa az összesített oszlop aliasa. A jelentés legfeljebb 2 összesítési záradékkal rendelkezhet.
configuration	ReportConfigDatasetConfiguration	A jelentésben szereplő adatok konfigurációs adataival rendelkezik. A konfiguráció figyelmen kívül lesz hagyva, ha az összesítés és a csoportosítás meg van adva.
filter	ReportConfigFilter	Szűrőkifejezést használ a jelentésben.
granularity	GranularityType	A jelentés sorainak részletessége.
grouping	ReportConfigGrouping[]	A jelentésben használandó csoportosítási kifejezés tömbje. A jelentés legfeljebb 2 csoporttal rendelkezhet záradékok szerint.

ReportConfigDatasetConfiguration

Objektum

Az adathalmaz konfigurációja a jelentésben.

Name	Típus	Description
columns	string[]	A jelentésben szerepeltetni kívánt oszlopnevek tömbje. Bármely érvényes jelentésoszlop neve engedélyezett. Ha nincs megadva, akkor a jelentés az összes oszlopot tartalmazza.

ReportConfigDefinition

Objektum

A jelentéskonfiguráció definíciója.

Name	Típus	Description
dataset	ReportConfigDataset	A jelentés konfigurációjában található adatok definíciója.
timePeriod	ReportConfigTimePeriod	Rendelkezik a jelentés adatainak lekéréséhez szükséges idővel.
timeframe	TimeframeType	A jelentés adatainak lekérésének időkerete. Ha egyéni, akkor meg kell adni egy adott időtartamot.
type	ReportType	A jelentés típusa.

ReportConfigFilter

Objektum

A jelentésben használandó szűrőkifejezés.

Name	Típus	Description
and	ReportConfigFilter[]	A logikai "AND" kifejezés. Legalább 2 elemnek kell lennie.
dimension	ReportConfigComparisonExpression	Dimenzió összehasonlító kifejezéssel rendelkezik
not	ReportConfigFilter	A logikai "NOT" kifejezés.
or	ReportConfigFilter[]	A logikai "OR" kifejezés. Legalább 2 elemnek kell lennie.
tag	ReportConfigComparisonExpression	Címkéhez tartozó összehasonlító kifejezéssel rendelkezik

ReportConfigGrouping

Objektum

A jelentésben használandó kifejezés szerinti csoportosítás.

Name	Típus	Description
columnType	ReportConfigColumnType	A csoportosítandó oszlop típusa.
name	string	A csoportosítandó oszlop neve.

ReportConfigTimePeriod

Objektum

A jelentés adatainak lekérésének kezdő és záró dátuma.

Name	Típus	Description
from	string (date-time)	Az adatok lekérésének kezdő dátuma.
to	string (date-time)	Az adatok lekérésének záró dátuma.

ReportType

Enumerálás

A jelentés típusa.

Érték	Description
Usage

TimeframeType

Enumerálás

A jelentés adatainak lekérésének időkerete. Ha egyéni, akkor meg kell adni egy adott időtartamot.

Érték	Description
WeekToDate
MonthToDate
YearToDate
Custom