Generate Benefit Utilization Summaries Report - Generate By Billing Account

Référence

Service:: Cost Management

Version d'API:: 2024-08-01

Déclenche la génération d’un rapport de résumés d’utilisation des avantages pour le compte de facturation fourni. Cette API prend uniquement en charge les comptes d’inscription.

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
billingAccountId	path	True	string	ID du compte de facturation
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
endDate	True	string	Date de fin des données de résumé qui seront servies dans le rapport.
grain	True	grain	Le grain auquel les données de résumé sont servies dans le rapport. Les valeurs acceptées sont « Quotidien » ou « Mensuel ».
startDate	True	string	Date de début des données de résumé qui seront servies dans le rapport.
benefitId		string	L’ID de l’avantage est le rapport des résumés d’utilisation des avantages. Obligatoire pour l’étendue de l’ID d’avantage. Non pris en charge pour l’ordre des avantages ou les étendues de facturation.
benefitOrderId		string	Id de l’ordre des avantages pour lequel le rapport récapitulation de l’utilisation des avantages est destiné. Obligatoire pour les étendues de l’id d’avantage et de l’id d’avantage. Non pris en charge pour les étendues de facturation.
billingAccountId		string	Compte de facturation pour lequel le rapport des résumés d’utilisation des avantages est destiné. Obligatoire pour les étendues de compte de facturation et de profil de facturation. Non pris en charge pour les étendues d’avantages.
billingProfileId		string	Id de profil de facturation pour lequel le rapport des résumés d’utilisation des avantages est destiné. Obligatoire pour l’étendue du profil de facturation. Non pris en charge pour le compte de facturation ou les étendues d’avantages.
kind		benefitKind	Type de données d’avantage demandées. Obligatoire pour les étendues de compte de facturation et de profil de facturation. Implicite et ne pas être passée à des étendues d’avantages. Les valeurs prises en charge sont Reservation et SavingsPlan

Réponses

Nom	Type	Description
200 OK	BenefitUtilizationSummariesOperationStatus	État de la génération du rapport sur l’utilisation des avantages. Cela peut être en cours, en échec ou terminé.
202 Accepted		Accepté. La demande sera traitée. Utilisez l’en-tête d’emplacement pour vérifier l’état. En-têtes Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Nom

Type

Description

200 OK

BenefitUtilizationSummariesOperationStatus

État de la génération du rapport sur l’utilisation des avantages. Cela peut être en cours, en échec ou terminé.

202 Accepted

Accepté. La demande sera traitée. Utilisez l’en-tête d’emplacement pour vérifier l’état.

En-têtes

Location: string
Retry-After: integer

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

GenerateUtilizationSummariesReportByBillingAccount

Exemple de requête

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/8099099/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01

{
  "kind": "Reservation",
  "endDate": "2022-08-31T00:00:00Z",
  "startDate": "2022-06-01T00:00:00Z",
  "grain": "Daily"
}

Exemple de réponse

Code d’état:: 202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/8099099/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2024-08-01
Retry-After: 60

Code d’état:: 200

{
  "input": {
    "grain": "Daily",
    "billingAccountId": "8099099",
    "kind": "Reservation",
    "endDate": "2022-08-31T00:00:00Z",
    "startDate": "2022-06-01T00:00:00Z"
  },
  "status": "Complete",
  "properties": {
    "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "validUntil": "2022-06-12T02:56:55.5021869Z"
  }
}

Définitions

Nom	Description
AsyncOperationStatusProperties	Objet représentant l’URL du rapport et valide jusqu’à la date du rapport asynchrone généré.
benefitKind	Réservation ou SavingsPlan.
BenefitUtilizationSummariesOperationStatus	État d’un rapport sur l’utilisation des avantages. Fournit des résumés d’utilisation des avantages Async : entrée, état et URL de sas de rapport.
BenefitUtilizationSummariesRequest	Propriétés d’une demande de résumés d’utilisation des avantages asynchrones.
BenefitUtilizationSummaryReportSchema	Le fichier CSV du lien blob reportUrl et secondaryReportUrl se compose des colonnes suivantes des données d’utilisation des avantages. L’utilisation dePercentage sera 0 pour les rapports sur les plans d’épargne et les réservations de briques non de données. Les pourcentages d’utilisation seront 0 pour les réservations de briques de données.
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 requête 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 l’heure spécifiée dans l’en-tête « Retry-After ».
grain	Grain de l’utilisation. Valeurs prises en charge : « Toutes les heures »
OperationStatusType	État de la création du rapport de synthèse sur l’utilisation des avantages.

AsyncOperationStatusProperties

Objet représentant l’URL du rapport et valide jusqu’à la date du rapport asynchrone généré.

Nom	Type	Description
reportUrl	BenefitUtilizationSummaryReportSchema	URL sas du rapport des résumés d’utilisation des avantages asynchrones. Est vide si le rapport est en cours d’exécution ou en état d’échec.
secondaryReportUrl	BenefitUtilizationSummaryReportSchema	Url sas vers les résumés d’utilisation des avantages asynchrones dans le stockage secondaire en cas de panne principale. Est vide si le rapport est en cours d’exécution ou en état d’échec.
validUntil	string	Date à laquelle l’URL sas fournie dans reportUrl expire.

benefitKind

Réservation ou SavingsPlan.

Nom	Type	Description
IncludedQuantity	string	L’avantage est IncludedQuantity.
Reservation	string	L’avantage est Réservation.
SavingsPlan	string	L’avantage est SavingsPlan.

BenefitUtilizationSummariesOperationStatus

État d’un rapport sur l’utilisation des avantages. Fournit des résumés d’utilisation des avantages Async : entrée, état et URL de sas de rapport.

Nom	Type	Description
input	BenefitUtilizationSummariesRequest	Entrée donnée pour créer le rapport des résumés d’utilisation des avantages.
properties	AsyncOperationStatusProperties	Contient l’URL sas du rapport des résumés d’utilisation des avantages asynchrones et une date à laquelle l’URL est valide jusqu’à ce que l’URL soit valide. Ces valeurs sont vides si le rapport est dans un état en cours d’exécution ou d’échec
status	OperationStatusType	État de la création du rapport de synthèse sur l’utilisation des avantages.

BenefitUtilizationSummariesRequest

Propriétés d’une demande de résumés d’utilisation des avantages asynchrones.

Nom	Type	Description
benefitId	string	L’ID de l’avantage est le rapport des résumés d’utilisation des avantages. Obligatoire pour l’étendue de l’ID d’avantage. Non pris en charge pour l’ordre des avantages ou les étendues de facturation.
benefitOrderId	string	Id de l’ordre des avantages pour lequel le rapport récapitulation de l’utilisation des avantages est destiné. Obligatoire pour les étendues de l’id d’avantage et de l’id d’avantage. Non pris en charge pour les étendues de facturation.
billingAccountId	string	Compte de facturation pour lequel le rapport des résumés d’utilisation des avantages est destiné. Obligatoire pour les étendues de compte de facturation et de profil de facturation. Non pris en charge pour les étendues d’avantages.
billingProfileId	string	Id de profil de facturation pour lequel le rapport des résumés d’utilisation des avantages est destiné. Obligatoire pour l’étendue du profil de facturation. Non pris en charge pour le compte de facturation ou les étendues d’avantages.
endDate	string	Date de fin des données de résumé qui seront servies dans le rapport.
grain	grain	Le grain auquel les données de résumé sont servies dans le rapport. Les valeurs acceptées sont « Quotidien » ou « Mensuel ».
kind	benefitKind	Type de données d’avantage demandées. Obligatoire pour les étendues de compte de facturation et de profil de facturation. Implicite et ne pas être passée à des étendues d’avantages. Les valeurs prises en charge sont Reservation et SavingsPlan
startDate	string	Date de début des données de résumé qui seront servies dans le rapport.

BenefitUtilizationSummaryReportSchema

Le fichier CSV du lien blob reportUrl et secondaryReportUrl se compose des colonnes suivantes des données d’utilisation des avantages. L’utilisation dePercentage sera 0 pour les rapports sur les plans d’épargne et les réservations de briques non de données. Les pourcentages d’utilisation seront 0 pour les réservations de briques de données.

Nom	Type	Description
AvgUtilizationPercentage	string
BenefitId	string
BenefitOrderId	string
BenefitType	string
Kind	string
MaxUtilizationPercentage	string
MinUtilizationPercentage	string
UsageDate	string
UtilizedPercentage	string

ErrorDetails

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

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 requête 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 l’heure spécifiée dans l’en-tête « Retry-After ».

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

grain

Grain de l’utilisation. Valeurs prises en charge : « Toutes les heures »

Nom	Type	Description
Daily	string	Le grain horaire correspond à la valeur par jour.
Hourly	string	Le grain horaire correspond à la valeur par heure.
Monthly	string	Le grain horaire correspond à la valeur par mois.

OperationStatusType

État de la création du rapport de synthèse sur l’utilisation des avantages.

Nom	Type	Description
Complete	string
Failed	string
Running	string

Partager via

Generate Benefit Utilization Summaries Report - Generate By Billing Account

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

GenerateUtilizationSummariesReportByBillingAccount

Exemple de requête

Exemple de réponse

Définitions

AsyncOperationStatusProperties

benefitKind

BenefitUtilizationSummariesOperationStatus

BenefitUtilizationSummariesRequest

BenefitUtilizationSummaryReportSchema

ErrorDetails

ErrorResponse

grain

OperationStatusType

Ressources supplémentaires