Compartilhar via


Generate Benefit Utilization Summaries Report - Generate By Reservation Id

Dispara a geração de um relatório de resumos de utilização de benefícios para a reserva fornecida.

POST https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
reservationId
path True

string

ID da reserva

reservationOrderId
path True

string

ID do pedido de reserva

api-version
query True

string

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

Corpo da solicitação

Nome Obrigatório Tipo Description
endDate True

string

A data de término dos dados de resumos que serão atendidos no relatório.

grain True

grain

O grão em que os dados de resumos são atendidos no relatório. Os valores aceitos são 'Diário' ou 'Mensal'.

startDate True

string

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

benefitId

string

A ID do benefício para a qual o relatório de resumos de utilização do benefício serve. Necessário para o escopo da ID do benefício. Não há suporte para ordem de benefício ou escopos de cobrança.

benefitOrderId

string

ID do pedido de benefício para o qual o relatório de resumos de utilização de benefícios serve. Necessário para escopos de ordem de benefício e ID de benefício. Não há suporte para escopos de cobrança.

billingAccountId

string

Conta de cobrança para a qual o relatório de resumos de utilização de benefícios serve. Necessário para escopos de perfil de cobrança e conta de cobrança. Não há suporte para escopos de benefícios.

billingProfileId

string

ID do perfil de cobrança para a qual o relatório de resumos de utilização de benefícios serve. Necessário para o escopo do perfil de cobrança. Não há suporte para conta de cobrança ou escopos de benefício.

kind

benefitKind

O tipo de dados de benefício solicitados. Necessário para escopos de perfil de cobrança e conta de cobrança. Implícito e não deve ser passado em escopos de benefício. Os valores com suporte são Reserva e SavingsPlan

Respostas

Nome Tipo Description
200 OK

BenefitUtilizationSummariesOperationStatus

O status da geração do relatório de resumos de utilização de benefícios. Isso pode estar em andamento, com falha ou concluído.

202 Accepted

Aceitado. A solicitação será processada. Use o cabeçalho de localização para verificar o status.

Cabeçalhos

  • Location: string
  • Retry-After: integer
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

GenerateUtilizationSummariesReportByReservation

Solicitação de exemplo

POST https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01

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

Resposta de exemplo

Location: https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2024-08-01
Retry-After: 60
{
  "input": {
    "grain": "Daily",
    "benefitOrderId": "00000000-0000-0000-0000-000000000000",
    "benefitId": "00000000-0000-0000-0000-000000000000",
    "kind": "Reservation",
    "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

Nome Description
AsyncOperationStatusProperties

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

benefitKind

Reserva ou SavingsPlan.

BenefitUtilizationSummariesOperationStatus

Status de um relatório de resumos de utilização de benefícios. Fornece a url sas de entrada, status e sas de solicitação de utilização de benefícios assíncronos.

BenefitUtilizationSummariesRequest

Propriedades de uma solicitação de resumos de utilização de benefício assíncrono.

BenefitUtilizationSummaryReportSchema

O arquivo CSV do link de blob reportUrl e secondaryReportUrl consistirá nas 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. Os percentuais 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 é 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'

OperationStatusType

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

AsyncOperationStatusProperties

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

Nome Tipo Description
reportUrl

BenefitUtilizationSummaryReportSchema

Url sas para o relatório de resumos de utilização de benefícios assíncronos. Ficará vazio se o relatório estiver em estado em execução ou com falha.

secondaryReportUrl

BenefitUtilizationSummaryReportSchema

Sas url to async benefit utilization summaries report in secondary storage in case of primary outage. Ficará vazio se o relatório estiver em estado em execução ou com falha.

validUntil

string

A data em que a URL sas fornecida no reportUrl expira.

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.

BenefitUtilizationSummariesOperationStatus

Status de um relatório de resumos de utilização de benefícios. Fornece a url sas de entrada, status e sas de solicitação de utilização de benefícios assíncronos.

Nome Tipo Description
input

BenefitUtilizationSummariesRequest

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

properties

AsyncOperationStatusProperties

Contém a URL sas para o relatório de resumos de utilização do benefício assíncrono e uma data em que a url é válida até. Esses valores ficarão vazios se o relatório estiver em um estado em execução ou com falha

status

OperationStatusType

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

BenefitUtilizationSummariesRequest

Propriedades de uma solicitação de resumos de utilização de benefício assíncrono.

Nome Tipo Description
benefitId

string

A ID do benefício para a qual o relatório de resumos de utilização do benefício serve. Necessário para o escopo da ID do benefício. Não há suporte para ordem de benefício ou escopos de cobrança.

benefitOrderId

string

ID do pedido de benefício para o qual o relatório de resumos de utilização de benefícios serve. Necessário para escopos de ordem de benefício e ID de benefício. Não há suporte para escopos de cobrança.

billingAccountId

string

Conta de cobrança para a qual o relatório de resumos de utilização de benefícios serve. Necessário para escopos de perfil de cobrança e conta de cobrança. Não há suporte para escopos de benefícios.

billingProfileId

string

ID do perfil de cobrança para a qual o relatório de resumos de utilização de benefícios serve. Necessário para o escopo do perfil de cobrança. Não há suporte para conta de cobrança ou escopos de benefício.

endDate

string

A data de término dos dados de resumos que serão atendidos no relatório.

grain

grain

O grão em que os dados de resumos são atendidos no relatório. Os valores aceitos são 'Diário' ou 'Mensal'.

kind

benefitKind

O tipo de dados de benefício solicitados. Necessário para escopos de perfil de cobrança e conta de cobrança. Implícito e não deve ser passado em escopos de benefício. Os valores com suporte são Reserva e SavingsPlan

startDate

string

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

BenefitUtilizationSummaryReportSchema

O arquivo CSV do link de blob reportUrl e secondaryReportUrl consistirá nas 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. Os percentuais de utilização serão 0 para reservas de tijolos de dados.

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

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.

OperationStatusType

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

Nome Tipo Description
Complete

string

Failed

string

Running

string