Benefit Recommendations - List

Referência

Serviço:: Cost Management

Versão da API:: 2023-11-01

Lista de recomendações para comprar um plano de poupança.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
billingScope	path	True	string	O âmbito associado às operações de recomendação de benefícios. Isto inclui "/subscriptions/{subscriptionId}/" para o âmbito da subscrição, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" para o âmbito do grupo de recursos, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}" para o âmbito do contrato enterprise e "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" para o âmbito do perfil de faturação
api-version	query	True	string	A versão da API a utilizar para esta operação.
$expand	query		string	Pode ser utilizado para expandir as propriedades por: propriedades/utilização, propriedades/allRecommendationDetails
$filter	query		string	Pode ser utilizado para filtrar benefitRecommendations by: properties/scope with allowed values ['Single', 'Shared'] and default value 'Shared'; e propriedades/lookBackPeriod com valores permitidos ['Last7Days', 'Last30Days', 'Last60Days'] e o valor predefinido 'Last60Days'; propriedades/termo com valores permitidos ['P1Y', 'P3Y'] e o valor predefinido 'P3Y'; properties/subscriptionId; propriedades/resourceGroup
$orderby	query		string	Pode ser utilizado para ordenar as recomendações por: properties/armSkuName. Para o plano de poupança, os resultados estão por predefinição. Não é necessário utilizar esta cláusula.

Respostas

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Description
user_impersonation	representar 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=2023-11-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 Plano de Poupança.
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 consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro. Algumas Respostas de erro: 429 TooManyRequests – o pedido é limitado. Repita 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 após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.
grain	O grão da utilização. Valores suportados: "Hora a hora"
lookBackPeriod	O número de dias de utilização avaliados para calcular as recomendações.
recommendationUsageDetails	Custos a pedido entre firstConsumptionDate e lastConsumptionDate que foram utilizados para recomendações de benefícios de computação.
sharedScopeBenefitRecommendationProperties	As propriedades da recomendação de benefícios quando o âmbito é "Partilhado".
singleScopeBenefitRecommendationProperties	As propriedades das recomendações de benefícios quando o âmbito é "Único".
term	Período de período do benefício. Por exemplo, P1Y ou P3Y.

allSavingsBenefitDetails

Detalhes da recomendação de benefícios.

Name	Tipo	Description
averageUtilizationPercentage	number	Percentagem de utilização média estimada para o "totalHours" no período de pesquisa, com este compromisso.
benefitCost	number	O custo estimado com benefício para o "totalHours" no período de retrospetivo. É igual a (commitmentAmount * totalHours)
commitmentAmount	number	O montante da alocação na alocaçãoGranularidade.
coveragePercentage	number	Percentagem estimada de cobertura do benefício para o "totalHours" no período de retrospetivo, com este compromisso.
overageCost	number	A diferença entre o custo total e o custo do benefício para o "totalHours" no período de retrospetivo.
savingsAmount	number	O montante guardado para o "totalHours" no período de retrospetivo, ao comprar a quantidade recomendada do benefício.
savingsPercentage	number	A poupança em percentagem para o "totalHours" no período de retrospetivo período, ao comprar a quantidade recomendada de benefícios.
totalCost	number	Custo total, que é a soma do custo do benefício e do custo de utilização excedida.
wastageCost	number	Parte 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	A ligação (URL) para a página seguinte dos resultados.
value	allSavingsBenefitDetails[]	A lista de recomendações de benefícios com os detalhes da recomendação.

benefitKind

Reserva ou Plano de Poupança.

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

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	benefitKind	Reserva ou Plano de Poupança.
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	A ligação (URL) para a página seguinte dos 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 a indicar o motivo pela qual a operação falhou.

ErrorResponse

A resposta de erro indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Algumas Respostas de erro:

429 TooManyRequests – o pedido é limitado. Repita 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 após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.

Name	Tipo	Description
error	ErrorDetails	Os detalhes do erro.

grain

O grão da utilização. Valores suportados: "Hora a hora"

Name	Tipo	Description
Daily	string	Os grãos por hora correspondem ao valor por dia.
Hourly	string	Os grãos por hora correspondem ao valor por hora.
Monthly	string	Os grãos por hora correspondem ao valor por mês.

lookBackPeriod

O número de dias de utilização avaliados para calcular as 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

Custos a pedido entre firstConsumptionDate e lastConsumptionDate que foram utilizados para recomendações de benefícios de computação.

Name	Tipo	Description
charges	number[]	Custos a pedido por cada hora entre firstConsumptionDate e lastConsumptionDate que foram utilizados para recomendações de benefícios de computação.
usageGrain	grain	O grão da utilização. Valores suportados: "Hora a hora"

sharedScopeBenefitRecommendationProperties

As propriedades da recomendação de benefícios quando o âmbito é "Partilhado".

Name	Tipo	Description
allRecommendationDetails	allSavingsList	A lista de todas as recomendações de benefícios com os detalhes da recomendação.
armSkuName	string	Nome do SKU do ARM. 'Compute_Savings_Plan' para o SavingsPlan.
commitmentGranularity	grain	Grão do montante de compromisso proposto. Valores suportados: "Hora a hora"
costWithoutBenefit	number	O custo atual sem benefícios corresponde a "totalHours" no período de retrospetivo.
currencyCode	string	Um identificador de código de moeda ISO 4217 para os custos e montantes de poupança.
firstConsumptionDate	string	A primeira data de utilização utilizada para analisar a computação das recomendações.
lastConsumptionDate	string	A última data de utilização utilizada para analisar a computação das recomendações.
lookBackPeriod	lookBackPeriod	O número de dias de utilização avaliados para calcular as recomendações.
recommendationDetails	allSavingsBenefitDetails	Os detalhes da recomendação proposta.
scope	string: Shared	Âmbito do benefício. Por exemplo, Único ou Partilhado.
term	term	Período de período do benefício. Por exemplo, P1Y ou P3Y.
totalHours	integer	As horas totais para as quais o custo é coberto. É igual ao número de registos numa propriedade "propriedades/utilização/custos".
usage	recommendationUsageDetails	Custos a pedido entre firstConsumptionDate e lastConsumptionDate que foram utilizados para recomendações de benefícios de computação.

singleScopeBenefitRecommendationProperties

As propriedades das recomendações de benefícios quando o âmbito é "Ú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 do SKU do ARM. 'Compute_Savings_Plan' para o SavingsPlan.
commitmentGranularity	grain	Grão do montante de compromisso proposto. Valores suportados: "Hora a hora"
costWithoutBenefit	number	O custo atual sem benefícios corresponde a "totalHours" no período de retrospetivo.
currencyCode	string	Um identificador de código de moeda ISO 4217 para os custos e montantes de poupança.
firstConsumptionDate	string	A primeira data de utilização utilizada para analisar a computação das recomendações.
lastConsumptionDate	string	A última data de utilização utilizada para analisar a computação das recomendações.
lookBackPeriod	lookBackPeriod	O número de dias de utilização avaliados para calcular as recomendações.
recommendationDetails	allSavingsBenefitDetails	Os detalhes da recomendação proposta.
resourceGroup	string	O grupo de recursos para o qual se destina esta recomendação de âmbito único. Aplicável apenas se a recomendação for para o âmbito "Único" e o âmbito de pedido "ResourceGroup".
scope	string: Single	Âmbito do benefício. Por exemplo, Único ou Partilhado.
subscriptionId	string	O ID de subscrição para o qual se destina esta recomendação de âmbito único. Aplicável apenas se a recomendação for para o âmbito "Único".
term	term	Período de período do benefício. Por exemplo, P1Y ou P3Y.
totalHours	integer	As horas totais para as quais o custo é coberto. É igual ao número de registos numa propriedade "propriedades/utilização/custos".
usage	recommendationUsageDetails	Custos a pedido entre firstConsumptionDate e lastConsumptionDate que foram utilizados para recomendações de benefícios de computação.

term

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

Name	Tipo	Description
P1Y	string	O período de benefícios é de 1 ano.
P3Y	string	O período de benefícios é de 3 anos.

Partilhar via