Query Billing Account - Query Billing Account

Service:: Cost Management

API-versie:: 2018-05-31

Hier worden de gebruiksgegevens voor de factureringsrekening weergegeven.

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

URI-parameters

Name	In	Vereist	Type	Description
billingAccountId	path	True	string	Factureringsaccount-id
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag. De huidige versie is 2018-05-31.

Aanvraagbody

Name	Vereist	Type	Description
timeframe	True	TimeframeType	Het tijdsbestek voor het ophalen van gegevens voor het rapport. Als dit aangepast is, moet er een specifieke periode worden opgegeven.
type	True	ReportType	Het type rapport.
dataset		ReportConfigDataset	Bevat definitie voor gegevens in deze rapportconfiguratie.
timePeriod		ReportConfigTimePeriod	Heeft een periode voor het ophalen van gegevens voor het rapport.

Antwoorden

Name	Type	Description
200 OK	QueryResult	OK. De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

BillingAccountQuery

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
ErrorDetails	De details van de fout.
ErrorResponse	Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht.
FunctionType	De naam van de te gebruiken aggregatiefunctie.
GranularityType	De granulariteit van rijen in het rapport.
OperatorType	De operator die moet worden gebruikt voor vergelijking.
Query
QueryColumn
QueryResult	Resultaat van query. Het bevat alle kolommen die worden vermeld onder groeperingen en aggregatie.
ReportConfigAggregation	De aggregatie-expressie die in het rapport moet worden gebruikt.
ReportConfigColumnType	Het type kolom in het rapport.
ReportConfigComparisonExpression	De vergelijkingsexpressie die in het rapport moet worden gebruikt.
ReportConfigDataset	De definitie van gegevens die aanwezig zijn in het rapport.
ReportConfigDatasetConfiguration	De configuratie van de gegevensset in het rapport.
ReportConfigDefinition	De definitie van een rapportconfiguratie.
ReportConfigFilter	De filterexpressie die moet worden gebruikt in het rapport.
ReportConfigGrouping	De groeperen op expressie die in het rapport moet worden gebruikt.
ReportConfigTimePeriod	De begin- en einddatum voor het ophalen van gegevens voor het rapport.
ReportType	Het type rapport.
TimeframeType	Het tijdsbestek voor het ophalen van gegevens voor het rapport. Als dit aangepast is, moet er een specifieke periode worden opgegeven.

ErrorDetails

Object

De details van de fout.

Name	Type	Description
code	string	Foutcode.
message	string	Foutbericht dat aangeeft waarom de bewerking is mislukt.

ErrorResponse

Object

Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht.

Name	Type	Description
error	ErrorDetails	De details van de fout.

FunctionType

Inventarisatie

De naam van de te gebruiken aggregatiefunctie.

Waarde	Description
Sum

GranularityType

Inventarisatie

De granulariteit van rijen in het rapport.

Waarde	Description
Daily

OperatorType

Inventarisatie

De operator die moet worden gebruikt voor vergelijking.

Waarde	Description
In

Query

Object

Name	Type	Description
id	string	Resource-id.
name	string	Resourcenaam.
properties.columns	QueryColumn[]	Matrix van kolommen
properties.nextLink	string
properties.rows	Rows[]
tags	object	Resourcetags.
type	string	Resourcetype.

QueryColumn

Object

Name	Type	Description
name	string
type	string

QueryResult

Object

Resultaat van query. Het bevat alle kolommen die worden vermeld onder groeperingen en aggregatie.

Name	Type	Description
value	Query[]	De lijst met gebruiksgegevens.

ReportConfigAggregation

Object

De aggregatie-expressie die in het rapport moet worden gebruikt.

Name	Type	Description
function	FunctionType	De naam van de te gebruiken aggregatiefunctie.
name	string	De naam van de kolom die moet worden samengevoegd.

ReportConfigColumnType

Inventarisatie

Het type kolom in het rapport.

Waarde	Description
Tag
Dimension

ReportConfigComparisonExpression

Object

De vergelijkingsexpressie die in het rapport moet worden gebruikt.

Name	Type	Description
name	string	De naam van de kolom die moet worden gebruikt in vergelijking.
operator	OperatorType	De operator die moet worden gebruikt voor vergelijking.
values	string[]	Matrix met waarden die moeten worden gebruikt voor vergelijking

ReportConfigDataset

Object

De definitie van gegevens die aanwezig zijn in het rapport.

Name	Type	Description
aggregation	<string, ReportConfigAggregation>	Woordenlijst van aggregatie-expressie die in het rapport moet worden gebruikt. De sleutel van elk item in de woordenlijst is de alias voor de samengevoegde kolom. Rapport kan maximaal 2 aggregatiecomponenten bevatten.
configuration	ReportConfigDatasetConfiguration	Bevat configuratie-informatie voor de gegevens in het rapport. De configuratie wordt genegeerd als aggregatie en groepering worden opgegeven.
filter	ReportConfigFilter	Heeft filterexpressie die moet worden gebruikt in het rapport.
granularity	GranularityType	De granulariteit van rijen in het rapport.
grouping	ReportConfigGrouping[]	Matrix van groeperen op expressie die in het rapport moet worden gebruikt. Rapport kan maximaal 2 group by-componenten bevatten.

ReportConfigDatasetConfiguration

Object

De configuratie van de gegevensset in het rapport.

Name	Type	Description
columns	string[]	Matrix van kolomnamen die moeten worden opgenomen in het rapport. Elke geldige kolomnaam van het rapport is toegestaan. Als dit niet is opgegeven, bevat het rapport alle kolommen.

ReportConfigDefinition

Object

De definitie van een rapportconfiguratie.

Name	Type	Description
dataset	ReportConfigDataset	Bevat definitie voor gegevens in deze rapportconfiguratie.
timePeriod	ReportConfigTimePeriod	Heeft een periode voor het ophalen van gegevens voor het rapport.
timeframe	TimeframeType	Het tijdsbestek voor het ophalen van gegevens voor het rapport. Als dit aangepast is, moet er een specifieke periode worden opgegeven.
type	ReportType	Het type rapport.

ReportConfigFilter

Object

De filterexpressie die moet worden gebruikt in het rapport.

Name	Type	Description
and	ReportConfigFilter[]	De logische 'AND'-expressie. Moet ten minste 2 items bevatten.
dimension	ReportConfigComparisonExpression	Heeft een vergelijkingsexpressie voor een dimensie
not	ReportConfigFilter	De logische not-expressie.
or	ReportConfigFilter[]	De logische 'OR'-expressie. Moet ten minste 2 items bevatten.
tag	ReportConfigComparisonExpression	Heeft een vergelijkingsexpressie voor een tag

ReportConfigGrouping

Object

De groeperen op expressie die in het rapport moet worden gebruikt.

Name	Type	Description
columnType	ReportConfigColumnType	Heeft het type kolom dat moet worden gegroepeerd.
name	string	De naam van de kolom die moet worden gegroepeerd.

ReportConfigTimePeriod

Object

De begin- en einddatum voor het ophalen van gegevens voor het rapport.

Name	Type	Description
from	string (date-time)	De begindatum waaruit gegevens moeten worden opgehaald.
to	string (date-time)	De einddatum voor het ophalen van gegevens naar.

ReportType

Inventarisatie

Het type rapport.

Waarde	Description
Usage

TimeframeType

Inventarisatie

Het tijdsbestek voor het ophalen van gegevens voor het rapport. Als dit aangepast is, moet er een specifieke periode worden opgegeven.

Waarde	Description
WeekToDate
MonthToDate
YearToDate
Custom

Delen via

Query Billing Account - Query Billing Account

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

BillingAccountQuery

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ErrorDetails

ErrorResponse

FunctionType

GranularityType

OperatorType

Query

QueryColumn

QueryResult

ReportConfigAggregation

ReportConfigColumnType

ReportConfigComparisonExpression

ReportConfigDataset

ReportConfigDatasetConfiguration

ReportConfigDefinition

ReportConfigFilter

ReportConfigGrouping

ReportConfigTimePeriod

ReportType

TimeframeType