Partilhar via


Generate Benefit Utilization Summaries Report - Generate By Savings Plan Id

Aciona a geração de um relatório de resumos de utilização de benefícios para o plano de poupança fornecido.

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2023-11-01

Parâmetros do URI

Name Em Necessário Tipo Description
savingsPlanId
path True

string

ID do plano de poupança.

savingsPlanOrderId
path True

string

ID da encomenda do plano de poupança.

api-version
query True

string

A versão da API a utilizar para esta operação.

Corpo do Pedido

Name Necessário Tipo Description
endDate True

string

A data de fim dos resumos de dados que serão servidos no relatório.

grain True

grain

O grão em que os dados resumidos são servidos no relatório. Os valores aceites são "Diário" ou "Mensal".

startDate True

string

A data de início dos resumos de dados que serão servidos no relatório.

benefitId

string

ID do benefício para o relatório de resumos de utilização de benefícios. Necessário para o âmbito do ID de benefício. Não suportado para a ordem de benefícios ou quaisquer âmbitos de faturação.

benefitOrderId

string

ID da ordem de benefícios para o qual se destina o relatório de resumos de utilização de benefícios. Necessário para a ordem de benefícios e âmbitos de ID de benefício. Não suportado para quaisquer âmbitos de faturação.

billingAccountId

string

Conta de faturação para a qual se destina o relatório de resumos de utilização de benefícios. Necessário para âmbitos de contas de faturação e perfis de faturação. Não suportado para quaisquer âmbitos de benefícios.

billingProfileId

string

ID do perfil de faturação para o relatório de resumos de utilização de benefícios. Necessário para o âmbito do perfil de faturação. Não suportado para a conta de faturação ou quaisquer âmbitos de benefícios.

kind

benefitKind

O tipo de dados de benefício pedidos. Necessário para âmbitos de contas de faturação e perfis de faturação. Implícito e não ser transmitido nos âmbitos de benefícios. Os valores suportados são Reservation e SavingsPlan

Respostas

Name Tipo Description
200 OK

BenefitUtilizationSummariesOperationStatus

O estado da geração do relatório de resumos de utilização de benefícios. Isto pode estar em curso, com falhas ou concluído.

202 Accepted

Aceite. O pedido será processado. Utilize o cabeçalho de localização para verificar o estado.

Cabeçalhos

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Resposta de erro que descreve o motivo 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

GenerateUtilizationSummariesReportBySavingsPlan

Pedido de amostra

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2023-11-01

{
  "endDate": "2022-08-31T00:00:00Z",
  "startDate": "2022-06-01T00:00:00Z",
  "grain": "Daily"
}

Resposta da amostra

Location: https://management.azure.com/providers/Microsoft.Capacity/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2023-11-01
Retry-After: 60
{
  "input": {
    "grain": "Daily",
    "benefitOrderId": "00000000-0000-0000-0000-000000000000",
    "benefitId": "00000000-0000-0000-0000-000000000000",
    "kind": "SavingsPlan",
    "endDate": "2022-08-31T00:00:00Z",
    "startDate": "2022-06-01T00:00:00Z"
  },
  "status": "Complete",
  "properties": {
    "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "validUntil": "2022-06-12T02:56:55.5021869Z"
  }
}

Definições

Name Description
AsyncOperationStatusProperties

Objeto que representa o URL do relatório e válido até à data do relatório assíncrono gerado.

benefitKind

Reserva ou Plano de Poupança.

BenefitUtilizationSummariesOperationStatus

O estado de um relatório de resumos de utilização de benefícios. Fornece Utilização do Benefício Assíncrono Resumos Pedido de entrada, estado e url sas de relatório.

BenefitUtilizationSummariesRequest

Propriedades de um pedido de resumos de utilização de benefícios assíncrono.

BenefitUtilizationSummaryReportSchema

O ficheiro CSV da ligação de blob reportUrl e secondaryReportUrl será composto pelas seguintes colunas de dados de utilização de benefícios. UtilizedPercentage será 0 para relatórios de planos de poupança e reservas não de tijolos de dados. As percentagens de utilização serão 0 para reservas de tijolos de dados.

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"

OperationStatusType

O estado da criação do relatório de resumos de utilização de benefícios.

AsyncOperationStatusProperties

Objeto que representa o URL do relatório e válido até à data do relatório assíncrono gerado.

Name Tipo Description
reportUrl

BenefitUtilizationSummaryReportSchema

Url sas para o relatório de resumos de utilização do benefício assíncrono. Estará vazio se o relatório estiver no estado Em Execução ou Com Falhas.

secondaryReportUrl

BenefitUtilizationSummaryReportSchema

O URL sas para a utilização do benefício assíncrono resume o relatório no armazenamento secundário em caso de indisponibilidade primária. Estará vazio se o relatório estiver no estado Em Execução ou Com Falhas.

validUntil

string

A data em que o URL sas fornecido no reportUrl expira.

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.

BenefitUtilizationSummariesOperationStatus

O estado de um relatório de resumos de utilização de benefícios. Fornece Utilização do Benefício Assíncrono Resumos Pedido de entrada, estado e url sas de relatório.

Name Tipo Description
input

BenefitUtilizationSummariesRequest

Entrada dada para criar o relatório de resumos de utilização de benefícios.

properties

AsyncOperationStatusProperties

Contém o URL sas para o relatório de resumos de utilização do benefício assíncrono e uma data em que o URL é válido até. Estes valores estarão vazios se o relatório estiver num estado Em Execução ou Com Falhas

status

OperationStatusType

O estado da criação do relatório de resumos de utilização de benefícios.

BenefitUtilizationSummariesRequest

Propriedades de um pedido de resumos de utilização de benefícios assíncrono.

Name Tipo Description
benefitId

string

ID do benefício para o relatório de resumos de utilização de benefícios. Necessário para o âmbito do ID de benefício. Não suportado para a ordem de benefícios ou quaisquer âmbitos de faturação.

benefitOrderId

string

ID da ordem de benefícios para o qual se destina o relatório de resumos de utilização de benefícios. Necessário para a ordem de benefícios e âmbitos de ID de benefício. Não suportado para quaisquer âmbitos de faturação.

billingAccountId

string

Conta de faturação para a qual se destina o relatório de resumos de utilização de benefícios. Necessário para âmbitos de contas de faturação e perfis de faturação. Não suportado para quaisquer âmbitos de benefícios.

billingProfileId

string

ID do perfil de faturação para o relatório de resumos de utilização de benefícios. Necessário para o âmbito do perfil de faturação. Não suportado para a conta de faturação ou quaisquer âmbitos de benefícios.

endDate

string

A data de fim dos resumos de dados que serão servidos no relatório.

grain

grain

O grão em que os dados resumidos são servidos no relatório. Os valores aceites são "Diário" ou "Mensal".

kind

benefitKind

O tipo de dados de benefício pedidos. Necessário para âmbitos de contas de faturação e perfis de faturação. Implícito e não ser transmitido nos âmbitos de benefícios. Os valores suportados são Reservation e SavingsPlan

startDate

string

A data de início dos resumos de dados que serão servidos no relatório.

BenefitUtilizationSummaryReportSchema

O ficheiro CSV da ligação de blob reportUrl e secondaryReportUrl será composto pelas seguintes colunas de dados de utilização de benefícios. UtilizedPercentage será 0 para relatórios de planos de poupança e reservas não de tijolos de dados. As percentagens de utilização serão 0 para reservas de tijolos de dados.

Name Tipo Description
AvgUtilizationPercentage

string

BenefitId

string

BenefitOrderId

string

BenefitType

string

Kind

string

MaxUtilizationPercentage

string

MinUtilizationPercentage

string

UsageDate

string

UtilizedPercentage

string

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.

OperationStatusType

O estado da criação do relatório de resumos de utilização de benefícios.

Name Tipo Description
Complete

string

Failed

string

Running

string