Query Billing Account - Query Billing Account

Service:: Cost Management

Version d'API:: 2018-05-31

Répertorie les données d’utilisation du compte de facturation.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
billingAccountId	path	True	string	FacturationID de compte
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente. La version actuelle est 2018-05-31.

Corps de la demande

Nom	Obligatoire	Type	Description
timeframe	True	TimeframeType	Délai d’extraction des données pour le rapport. Si elle est personnalisée, une période spécifique doit être fournie.
type	True	ReportType	Type du rapport.
dataset		ReportConfigDataset	A la définition des données dans cette configuration de rapport.
timePeriod		ReportConfigTimePeriod	A la période d’extraction des données pour le rapport.

Réponses

Nom	Type	Description
200 OK	QueryResult	D’ACCORD. La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

BillingAccountQuery

Exemple de requête

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

Exemple de réponse

Code d’état:: 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
          ]
        ]
      }
    }
  ]
}

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.
FunctionType	Nom de la fonction d’agrégation à utiliser.
GranularityType	Granularité des lignes dans le rapport.
OperatorType	Opérateur à utiliser pour la comparaison.
Query
QueryColumn
QueryResult	Résultat de la requête. Elle contient toutes les colonnes répertoriées sous regroupements et agrégation.
ReportConfigAggregation	Expression d’agrégation à utiliser dans le rapport.
ReportConfigColumnType	Type de la colonne dans le rapport.
ReportConfigComparisonExpression	Expression de comparaison à utiliser dans le rapport.
ReportConfigDataset	Définition des données présentes dans le rapport.
ReportConfigDatasetConfiguration	Configuration du jeu de données dans le rapport.
ReportConfigDefinition	Définition d’une configuration de rapport.
ReportConfigFilter	Expression de filtre à utiliser dans le rapport.
ReportConfigGrouping	Groupe par expression à utiliser dans le rapport.
ReportConfigTimePeriod	Date de début et de fin de l’extraction des données pour le rapport.
ReportType	Type du rapport.
TimeframeType	Délai d’extraction des données pour le rapport. Si elle est personnalisée, une période spécifique doit être fournie.

ErrorDetails

Object

Détails de l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur indiquant pourquoi l’opération a échoué.

ErrorResponse

Object

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.

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

FunctionType

Énumération

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

Valeur	Description
Sum

GranularityType

Énumération

Granularité des lignes dans le rapport.

Valeur	Description
Daily

OperatorType

Énumération

Opérateur à utiliser pour la comparaison.

Valeur	Description
In

Query

Object

Nom	Type	Description
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.columns	QueryColumn[]	Tableau de colonnes
properties.nextLink	string
properties.rows	Rows[]
tags	object	Balises de ressource.
type	string	Type de ressource.

QueryColumn

Object

Nom	Type	Description
name	string
type	string

QueryResult

Object

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

Nom	Type	Description
value	Query[]	Liste des données d’utilisation.

ReportConfigAggregation

Object

Expression d’agrégation à utiliser dans le rapport.

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

ReportConfigColumnType

Énumération

Type de la colonne dans le rapport.

Valeur	Description
Tag
Dimension

ReportConfigComparisonExpression

Object

Expression de comparaison à utiliser dans le rapport.

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

ReportConfigDataset

Object

Définition des données présentes dans le rapport.

Nom	Type	Description
aggregation	<string, ReportConfigAggregation>	Dictionnaire d’expression d’agrégation à utiliser dans le rapport. La clé de chaque élément du dictionnaire est l’alias de la colonne agrégée. Le rapport peut avoir jusqu’à 2 clauses d’agrégation.
configuration	ReportConfigDatasetConfiguration	Contient des informations de configuration pour les données du rapport. La configuration est ignorée si l’agrégation et le regroupement sont fournis.
filter	ReportConfigFilter	A l’expression de filtre à utiliser dans le rapport.
granularity	GranularityType	Granularité des lignes dans le rapport.
grouping	ReportConfigGrouping[]	Tableau de groupes par expression à utiliser dans le rapport. Le rapport peut comporter jusqu’à 2 clauses group by.

ReportConfigDatasetConfiguration

Object

Configuration du jeu de données dans le rapport.

Nom	Type	Description
columns	string[]	Tableau de noms de colonnes à inclure dans le rapport. Tout nom de colonne de rapport valide est autorisé. S’il n’est pas fourni, le rapport inclut toutes les colonnes.

ReportConfigDefinition

Object

Définition d’une configuration de rapport.

Nom	Type	Description
dataset	ReportConfigDataset	A la définition des données dans cette configuration de rapport.
timePeriod	ReportConfigTimePeriod	A la période d’extraction des données pour le rapport.
timeframe	TimeframeType	Délai d’extraction des données pour le rapport. Si elle est personnalisée, une période spécifique doit être fournie.
type	ReportType	Type du rapport.

ReportConfigFilter

Object

Expression de filtre à utiliser dans le rapport.

Nom	Type	Description
and	ReportConfigFilter[]	Expression logique « AND ». Doit avoir au moins 2 éléments.
dimension	ReportConfigComparisonExpression	A une expression de comparaison pour une dimension
not	ReportConfigFilter	Expression logique « NOT ».
or	ReportConfigFilter[]	Expression logique « OR ». Doit avoir au moins 2 éléments.
tag	ReportConfigComparisonExpression	A une expression de comparaison pour une balise

ReportConfigGrouping

Object

Groupe par expression à utiliser dans le rapport.

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

ReportConfigTimePeriod

Object

Date de début et de fin de l’extraction des données pour le rapport.

Nom	Type	Description
from	string (date-time)	Date de début à partir de laquelle extraire des données.
to	string (date-time)	Date de fin vers laquelle extraire des données.

ReportType

Énumération

Type du rapport.

Valeur	Description
Usage

TimeframeType

Énumération

Délai d’extraction des données pour le rapport. Si elle est personnalisée, une période spécifique doit être fournie.

Valeur	Description
WeekToDate
MonthToDate
YearToDate
Custom

Partager via

Query Billing Account - Query Billing Account

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

BillingAccountQuery

Exemple de requête

Exemple de réponse

Définitions

ErrorDetails

ErrorResponse

FunctionType

GranularityType

OperatorType

Query

QueryColumn

QueryResult

ReportConfigAggregation

ReportConfigColumnType

ReportConfigComparisonExpression

ReportConfigDataset

ReportConfigDatasetConfiguration

ReportConfigDefinition

ReportConfigFilter

ReportConfigGrouping

ReportConfigTimePeriod

ReportType

TimeframeType