Query - Usage By External Cloud Provider Type

Referentie

Service:: Cost Management

API Version:: 2023-11-01

Voer een query uit op de gebruiksgegevens voor het gedefinieerde type externe cloudprovider.

POST https://management.azure.com/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/query?api-version=2023-11-01

URI-parameters

Name	In	Vereist	Type	Description
externalCloudProviderId	path	True	string	Dit kan {externalSubscriptionId} zijn voor het gekoppelde account of {externalBillingAccountId} voor een geconsolideerd account dat wordt gebruikt met dimensie-/querybewerkingen.
externalCloudProviderType	path	True	externalCloudProviderType	Het type externe cloudprovider dat is gekoppeld aan dimensie-/querybewerkingen. Dit omvat 'externalSubscriptions' voor een gekoppeld account en 'externalBillingAccounts' voor een geconsolideerd account.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
dataset	True	QueryDataset	Heeft een definitie voor gegevens in deze query.
timeframe	True	TimeframeType	Het tijdsbestek voor het ophalen van gegevens voor de query. Indien aangepast, moet een specifieke periode worden opgegeven.
type	True	ExportType	Het type query.
timePeriod		QueryTimePeriod	Heeft een tijdsperiode voor het ophalen van gegevens voor de query.

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

Azure Active Directory OAuth2-stroom.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

ExternalBillingAccountQueryList

ExternalSubscriptionsQuery

ExternalBillingAccountQueryList

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.CostManagement/externalBillingAccounts/100/query?api-version=2023-11-01

{
  "type": "Usage",
  "timeframe": "MonthToDate",
  "dataset": {
    "granularity": "Daily",
    "filter": {
      "and": [
        {
          "or": [
            {
              "dimensions": {
                "name": "ResourceLocation",
                "operator": "In",
                "values": [
                  "East US",
                  "West Europe"
                ]
              }
            },
            {
              "tags": {
                "name": "Environment",
                "operator": "In",
                "values": [
                  "UAT",
                  "Prod"
                ]
              }
            }
          ]
        },
        {
          "dimensions": {
            "name": "ResourceGroup",
            "operator": "In",
            "values": [
              "API"
            ]
          }
        }
      ]
    }
  }
}

Sample Response

Status code:: 200

{
  "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d",
  "name": "6dc7b06a-d90a-4df5-b655-ce6cf1c0814d",
  "type": "Microsoft.CostManagement/query",
  "properties": {
    "nextLink": null,
    "columns": [
      {
        "name": "PreTaxCost",
        "type": "Number"
      },
      {
        "name": "ServiceName",
        "type": "String"
      },
      {
        "name": "Currency",
        "type": "String"
      }
    ],
    "rows": [
      [
        0,
        "abc db",
        "USD"
      ],
      [
        30.2572751438,
        "abc compute cloud",
        "USD"
      ],
      [
        0.07675760200000002,
        "abc file system",
        "USD"
      ],
      [
        50.43096419040001,
        "abc elasticache",
        "USD"
      ]
    ]
  }
}

ExternalSubscriptionsQuery

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.CostManagement/externalSubscriptions/100/query?api-version=2023-11-01

{
  "type": "Usage",
  "timeframe": "MonthToDate",
  "dataset": {
    "granularity": "Daily",
    "filter": {
      "and": [
        {
          "or": [
            {
              "dimensions": {
                "name": "ResourceLocation",
                "operator": "In",
                "values": [
                  "East US",
                  "West Europe"
                ]
              }
            },
            {
              "tags": {
                "name": "Environment",
                "operator": "In",
                "values": [
                  "UAT",
                  "Prod"
                ]
              }
            }
          ]
        },
        {
          "dimensions": {
            "name": "ResourceGroup",
            "operator": "In",
            "values": [
              "API"
            ]
          }
        }
      ]
    }
  }
}

Sample Response

Status code:: 200

{
  "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d",
  "name": "d99477af-7510-40ee-aca2-e59bdca0d10d",
  "type": "Microsoft.CostManagement/query",
  "properties": {
    "nextLink": null,
    "columns": [
      {
        "name": "PreTaxCost",
        "type": "Number"
      },
      {
        "name": "UsageDate",
        "type": "Number"
      },
      {
        "name": "Currency",
        "type": "String"
      }
    ],
    "rows": []
  }
}

Definities

Name	Description
ErrorDetails	De details van de fout.
ErrorResponse	Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden wordt opgegeven in het foutbericht. Enkele foutberichten: 429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'x-ms-ratelimit-microsoft.consumption-retry-after'. 503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u net zolang hebt gewacht zoals aangegeven in de header 'Retry-After'.
ExportType	Het type query.
externalCloudProviderType	Het type externe cloudprovider dat is gekoppeld aan dimensie-/querybewerkingen. Dit omvat 'externalSubscriptions' voor een gekoppeld account en 'externalBillingAccounts' voor een geconsolideerd account.
FunctionType	De naam van de aggregatiefunctie die moet worden gebruikt.
GranularityType	De granulariteit van rijen in de prognose.
QueryAggregation	De aggregatie-expressie die in de query moet worden gebruikt.
QueryColumn	QueryColumn-eigenschappen
QueryColumnType	Het type kolom in de export.
QueryComparisonExpression	De vergelijkingsexpressie die in de query moet worden gebruikt.
QueryDataset	De definitie van gegevens die aanwezig zijn in de query.
QueryDatasetConfiguration	De configuratie van de gegevensset in de query.
QueryDefinition	De definitie van een query.
QueryFilter	De filterexpressie die moet worden gebruikt in de export.
QueryGrouping	De groeperen op expressie die in de query moet worden gebruikt.
QueryOperatorType	De operator die moet worden gebruikt voor vergelijking.
QueryResult	Resultaat van query. Het bevat alle kolommen die worden vermeld onder groeperingen en aggregatie.
QueryTimePeriod	De begin- en einddatum voor het ophalen van gegevens voor de query.
TimeframeType	Het tijdsbestek voor het ophalen van gegevens voor de query. Indien aangepast, moet een specifieke periode worden opgegeven.

ErrorDetails

De details van de fout.

Name	Type	Description
code	string	Foutcode.
message	string	Foutbericht waarin wordt aangegeven waarom de bewerking is mislukt.

ErrorResponse

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

Enkele foutberichten:

429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'x-ms-ratelimit-microsoft.consumption-retry-after'.
503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u net zolang hebt gewacht zoals aangegeven in de header 'Retry-After'.

Name	Type	Description
error	ErrorDetails	De details van de fout.

ExportType

Het type query.

Name	Type	Description
ActualCost	string
AmortizedCost	string
Usage	string

externalCloudProviderType

Het type externe cloudprovider dat is gekoppeld aan dimensie-/querybewerkingen. Dit omvat 'externalSubscriptions' voor een gekoppeld account en 'externalBillingAccounts' voor een geconsolideerd account.

Name	Type	Description
externalBillingAccounts	string
externalSubscriptions	string

FunctionType

De naam van de aggregatiefunctie die moet worden gebruikt.

Name	Type	Description
Sum	string

GranularityType

De granulariteit van rijen in de prognose.

Name	Type	Description
Daily	string

QueryAggregation

De aggregatie-expressie die in de query moet worden gebruikt.

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

QueryColumn

QueryColumn-eigenschappen

Name	Type	Description
name	string	De naam van de kolom.
type	string	Het type kolom.

QueryColumnType

Het type kolom in de export.

Name	Type	Description
Dimension	string	De dimensie van kostengegevens.
TagKey	string	De tag die is gekoppeld aan de kostengegevens.

QueryComparisonExpression

De vergelijkingsexpressie die in de query moet worden gebruikt.

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

QueryDataset

De definitie van gegevens die aanwezig zijn in de query.

Name	Type	Description
aggregation	<string, QueryAggregation>	Woordenlijst van de aggregatie-expressie die in de query moet worden gebruikt. De sleutel van elk item in de woordenlijst is de alias voor de samengevoegde kolom. Query kan maximaal 2 aggregatiecomponenten bevatten.
configuration	QueryDatasetConfiguration	Heeft configuratie-informatie voor de gegevens in de export. De configuratie wordt genegeerd als aggregatie en groepering zijn opgegeven.
filter	QueryFilter	De filterexpressie die in de query moet worden gebruikt. Raadpleeg onze Query API REST-documentatie voor informatie over het correct opmaken van het filter.
granularity	GranularityType	De granulariteit van rijen in de query.
grouping	QueryGrouping[]	Matrix van groeperen op expressie die in de query moet worden gebruikt. Query kan maximaal 2 group by-componenten hebben.

QueryDatasetConfiguration

De configuratie van de gegevensset in de query.

Name	Type	Description
columns	string[]	Matrix met kolomnamen die moeten worden opgenomen in de query. Elke geldige naam van de querykolom is toegestaan. Als deze niet is opgegeven, bevat de query alle kolommen.

QueryDefinition

De definitie van een query.

Name	Type	Description
dataset	QueryDataset	Heeft een definitie voor gegevens in deze query.
timePeriod	QueryTimePeriod	Heeft een tijdsperiode voor het ophalen van gegevens voor de query.
timeframe	TimeframeType	Het tijdsbestek voor het ophalen van gegevens voor de query. Indien aangepast, moet een specifieke periode worden opgegeven.
type	ExportType	Het type query.

QueryFilter

De filterexpressie die moet worden gebruikt in de export.

Name	Type	Description
and	QueryFilter[]	De logische 'AND'-expressie. Moet ten minste 2 items bevatten.
dimensions	QueryComparisonExpression	Heeft een vergelijkingsexpressie voor een dimensie
or	QueryFilter[]	De logische 'OR'-expressie. Moet ten minste 2 items bevatten.
tags	QueryComparisonExpression	Heeft een vergelijkingsexpressie voor een tag

QueryGrouping

De groeperen op expressie die in de query moet worden gebruikt.

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

QueryOperatorType

De operator die moet worden gebruikt voor vergelijking.

Name	Type	Description
In	string

QueryResult

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

Name	Type	Description
eTag	string	ETag van de resource.
id	string	Resource-id.
location	string	Locatie van de resource.
name	string	Resourcenaam.
properties.columns	QueryColumn[]	Matrix van kolommen
properties.nextLink	string	De koppeling (URL) naar de volgende pagina met resultaten.
properties.rows	Rows[]	Matrix van rijen
sku	string	SKU van de resource.
tags	object	Resourcetags.
type	string	Resourcetype.

QueryTimePeriod

De begin- en einddatum voor het ophalen van gegevens voor de query.

Name	Type	Description
from	string	De begindatum waaruit gegevens moeten worden opgehaald.
to	string	De einddatum waar gegevens naartoe moeten worden opgehaald.

TimeframeType

Het tijdsbestek voor het ophalen van gegevens voor de query. Indien aangepast, moet een specifieke periode worden opgegeven.

Name	Type	Description
BillingMonthToDate	string
Custom	string
MonthToDate	string
TheLastBillingMonth	string
TheLastMonth	string
WeekToDate	string

Delen via

Query - Usage By External Cloud Provider Type

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Scopes

Voorbeelden

ExternalBillingAccountQueryList

Sample Request

Sample Response

ExternalSubscriptionsQuery

Sample Request

Sample Response

Definities

ErrorDetails

ErrorResponse

ExportType

externalCloudProviderType

FunctionType

GranularityType

QueryAggregation

QueryColumn

QueryColumnType

QueryComparisonExpression

QueryDataset

QueryDatasetConfiguration

QueryDefinition

QueryFilter

QueryGrouping

QueryOperatorType

QueryResult

QueryTimePeriod

TimeframeType

Aanvullende resources