Query - Usage By External Cloud Provider Type

Référence

Service:: Cost Management

API Version:: 2023-11-01

Interrogez les données d’utilisation pour le type de fournisseur de cloud externe défini.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
externalCloudProviderId	path	True	string	Il peut s’agir de « {externalSubscriptionId} » pour le compte lié ou de « {externalBillingAccountId} » pour le compte consolidé utilisé avec des opérations de dimension/de requête.
externalCloudProviderType	path	True	externalCloudProviderType	Type de fournisseur de cloud externe associé aux opérations de dimension/requête. Cela inclut « externalSubscriptions » pour le compte lié et « externalBillingAccounts » pour le compte consolidé.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
dataset	True	QueryDataset	A une définition pour les données de cette requête.
timeframe	True	TimeframeType	Délai d’extraction des données pour la requête. S’il est personnalisé, une période spécifique doit être fournie.
type	True	ExportType	Type de la requête.
timePeriod		QueryTimePeriod	Dispose d’une période d’extraction des données pour la requête.

Réponses

Nom	Type	Description
200 OK	QueryResult	OK. La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom	Description
ErrorDetails	Détails de l’erreur.
ErrorResponse	La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur. Réponses d’erreur : 429 TooManyRequests : la demande est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « x-ms-ratelimit-microsoft.consumption-retry-after ». 503 ServiceUnavailable : le service est temporairement indisponible. Réessayez après avoir attendu le temps spécifié dans l’en-tête « Retry-After ».
ExportType	Type de la requête.
externalCloudProviderType	Type de fournisseur de cloud externe associé aux opérations de dimension/requête. Cela inclut « externalSubscriptions » pour le compte lié et « externalBillingAccounts » pour le compte consolidé.
FunctionType	Nom de la fonction d’agrégation à utiliser.
GranularityType	Granularité des lignes dans la prévision.
QueryAggregation	Expression d’agrégation à utiliser dans la requête.
QueryColumn	Propriétés QueryColumn
QueryColumnType	Type de la colonne dans l’exportation.
QueryComparisonExpression	Expression de comparaison à utiliser dans la requête.
QueryDataset	Définition des données présentes dans la requête.
QueryDatasetConfiguration	Configuration du jeu de données dans la requête.
QueryDefinition	Définition d’une requête.
QueryFilter	Expression de filtre à utiliser dans l’exportation.
QueryGrouping	Groupe par expression à utiliser dans la requête.
QueryOperatorType	Opérateur à utiliser pour la comparaison.
QueryResult	Résultat de la requête. Il contient toutes les colonnes répertoriées sous regroupements et agrégations.
QueryTimePeriod	Date de début et de fin de l’extraction des données pour la requête.
TimeframeType	Délai d’extraction des données pour la requête. S’il est personnalisé, une période spécifique doit être fournie.

ErrorDetails

Détails de l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.

ErrorResponse

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Réponses d’erreur :

429 TooManyRequests : la demande est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « x-ms-ratelimit-microsoft.consumption-retry-after ».
503 ServiceUnavailable : le service est temporairement indisponible. Réessayez après avoir attendu le temps spécifié dans l’en-tête « Retry-After ».

Nom	Type	Description
error	ErrorDetails	Détails de l’erreur.

ExportType

Type de la requête.

Nom	Type	Description
ActualCost	string
AmortizedCost	string
Usage	string

externalCloudProviderType

Type de fournisseur de cloud externe associé aux opérations de dimension/requête. Cela inclut « externalSubscriptions » pour le compte lié et « externalBillingAccounts » pour le compte consolidé.

Nom	Type	Description
externalBillingAccounts	string
externalSubscriptions	string

FunctionType

Nom de la fonction d’agrégation à utiliser.

Nom	Type	Description
Sum	string

GranularityType

Granularité des lignes dans la prévision.

Nom	Type	Description
Daily	string

QueryAggregation

Expression d’agrégation à utiliser dans la requête.

Nom	Type	Description
function	FunctionType	Nom de la fonction d’agrégation à utiliser.
name	string	Nom de la colonne à agréger.

QueryColumn

Propriétés QueryColumn

Nom	Type	Description
name	string	Nom de la colonne.
type	string	Type de colonne.

QueryColumnType

Type de la colonne dans l’exportation.

Nom	Type	Description
Dimension	string	Dimension des données de coût.
TagKey	string	Balise associée aux données de coût.

QueryComparisonExpression

Expression de comparaison à utiliser dans la requête.

Nom	Type	Description
name	string	Nom de la colonne à utiliser en comparaison.
operator	QueryOperatorType	Opérateur à utiliser pour la comparaison.
values	string[]	Tableau de valeurs à utiliser pour la comparaison

QueryDataset

Définition des données présentes dans la requête.

Nom	Type	Description
aggregation	<string, QueryAggregation>	Dictionnaire d’expression d’agrégation à utiliser dans la requête. La clé de chaque élément du dictionnaire est l’alias de la colonne agrégée. La requête peut avoir jusqu’à 2 clauses d’agrégation.
configuration	QueryDatasetConfiguration	Contient des informations de configuration pour les données dans l’exportation. La configuration sera ignorée si l’agrégation et le regroupement sont fournis.
filter	QueryFilter	Expression de filtre à utiliser dans la requête. Reportez-vous à notre documentation REST de l’API de requête pour savoir comment mettre correctement en forme le filtre.
granularity	GranularityType	Granularité des lignes dans la requête.
grouping	QueryGrouping[]	Tableau de groupe par expression à utiliser dans la requête. La requête peut avoir jusqu’à 2 clauses group by.

QueryDatasetConfiguration

Configuration du jeu de données dans la requête.

Nom	Type	Description
columns	string[]	Tableau de noms de colonnes à inclure dans la requête. Tout nom de colonne de requête valide est autorisé. Si elle n’est pas fournie, la requête inclut toutes les colonnes.

QueryDefinition

Définition d’une requête.

Nom	Type	Description
dataset	QueryDataset	A une définition pour les données de cette requête.
timePeriod	QueryTimePeriod	Dispose d’une période d’extraction des données pour la requête.
timeframe	TimeframeType	Délai d’extraction des données pour la requête. S’il est personnalisé, une période spécifique doit être fournie.
type	ExportType	Type de la requête.

QueryFilter

Expression de filtre à utiliser dans l’exportation.

Nom	Type	Description
and	QueryFilter[]	Expression logique « AND ». Doit avoir au moins 2 éléments.
dimensions	QueryComparisonExpression	A une expression de comparaison pour une dimension
or	QueryFilter[]	Expression « OR » logique. Doit avoir au moins 2 éléments.
tags	QueryComparisonExpression	A une expression de comparaison pour une balise

QueryGrouping

Groupe par expression à utiliser dans la requête.

Nom	Type	Description
name	string	Nom de la colonne à regrouper.
type	QueryColumnType	A le type de la colonne à regrouper.

QueryOperatorType

Opérateur à utiliser pour la comparaison.

Nom	Type	Description
In	string

QueryResult

Résultat de la requête. Il contient toutes les colonnes répertoriées sous regroupements et agrégations.

Nom	Type	Description
eTag	string	ETag de la ressource.
id	string	ID de ressource.
location	string	Emplacement de la ressource.
name	string	Nom de la ressource.
properties.columns	QueryColumn[]	Tableau de colonnes
properties.nextLink	string	Lien (URL) vers la page de résultats suivante.
properties.rows	Rows[]	Tableau de lignes
sku	string	Référence SKU de la ressource.
tags	object	Balises de ressource.
type	string	Type de ressource.

QueryTimePeriod

Date de début et de fin de l’extraction des données pour la requête.

Nom	Type	Description
from	string	Date de début à partir de laquelle extraire des données.
to	string	Date de fin vers laquelle extraire les données.

TimeframeType

Délai d’extraction des données pour la requête. S’il est personnalisé, une période spécifique doit être fournie.

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

Partager via

Query - Usage By External Cloud Provider Type

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Scopes

Exemples

ExternalBillingAccountQueryList

Sample Request

Sample Response

ExternalSubscriptionsQuery

Sample Request

Sample Response

Définitions

ErrorDetails

ErrorResponse

ExportType

externalCloudProviderType

FunctionType

GranularityType

QueryAggregation

QueryColumn

QueryColumnType

QueryComparisonExpression

QueryDataset

QueryDatasetConfiguration

QueryDefinition

QueryFilter

QueryGrouping

QueryOperatorType

QueryResult

QueryTimePeriod

TimeframeType

Ressources supplémentaires