Benefit Recommendations - List

Referência

Serviço:: Cost Management

Versão da API:: 2024-08-01

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

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 do URI

Name	Em	Necessário	Tipo	Description
billingScope	path	True	string	O escopo associado às operações de recomendação de benefícios. 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/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo do perfil de faturamento
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/todosRecomendaçãoDetalhes
$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 valor padrão 'Last60Days'; propriedades/termo com valores permitidos ['P1Y', 'P3Y'] e valor padrão 'P3Y'; propriedades/subscriptionId; propriedades/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 há necessidade de utilizar esta cláusula.

Respostas

Name	Tipo	Description
200 OK	benefitRecommendationsListResult	OK. O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

BenefitRecommendationsBillingAccountList

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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

Name	Description
allSavingsBenefitDetails	Detalhes da recomendação de benefícios.
allSavingsList	A lista de todas as recomendações de benefícios 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 está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiçoIndisponível - 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 suportados: 'Horária'
lookBackPeriod	O número de dias de uso avaliado para o cálculo das recomendações.
recommendationUsageDetails	Cobranças sob demanda entre firstConsumptionDate e lastConsumptionDate que foram usadas para calcular recomendações de benefícios.
sharedScopeBenefitRecommendationProperties	As propriedades da recomendação de benefício quando o escopo é 'Compartilhado'.
singleScopeBenefitRecommendationProperties	As propriedades das recomendações de benefícios quando o escopo é 'Único'.
term	Período de vigência do benefício. Por exemplo, P1Y ou P3Y.

allSavingsBenefitDetails

Detalhes da recomendação de benefícios.

Name	Tipo	Description
averageUtilizationPercentage	number	Percentagem média de utilização estimada para o 'totalHours' no período de retrospetiva, com este compromisso.
benefitCost	number	O custo estimado com benefício para o 'totalHours' no período de retrospetiva. É igual a (commitmentAmount * totalHours)
commitmentAmount	number	O montante do compromisso no compromissoGranularidade.
coveragePercentage	number	Percentual estimado de cobertura do benefício para o 'totalHours' no período de retrospetiva, com este compromisso.
overageCost	number	A diferença entre o custo total e o custo benefício para o 'totalHours' no período de retrospetiva.
savingsAmount	number	O valor economizado para o 'totalHours' no período de retrospetiva, comprando a quantidade recomendada do benefício.
savingsPercentage	number	A poupança em percentagem para o 'totalHours' no período de retrospetiva, através da compra da quantidade recomendada de benefício.
totalCost	number	Custo total, que é a soma do custo benefício e do custo excedente.
wastageCost	number	Parcela estimada não utilizada do 'benefitCost'.

allSavingsList

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

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

Name	Tipo	Description
IncludedQuantity	string	O benefício está incluídoQuantidade.
Reservation	string	O benefício é a reserva.
SavingsPlan	string	Benefício é SavingsPlan.

benefitRecommendationModel

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

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado 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: sharedScopeBenefitRecommendationProperties singleScopeBenefitRecommendationProperties	As propriedades das recomendações de benefícios.
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.

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

Name	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 está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiçoIndisponível - O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".

Name	Tipo	Description
error	ErrorDetails	Os detalhes do erro.

grain

O grão do uso. Valores suportados: 'Horária'

Name	Tipo	Description
Daily	string	O grão por hora corresponde ao valor por dia.
Hourly	string	O grão por hora corresponde ao valor por hora.
Monthly	string	O grão por hora corresponde ao valor por mês.

lookBackPeriod

O número de dias de uso avaliado para o cálculo das recomendações.

Name	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

Cobranças sob demanda entre firstConsumptionDate e lastConsumptionDate que foram usadas para calcular recomendações de benefícios.

Name	Tipo	Description
charges	number[]	Cobranças sob demanda para cada hora entre firstConsumptionDate e lastConsumptionDate que foram usadas para calcular recomendações de benefícios.
usageGrain	grain	O grão do uso. Valores suportados: 'Horária'

sharedScopeBenefitRecommendationProperties

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

Name	Tipo	Description
allRecommendationDetails	allSavingsList	A lista de todas as recomendações de benefícios com os detalhes da recomendação.
armSkuName	string	Nome ARM SKU. 'Compute_Savings_Plan' para o SavingsPlan.
commitmentGranularity	grain	Grão do montante de autorização proposto. Valores suportados: 'Horária'
costWithoutBenefit	number	O custo atual sem benefício, corresponde ao 'totalHours' no período de retrospetiva.
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 olhar para trás para calcular as recomendações.
lastConsumptionDate	string	A última data de uso usada para olhar para trás para calcular as recomendações.
lookBackPeriod	lookBackPeriod	O número de dias de uso avaliado para o cálculo das recomendações.
recommendationDetails	allSavingsBenefitDetails	Os pormenores da recomendação proposta.
scope	string: Shared	Escopo do benefício. Por exemplo, Single ou Shared.
term	term	Período de vigência do benefício. Por exemplo, P1Y ou P3Y.
totalHours	integer	O total de horas para as quais o custo é coberto. É igual ao número de registros em uma propriedade 'propriedades/uso/encargos'.
usage	recommendationUsageDetails	Cobranças sob demanda entre firstConsumptionDate e lastConsumptionDate que foram usadas para calcular recomendações de benefícios.

singleScopeBenefitRecommendationProperties

As propriedades das recomendações de benefícios quando o escopo é 'Único'.

Name	Tipo	Description
allRecommendationDetails	allSavingsList	A lista de todas as recomendações de benefícios com os detalhes da recomendação.
armSkuName	string	Nome ARM SKU. 'Compute_Savings_Plan' para o SavingsPlan.
commitmentGranularity	grain	Grão do montante de autorização proposto. Valores suportados: 'Horária'
costWithoutBenefit	number	O custo atual sem benefício, corresponde ao 'totalHours' no período de retrospetiva.
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 olhar para trás para calcular as recomendações.
lastConsumptionDate	string	A última data de uso usada para olhar para trás para calcular as recomendações.
lookBackPeriod	lookBackPeriod	O número de dias de uso avaliado para o cálculo das recomendações.
recommendationDetails	allSavingsBenefitDetails	Os pormenores da recomendação proposta.
resourceGroup	string	O grupo de recursos para o qual esta recomendação de escopo único se destina. Aplicável somente se a recomendação for para escopo 'Único' e escopo de solicitação 'Grupo de Recursos'.
scope	string: Single	Escopo do benefício. Por exemplo, Single ou Shared.
subscriptionId	string	A ID da assinatura para a qual esta recomendação de escopo único se destina. Aplicável apenas se a recomendação for para um âmbito de aplicação «único».
term	term	Período de vigência do benefício. Por exemplo, P1Y ou P3Y.
totalHours	integer	O total de horas para as quais o custo é coberto. É igual ao número de registros em uma propriedade 'propriedades/uso/encargos'.
usage	recommendationUsageDetails	Cobranças sob demanda entre firstConsumptionDate e lastConsumptionDate que foram usadas para calcular recomendações de benefícios.

term

Período de vigência do benefício. Por exemplo, P1Y ou P3Y.

Name	Tipo	Description
P1Y	string	O prazo do benefício é de 1 ano.
P3Y	string	O prazo do benefício é de 3 anos.

Partilhar via