Partager via


Generate Benefit Utilization Summaries Report - Generate By Savings Plan Id

Déclenche la génération d’un rapport de résumé de l’utilisation des avantages pour le plan d’économies fourni.

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2023-11-01

Paramètres URI

Nom Dans Obligatoire Type Description
savingsPlanId
path True

string

ID du plan d’économies.

savingsPlanOrderId
path True

string

ID de commande du plan d’économies.

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 résumées qui seront servies dans le rapport.

grain True

grain

Grain sur lequel les données des résumés sont servies dans le rapport. Les valeurs acceptées sont « Daily » ou « Monthly ».

startDate True

string

Date de début des données de résumé qui seront servies dans le rapport.

benefitId

string

Id d’avantage pour lequel le rapport des résumés de l’utilisation des avantages est destiné. Obligatoire pour l’étendue de l’ID d’avantage. Non pris en charge pour les commandes d’avantages ou les étendues de facturation.

benefitOrderId

string

Id de l’ordre des avantages pour lequel le rapport des résumés d’utilisation des avantages est destiné. Obligatoire pour les étendues d’ordre des avantages et d’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 passer aux portées des avantages. Les valeurs prises en charge sont Reservation et SavingsPlan

Réponses

Nom Type Description
200 OK

BenefitUtilizationSummariesOperationStatus

La status de la génération du rapport récapitulatif de l’utilisation des avantages. Cela peut être en cours, échoué ou terminé.

202 Accepted

Accepté. La demande sera traitée. Utilisez l’en-tête location pour case activée le status.

En-têtes

  • Location: string
  • Retry-After: integer
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
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

GenerateUtilizationSummariesReportBySavingsPlan

Exemple de requête

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2023-11-01

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

Exemple de réponse

Location: https://management.azure.com/providers/Microsoft.Capacity/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2023-11-01
Retry-After: 60
{
  "input": {
    "grain": "Daily",
    "benefitOrderId": "00000000-0000-0000-0000-000000000000",
    "benefitId": "00000000-0000-0000-0000-000000000000",
    "kind": "SavingsPlan",
    "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

Reservation ou SavingsPlan.

BenefitUtilizationSummariesOperationStatus

État d’un rapport de résumés d’utilisation des avantages. Fournit une entrée de demande, des status et une URL sas de rapport pour les résumés d’utilisation des avantages asynchrones.

BenefitUtilizationSummariesRequest

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

BenefitUtilizationSummaryReportSchema

Le fichier CSV du lien d’objet blob reportUrl et secondaryReportUrl se compose des colonnes suivantes des données d’utilisation des avantages. UtiliséPercentage sera de 0 pour les rapports de plans d’économies et les réservations de briques non de données. Les pourcentages d’utilisation seront de 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.

Quelques 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 ».

grain

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

OperationStatusType

La status de la création du rapport récapitulatif de 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 vers le rapport de résumés d’utilisation des avantages asynchrones. Sera vide si le rapport est à l’état En cours d’exécution ou Échec.

secondaryReportUrl

BenefitUtilizationSummaryReportSchema

L’URL sas vers les résumés d’utilisation des avantages asynchrones rapport dans le stockage secondaire en cas de panne principale. Sera vide si le rapport est à l’état En cours d’exécution ou Échec.

validUntil

string

Date d’expiration de l’URL sas fournie dans reportUrl.

benefitKind

Reservation 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 de résumés d’utilisation des avantages. Fournit une entrée de demande, des status et une URL sas de rapport pour les résumés d’utilisation des avantages asynchrones.

Nom Type Description
input

BenefitUtilizationSummariesRequest

Entrée donnée pour créer le rapport de résumés de l’utilisation des avantages.

properties

AsyncOperationStatusProperties

Contient l’URL sas vers le rapport de résumés d’utilisation des avantages asynchrones et une date à laquelle l’URL est valide jusqu’à. Ces valeurs seront vides si le rapport est à l’état En cours d’exécution ou Échec

status

OperationStatusType

La status de la création du rapport récapitulatif de 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

Id d’avantage pour lequel le rapport des résumés de l’utilisation des avantages est destiné. Obligatoire pour l’étendue de l’ID d’avantage. Non pris en charge pour les commandes d’avantages ou les étendues de facturation.

benefitOrderId

string

Id de l’ordre des avantages pour lequel le rapport des résumés d’utilisation des avantages est destiné. Obligatoire pour les étendues d’ordre des avantages et d’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 résumées qui seront servies dans le rapport.

grain

grain

Grain sur lequel les données des résumés sont servies dans le rapport. Les valeurs acceptées sont « Daily » ou « Monthly ».

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 passer aux portées des 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 d’objet blob reportUrl et secondaryReportUrl se compose des colonnes suivantes des données d’utilisation des avantages. UtiliséPercentage sera de 0 pour les rapports de plans d’économies et les réservations de briques non de données. Les pourcentages d’utilisation seront de 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 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.

Quelques 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.

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

La status de la création du rapport récapitulatif de l’utilisation des avantages.

Nom Type Description
Complete

string

Failed

string

Running

string