Benefit Recommendations - List

Référence

Service:: Cost Management

Version d'API:: 2024-08-01

Liste des recommandations relatives à l’achat d’un plan d’épargne.

GET https://management.azure.com/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations?api-version=2024-08-01

Avec des paramètres facultatifs:

GET https://management.azure.com/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations?$filter={$filter}&$orderby={$orderby}&$expand={$expand}&api-version=2024-08-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
billingScope	path	True	string	Étendue associée aux opérations de recommandation d’avantages. Cela inclut « /subscriptions/{subscriptionId} / » pour l’étendue de l’abonnement, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} » pour l’étendue du groupe de ressources, /providers/Microsoft.Billing/billingAccounts/{billingAccountId} pour l’étendue du contrat entreprise, et « /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} » pour l’étendue du profil de facturation
api-version	query	True	string	Version de l’API à utiliser pour cette opération.
$expand	query		string	Peut être utilisé pour développer les propriétés par : properties/usage, properties/allRecommendationDetails
$filter	query		string	Peut être utilisé pour filtrer benefitRecommendations par : propriétés/étendue avec les valeurs autorisées ['Single', 'Shared'] et la valeur par défaut 'Shared' ; et propriétés/lookBackPeriod avec les valeurs autorisées ['Last7Days', 'Last30Days', 'Last60Days'] et la valeur par défaut 'Last60Days' ; properties/term avec les valeurs autorisées ['P1Y', 'P3Y'] et la valeur par défaut 'P3Y' ; properties/subscriptionId ; properties/resourceGroup
$orderby	query		string	Peut être utilisé pour classer les recommandations par : properties/armSkuName. Pour le plan d’épargne, les résultats sont ordonnés par défaut. Il n’est pas nécessaire d’utiliser cette clause.

Réponses

Nom	Type	Description
200 OK	benefitRecommendationsListResult	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

BenefitRecommendationsBillingAccountList

Exemple de requête

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations?$filter=properties/lookBackPeriod eq 'Last7Days' AND properties/term eq 'P1Y'&$expand=properties/usage,properties/allRecommendationDetails&api-version=2024-08-01

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations/00000000-0000-0000-0000-000000000000",
      "name": "00000000-0000-0000-0000-000000000000",
      "type": "Microsoft.CostManagement/benefitRecommendations",
      "kind": "SavingsPlan",
      "properties": {
        "firstConsumptionDate": "2022-10-18T00:00:00Z",
        "lastConsumptionDate": "2022-10-25T00:00:00Z",
        "lookBackPeriod": "Last7Days",
        "totalHours": 168,
        "usage": {
          "usageGrain": "Hourly",
          "charges": [
            1,
            1,
            0,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            2,
            2,
            2,
            2
          ]
        },
        "armSkuName": "Compute_Savings_Plan",
        "term": "P1Y",
        "commitmentGranularity": "Hourly",
        "currencyCode": "USD",
        "costWithoutBenefit": 218.267,
        "scope": "Shared",
        "recommendationDetails": {
          "averageUtilizationPercentage": 99.33,
          "coveragePercentage": 54.609,
          "commitmentAmount": 0.164,
          "overageCost": 144.841,
          "benefitCost": 52.002,
          "savingsAmount": 21.424,
          "savingsPercentage": 9.815,
          "totalCost": 196.843,
          "wastageCost": 0.035
        },
        "allRecommendationDetails": {
          "value": [
            {
              "averageUtilizationPercentage": 99.33,
              "coveragePercentage": 54.609,
              "commitmentAmount": 0.164,
              "overageCost": 144.841,
              "benefitCost": 52.002,
              "savingsAmount": 21.424,
              "savingsPercentage": 9.815,
              "totalCost": 196.843,
              "wastageCost": 0.035
            },
            {
              "averageUtilizationPercentage": 81.474,
              "coveragePercentage": 56.748,
              "commitmentAmount": 0.161,
              "overageCost": 120.389,
              "benefitCost": 83.754,
              "savingsAmount": 14.124,
              "savingsPercentage": 6.47,
              "totalCost": 204.143,
              "wastageCost": 0.1
            }
          ]
        }
      }
    }
  ]
}

Définitions

Nom	Description
allSavingsBenefitDetails	Détails de la recommandation de l’avantage.
allSavingsList	Liste de toutes les recommandations relatives aux avantages avec les détails de la recommandation.
benefitKind	Réservation ou SavingsPlan.
benefitRecommendationModel	détails de la recommandation du plan d’avantages sociaux.
benefitRecommendationsListResult	Résultat de la liste des recommandations relatives aux avantages.
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 »
lookBackPeriod	Nombre de jours d’utilisation évalués pour le calcul des recommandations.
recommendationUsageDetails	Frais à la demande entre firstConsumptionDate et lastConsumptionDate qui ont été utilisés pour les recommandations d’avantages informatiques.
sharedScopeBenefitRecommendationProperties	Propriétés de la recommandation d’avantage lorsque l’étendue est « Partagée ».
singleScopeBenefitRecommendationProperties	Propriétés des recommandations relatives aux avantages lorsque l’étendue est « Unique ».
term	Période de durée de la prestation. Par exemple, P1Y ou P3Y.

allSavingsBenefitDetails

Détails de la recommandation de l’avantage.

Nom	Type	Description
averageUtilizationPercentage	number	Pourcentage d’utilisation moyen estimé pour le « totalHours » au cours de la période de recherche, avec cet engagement.
benefitCost	number	Coût estimé avec avantages pour le « totalHours » au cours de la période d’analyse. Il est égal à (engagementAmount * totalHours)
commitmentAmount	number	Montant de l’engagement à l’engagementGranularity.
coveragePercentage	number	Pourcentage estimé de couverture des prestations pour le « totalHours » au cours de la période de recherche, avec cet engagement.
overageCost	number	Différence entre le coût total et le coût des avantages pour le « totalHours » au cours de la période de recherche.
savingsAmount	number	Montant enregistré pour le « totalHours » au cours de la période de recherche, en achetant la quantité recommandée de l’avantage.
savingsPercentage	number	Les économies en pourcentage pour le « totalHours » dans la période de recherche, en achetant la quantité recommandée d’avantages.
totalCost	number	Coût total, qui est la somme du coût des avantages et du coût de dépassement.
wastageCost	number	Partie estimée inutilisée du « benefitCost ».

allSavingsList

Liste de toutes les recommandations relatives aux avantages avec les détails de la recommandation.

Nom	Type	Description
nextLink	string	Lien (URL) vers la page suivante des résultats.
value	allSavingsBenefitDetails[]	Liste des recommandations relatives aux avantages avec les détails de la recommandation..

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.

benefitRecommendationModel

détails de la recommandation du plan d’avantages sociaux.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	benefitKind	Réservation ou SavingsPlan.
name	string	Nom de la ressource
properties	benefitRecommendationProperties: sharedScopeBenefitRecommendationProperties singleScopeBenefitRecommendationProperties	Propriétés des recommandations relatives aux avantages.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

benefitRecommendationsListResult

Résultat de la liste des recommandations relatives aux avantages.

Nom	Type	Description
nextLink	string	Lien (URL) vers la page suivante des résultats.
value	benefitRecommendationModel[]	Liste des recommandations relatives aux avantages.

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.

lookBackPeriod

Nombre de jours d’utilisation évalués pour le calcul des recommandations.

Nom	Type	Description
Last30Days	string	30 jours utilisés pour revenir en arrière.
Last60Days	string	60 jours utilisés pour revenir en arrière.
Last7Days	string	7 jours utilisés pour revenir en arrière.

recommendationUsageDetails

Frais à la demande entre firstConsumptionDate et lastConsumptionDate qui ont été utilisés pour les recommandations d’avantages informatiques.

Nom	Type	Description
charges	number[]	Frais à la demande pour chaque heure entre firstConsumptionDate et lastConsumptionDate qui ont été utilisés pour les recommandations d’avantages informatiques.
usageGrain	grain	Grain de l’utilisation. Valeurs prises en charge : « Toutes les heures »

sharedScopeBenefitRecommendationProperties

Propriétés de la recommandation d’avantage lorsque l’étendue est « Partagée ».

Nom	Type	Description
allRecommendationDetails	allSavingsList	Liste de toutes les recommandations relatives aux avantages avec les détails de la recommandation.
armSkuName	string	Nom de la référence SKU ARM. 'Compute_Savings_Plan' pour SavingsPlan.
commitmentGranularity	grain	Grain du montant de l’engagement proposé. Valeurs prises en charge : « Toutes les heures »
costWithoutBenefit	number	Le coût actuel sans avantage correspond à « totalHours » au cours de la période de recherche.
currencyCode	string	Identificateur de code monétaire ISO 4217 pour les coûts et les montants d’économies.
firstConsumptionDate	string	La première date d’utilisation utilisée pour examiner les recommandations.
lastConsumptionDate	string	Dernière date d’utilisation utilisée pour examiner les recommandations.
lookBackPeriod	lookBackPeriod	Nombre de jours d’utilisation évalués pour le calcul des recommandations.
recommendationDetails	allSavingsBenefitDetails	Détails de la recommandation proposée.
scope	string: Shared	Étendue de l’avantage. Par exemple, Single ou Shared.
term	term	Période de durée de la prestation. Par exemple, P1Y ou P3Y.
totalHours	integer	Heures totales pour lesquelles le coût est couvert. Il est égal au nombre d’enregistrements d’une propriété « properties/usage/charges ».
usage	recommendationUsageDetails	Frais à la demande entre firstConsumptionDate et lastConsumptionDate qui ont été utilisés pour les recommandations d’avantages informatiques.

singleScopeBenefitRecommendationProperties

Propriétés des recommandations relatives aux avantages lorsque l’étendue est « Unique ».

Nom	Type	Description
allRecommendationDetails	allSavingsList	Liste de toutes les recommandations relatives aux avantages avec les détails de la recommandation.
armSkuName	string	Nom de la référence SKU ARM. 'Compute_Savings_Plan' pour SavingsPlan.
commitmentGranularity	grain	Grain du montant de l’engagement proposé. Valeurs prises en charge : « Toutes les heures »
costWithoutBenefit	number	Le coût actuel sans avantage correspond à « totalHours » au cours de la période de recherche.
currencyCode	string	Identificateur de code monétaire ISO 4217 pour les coûts et les montants d’économies.
firstConsumptionDate	string	La première date d’utilisation utilisée pour examiner les recommandations.
lastConsumptionDate	string	Dernière date d’utilisation utilisée pour examiner les recommandations.
lookBackPeriod	lookBackPeriod	Nombre de jours d’utilisation évalués pour le calcul des recommandations.
recommendationDetails	allSavingsBenefitDetails	Détails de la recommandation proposée.
resourceGroup	string	Groupe de ressources pour lequel cette recommandation d’étendue unique est destinée. Applicable uniquement si la recommandation concerne l’étendue « Unique » et l’étendue de requête « ResourceGroup ».
scope	string: Single	Étendue de l’avantage. Par exemple, Single ou Shared.
subscriptionId	string	ID d’abonnement pour lequel cette recommandation d’étendue unique est destinée. Applicable uniquement si la recommandation concerne l’étendue « Unique ».
term	term	Période de durée de la prestation. Par exemple, P1Y ou P3Y.
totalHours	integer	Heures totales pour lesquelles le coût est couvert. Il est égal au nombre d’enregistrements d’une propriété « properties/usage/charges ».
usage	recommendationUsageDetails	Frais à la demande entre firstConsumptionDate et lastConsumptionDate qui ont été utilisés pour les recommandations d’avantages informatiques.

term

Période de durée de la prestation. Par exemple, P1Y ou P3Y.

Nom	Type	Description
P1Y	string	La durée des prestations est de 1 an.
P3Y	string	La durée des prestations est de 3 ans.

Partager via