Benefit Recommendations - List

Referencia

Servicio:: Cost Management

Versión de la API:: 2024-08-01

Lista de recomendaciones para comprar un plan de ahorro.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
billingScope	path	True	string	Ámbito asociado a las operaciones de recomendación de ventajas. Esto incluye '/subscriptions/{subscriptionId}/' para el ámbito de la suscripción, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para el ámbito del grupo de recursos, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para el ámbito del contrato enterprise y '/providers/Microsoft.BillingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para el ámbito del perfil de facturación.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.
$expand	query		string	Puede usarse para expandir las propiedades por: properties/usage, properties/allRecommendationDetails
$filter	query		string	Se puede usar para filtrar benefitRecommendations por: propiedades o ámbito con valores permitidos ['Single', 'Shared'] y el valor predeterminado 'Shared'; y properties/lookBackPeriod con valores permitidos ['Last7Days', 'Last30Days', 'Last60Days'] y el valor predeterminado 'Last60Days'; properties/term con valores permitidos ['P1Y', 'P3Y'] y el valor predeterminado 'P3Y'; properties/subscriptionId; properties/resourceGroup
$orderby	query		string	Puede usarse para ordenar las recomendaciones por: properties/armSkuName. Para el plan de ahorro, los resultados están ordenados de forma predeterminada. No es necesario usar esta cláusula.

Respuestas

Nombre	Tipo	Description
200 OK	benefitRecommendationsListResult	De acuerdo. La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

BenefitRecommendationsBillingAccountList

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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
            }
          ]
        }
      }
    }
  ]
}

Definiciones

Nombre	Description
allSavingsBenefitDetails	Detalles de la recomendación de la ventaja.
allSavingsList	Lista de todas las recomendaciones de beneficios con los detalles de la recomendación.
benefitKind	Reserva o Plan de ahorro.
benefitRecommendationModel	detalles de la recomendación del plan de beneficios.
benefitRecommendationsListResult	Resultado de enumerar recomendaciones de ventajas.
ErrorDetails	Detalles del error.
ErrorResponse	La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error. Algunas respuestas de error: 429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Retry-After".
grain	El grano del uso. Valores admitidos: "Hourly"
lookBackPeriod	Número de días de uso evaluados para calcular las recomendaciones.
recommendationUsageDetails	Cargos a petición entre firstConsumptionDate y lastConsumptionDate que se usaron para las recomendaciones de ventajas informáticas.
sharedScopeBenefitRecommendationProperties	Las propiedades de la recomendación de ventaja cuando el ámbito es "Compartido".
singleScopeBenefitRecommendationProperties	Las propiedades de las recomendaciones de ventajas cuando el ámbito es "Single".
term	Período de período de la ventaja. Por ejemplo, P1Y o P3Y.

allSavingsBenefitDetails

Detalles de la recomendación de la ventaja.

Nombre	Tipo	Description
averageUtilizationPercentage	number	Porcentaje de uso promedio estimado para el "totalHours" en el período de búsqueda, con este compromiso.
benefitCost	number	Costo estimado con beneficio para el "totalHours" en el período de búsqueda. Es igual a (compromisoAmount * totalHours)
commitmentAmount	number	Importe del compromiso en el compromisoGranularity.
coveragePercentage	number	Porcentaje estimado de cobertura de beneficios para el "totalHours" en el período de búsqueda, con este compromiso.
overageCost	number	La diferencia entre el costo total y el costo de beneficios para el "totalHours" en el período de búsqueda.
savingsAmount	number	La cantidad guardada para el "totalHours" en el período de búsqueda, mediante la compra de la cantidad recomendada de la ventaja.
savingsPercentage	number	El ahorro en porcentaje para el "totalHours" en el período de búsqueda, mediante la compra de la cantidad recomendada de beneficio.
totalCost	number	Costo total, que es la suma del costo de beneficio y el costo por encima del límite.
wastageCost	number	Parte estimada sin usar de "benefitCost".

allSavingsList

Lista de todas las recomendaciones de beneficios con los detalles de la recomendación.

Nombre	Tipo	Description
nextLink	string	Vínculo (DIRECCIÓN URL) a la página siguiente de resultados.
value	allSavingsBenefitDetails[]	Lista de recomendaciones de ventajas con los detalles de la recomendación.

benefitKind

Reserva o Plan de ahorro.

Nombre	Tipo	Description
IncludedQuantity	string	La ventaja es IncludedQuantity.
Reservation	string	La ventaja es Reserva.
SavingsPlan	string	La ventaja es SavingsPlan.

benefitRecommendationModel

detalles de la recomendación del plan de beneficios.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	benefitKind	Reserva o Plan de ahorro.
name	string	Nombre del recurso
properties	benefitRecommendationProperties: sharedScopeBenefitRecommendationProperties singleScopeBenefitRecommendationProperties	Las propiedades de las recomendaciones de ventajas.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

benefitRecommendationsListResult

Resultado de enumerar recomendaciones de ventajas.

Nombre	Tipo	Description
nextLink	string	Vínculo (DIRECCIÓN URL) a la página siguiente de resultados.
value	benefitRecommendationModel[]	Lista de recomendaciones de ventajas.

ErrorDetails

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

ErrorResponse

La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Algunas respuestas de error:

429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Retry-After".

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error.

grain

El grano del uso. Valores admitidos: "Hourly"

Nombre	Tipo	Description
Daily	string	El grano por hora corresponde al valor por día.
Hourly	string	El grano por hora corresponde al valor por hora.
Monthly	string	El grano por hora corresponde al valor al mes.

lookBackPeriod

Número de días de uso evaluados para calcular las recomendaciones.

Nombre	Tipo	Description
Last30Days	string	30 días usados para mirar hacia atrás.
Last60Days	string	60 días usados para mirar hacia atrás.
Last7Days	string	7 días usados para mirar hacia atrás.

recommendationUsageDetails

Cargos a petición entre firstConsumptionDate y lastConsumptionDate que se usaron para las recomendaciones de ventajas informáticas.

Nombre	Tipo	Description
charges	number[]	Cargos a petición por cada hora entre firstConsumptionDate y lastConsumptionDate que se usaron para las recomendaciones de ventajas informáticas.
usageGrain	grain	El grano del uso. Valores admitidos: "Hourly"

sharedScopeBenefitRecommendationProperties

Las propiedades de la recomendación de ventaja cuando el ámbito es "Compartido".

Nombre	Tipo	Description
allRecommendationDetails	allSavingsList	Lista de todas las recomendaciones de beneficios con los detalles de la recomendación.
armSkuName	string	Nombre de la SKU de ARM. "Compute_Savings_Plan" para SavingsPlan.
commitmentGranularity	grain	Grano del importe del compromiso propuesto. Valores admitidos: "Hourly"
costWithoutBenefit	number	El costo actual sin beneficio corresponde a "totalHours" en el período de búsqueda.
currencyCode	string	Identificador de código de moneda ISO 4217 para los costos y los importes de ahorro.
firstConsumptionDate	string	La primera fecha de uso utilizada para buscar la computación de las recomendaciones.
lastConsumptionDate	string	La fecha de último uso utilizada para buscar la computación de las recomendaciones.
lookBackPeriod	lookBackPeriod	Número de días de uso evaluados para calcular las recomendaciones.
recommendationDetails	allSavingsBenefitDetails	Detalles de la recomendación propuesta.
scope	string: Shared	Ámbito de la ventaja. Por ejemplo, Single o Shared.
term	term	Período de período de la ventaja. Por ejemplo, P1Y o P3Y.
totalHours	integer	El total de horas para las que se cubre el costo. Es igual al número de registros de una propiedad "properties/usage/charges".
usage	recommendationUsageDetails	Cargos a petición entre firstConsumptionDate y lastConsumptionDate que se usaron para las recomendaciones de ventajas informáticas.

singleScopeBenefitRecommendationProperties

Las propiedades de las recomendaciones de ventajas cuando el ámbito es "Single".

Nombre	Tipo	Description
allRecommendationDetails	allSavingsList	Lista de todas las recomendaciones de beneficios con los detalles de la recomendación.
armSkuName	string	Nombre de la SKU de ARM. "Compute_Savings_Plan" para SavingsPlan.
commitmentGranularity	grain	Grano del importe del compromiso propuesto. Valores admitidos: "Hourly"
costWithoutBenefit	number	El costo actual sin beneficio corresponde a "totalHours" en el período de búsqueda.
currencyCode	string	Identificador de código de moneda ISO 4217 para los costos y los importes de ahorro.
firstConsumptionDate	string	La primera fecha de uso utilizada para buscar la computación de las recomendaciones.
lastConsumptionDate	string	La fecha de último uso utilizada para buscar la computación de las recomendaciones.
lookBackPeriod	lookBackPeriod	Número de días de uso evaluados para calcular las recomendaciones.
recommendationDetails	allSavingsBenefitDetails	Detalles de la recomendación propuesta.
resourceGroup	string	El grupo de recursos para el que está destinada esta recomendación de ámbito único. Solo se aplica si la recomendación es para el ámbito "Single" y el ámbito de solicitud "ResourceGroup".
scope	string: Single	Ámbito de la ventaja. Por ejemplo, Single o Shared.
subscriptionId	string	Identificador de suscripción para el que es esta recomendación de ámbito único. Solo se aplica si la recomendación es para el ámbito "Único".
term	term	Período de período de la ventaja. Por ejemplo, P1Y o P3Y.
totalHours	integer	El total de horas para las que se cubre el costo. Es igual al número de registros de una propiedad "properties/usage/charges".
usage	recommendationUsageDetails	Cargos a petición entre firstConsumptionDate y lastConsumptionDate que se usaron para las recomendaciones de ventajas informáticas.

term

Período de período de la ventaja. Por ejemplo, P1Y o P3Y.

Nombre	Tipo	Description
P1Y	string	El período de beneficios es de 1 año.
P3Y	string	El período de beneficios es de 3 años.

Compartir a través de