Benefit Recommendations - List

  • Referência
Serviço:
Cost Management
Versão da API:
2024-08-01

Lista de recomendações para o plano de poupança de compra.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
billingScope
 path True

string

O escopo associado às operações de recomendação de benefício. Isso inclui '/subscriptions/{subscriptionId}/' para o escopo da assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para o escopo do grupo de recursos, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para o escopo do contrato empresarial e '/providers/Microsoft.Billing/billingAccountId/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo do perfil de cobrança
api-version
 query True

string

A versão da API a ser usada para esta operação.
$expand
 query

string

Pode ser usado para expandir as propriedades por: propriedades/uso, propriedades/allRecommendationDetails
$filter
 query

string

Pode ser usado para filtrar benefitRecommendations por: propriedades/escopo com valores permitidos ['Single', 'Shared'] e valor padrão 'Shared'; e properties/lookBackPeriod com valores permitidos ['Last7Days', 'Last30Days', 'Last60Days'] e o valor padrão 'Last60Days'; properties/term with allowed values ['P1Y', 'P3Y'] and default value 'P3Y'; properties/subscriptionId; properties/resourceGroup
$orderby
 query

string

Pode ser usado para ordenar as recomendações por: properties/armSkuName. Para o plano de poupança, os resultados estão em ordem por padrão. Não é necessário usar essa cláusula.

Respostas

Nome Tipo Description
200 OK

benefitRecommendationsListResult

OKEY. A solicitação foi bem-sucedida.
Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

BenefitRecommendationsBillingAccountList

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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
            }
          ]
        }
      }
    }
  ]
}

Definições

Nome Description
allSavingsBenefitDetails

Detalhes da recomendação do benefício.
allSavingsList

A lista de todas as recomendações de benefício com os detalhes da recomendação.
benefitKind

Reserva ou SavingsPlan.
benefitRecommendationModel

detalhes da recomendação do plano de benefícios.
benefitRecommendationsListResult

Resultado da listagem de recomendações de benefícios.
ErrorDetails

Os detalhes do erro.
ErrorResponse

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Algumas respostas de erro:

  • 429 TooManyRequests – A solicitação é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".
grain

O grão do uso. Valores com suporte: 'Por hora'
lookBackPeriod

O número de dias de uso avaliado para calcular as recomendações.
recommendationUsageDetails

Encargos sob demanda entre firstConsumptionDate e lastConsumptionDate que foram usados para recomendações de benefício de computação.
sharedScopeBenefitRecommendationProperties

As propriedades da recomendação de benefício quando o escopo é 'Compartilhado'.
singleScopeBenefitRecommendationProperties

As propriedades das recomendações de benefício quando o escopo é 'Single'.
term

Período de prazo do benefício. Por exemplo, P1Y ou P3Y.

allSavingsBenefitDetails

Detalhes da recomendação do benefício.

Nome Tipo Description
averageUtilizationPercentage

number

Percentual de utilização média estimado para os 'totalHours' no período de pesquisa, com esse compromisso.
benefitCost

number

O custo estimado com benefício para os 'totalHours' no período de pesquisa. É igual a (commitmentAmount * totalHours)
commitmentAmount

number

O valor do compromisso no commitmentGranularity.
coveragePercentage

number

Percentual estimado de cobertura de benefícios para 'totalHours' no período de pesquisa, com esse compromisso.
overageCost

number

A diferença entre o custo total e o custo de benefício para os 'totalHours' no período de pesquisa.
savingsAmount

number

O valor economizado para os 'totalHours' no período de pesquisa, comprando a quantidade recomendada do benefício.
savingsPercentage

number

A economia em porcentagem para os 'totalHours' no período de pesquisa, comprando a quantidade recomendada de benefício.
totalCost

number

Custo total, que é a soma do custo do benefício e do custo excedente.
wastageCost

number

Parte não usada estimada do 'benefitCost'.

allSavingsList

A lista de todas as recomendações de benefício com os detalhes da recomendação.

Nome Tipo Description
nextLink

string

O link (URL) para a próxima página de resultados.
value

allSavingsBenefitDetails[]

A lista de recomendações de benefícios com os detalhes da recomendação..

benefitKind

Reserva ou SavingsPlan.

Nome Tipo Description
IncludedQuantity

string

O benefício é IncludedQuantity.
Reservation

string

O benefício é Reserva.
SavingsPlan

string

O benefício é o SavingsPlan.

benefitRecommendationModel

detalhes da recomendação do plano de benefícios.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

benefitKind

Reserva ou SavingsPlan.
name

string

O nome do recurso
properties benefitRecommendationProperties:

As propriedades das recomendações de benefício.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

benefitRecommendationsListResult

Resultado da listagem de recomendações de benefícios.

Nome Tipo Description
nextLink

string

O link (URL) para a próxima página de resultados.
value

benefitRecommendationModel[]

A lista de recomendações de benefícios.

ErrorDetails

Os detalhes do erro.

Nome Tipo Description
code

string

Código de erro.
message

string

Mensagem de erro indicando por que a operação falhou.

ErrorResponse

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Algumas respostas de erro:

  • 429 TooManyRequests – A solicitação é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".

Nome Tipo Description
error

ErrorDetails

Os detalhes do erro.

grain

O grão do uso. Valores com suporte: 'Por hora'

Nome Tipo Description
Daily

string

A granulação por hora corresponde ao valor por dia.
Hourly

string

A granulação por hora corresponde ao valor por hora.
Monthly

string

A granulação por hora corresponde ao valor por mês.

lookBackPeriod

O número de dias de uso avaliado para calcular as recomendações.

Nome Tipo Description
Last30Days

string

30 dias usados para olhar para trás.
Last60Days

string

60 dias usados para olhar para trás.
Last7Days

string

7 dias usados para olhar para trás.

recommendationUsageDetails

Encargos sob demanda entre firstConsumptionDate e lastConsumptionDate que foram usados para recomendações de benefício de computação.

Nome Tipo Description
charges

number[]

Encargos sob demanda para cada hora entre firstConsumptionDate e lastConsumptionDate que foram usados para recomendações de benefício de computação.
usageGrain

grain

O grão do uso. Valores com suporte: 'Por hora'

sharedScopeBenefitRecommendationProperties

As propriedades da recomendação de benefício quando o escopo é 'Compartilhado'.

Nome Tipo Description
allRecommendationDetails

allSavingsList

A lista de todas as recomendações de benefício com os detalhes da recomendação.
armSkuName

string

Nome da SKU do ARM. 'Compute_Savings_Plan' para SavingsPlan.
commitmentGranularity

grain

Granulação da quantidade de compromisso proposta. Valores com suporte: 'Por hora'
costWithoutBenefit

number

O custo atual sem benefício corresponde a 'totalHours' no período de pesquisa.
currencyCode

string

Um identificador de código de moeda ISO 4217 para os custos e valores de economia.
firstConsumptionDate

string

A primeira data de uso usada para procurar a computação das recomendações.
lastConsumptionDate

string

A última data de uso usada para procurar a computação das recomendações.
lookBackPeriod

lookBackPeriod

O número de dias de uso avaliado para calcular as recomendações.
recommendationDetails

allSavingsBenefitDetails

Os detalhes da recomendação proposta.
scope string:

Shared

Escopo do benefício. Por exemplo, Single ou Shared.
term

term

Período de prazo do benefício. Por exemplo, P1Y ou P3Y.
totalHours

integer

As horas totais para as quais o custo é coberto. É igual ao número de registros em uma propriedade 'properties/usage/charges'.
usage

recommendationUsageDetails

Encargos sob demanda entre firstConsumptionDate e lastConsumptionDate que foram usados para recomendações de benefício de computação.

singleScopeBenefitRecommendationProperties

As propriedades das recomendações de benefício quando o escopo é 'Single'.

Nome Tipo Description
allRecommendationDetails

allSavingsList

A lista de todas as recomendações de benefício com os detalhes da recomendação.
armSkuName

string

Nome da SKU do ARM. 'Compute_Savings_Plan' para SavingsPlan.
commitmentGranularity

grain

Granulação da quantidade de compromisso proposta. Valores com suporte: 'Por hora'
costWithoutBenefit

number

O custo atual sem benefício corresponde a 'totalHours' no período de pesquisa.
currencyCode

string

Um identificador de código de moeda ISO 4217 para os custos e valores de economia.
firstConsumptionDate

string

A primeira data de uso usada para procurar a computação das recomendações.
lastConsumptionDate

string

A última data de uso usada para procurar a computação das recomendações.
lookBackPeriod

lookBackPeriod

O número de dias de uso avaliado para calcular as recomendações.
recommendationDetails

allSavingsBenefitDetails

Os detalhes da recomendação proposta.
resourceGroup

string

O grupo de recursos para o qual essa recomendação de escopo único serve. Aplicável somente se a recomendação for para escopo 'Único' e escopo de solicitação 'ResourceGroup'.
scope string:

Single

Escopo do benefício. Por exemplo, Single ou Shared.
subscriptionId

string

A ID da assinatura para a qual essa recomendação de escopo único serve. Aplicável somente se a recomendação for para o escopo 'Single'.
term

term

Período de prazo do benefício. Por exemplo, P1Y ou P3Y.
totalHours

integer

As horas totais para as quais o custo é coberto. É igual ao número de registros em uma propriedade 'properties/usage/charges'.
usage

recommendationUsageDetails

Encargos sob demanda entre firstConsumptionDate e lastConsumptionDate que foram usados para recomendações de benefício de computação.

term

Período de prazo do benefício. Por exemplo, P1Y ou P3Y.

Nome Tipo Description
P1Y

string

O prazo do benefício é de 1 ano.
P3Y

string

O prazo do benefício é de 3 anos.