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=2024-08-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 do pedido do plano de poupança.

api-version
query True

string

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

Corpo do Pedido

Name Necessário Tipo Description
endDate True

string

A data final dos dados resumidos que serão servidos no relatório.

grain True

grain

Os dados dos resumos são servidos no relatório. Os valores aceites são 'Diário' ou 'Mensal'.

startDate True

string

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

benefitId

string

ID do benefício para o qual o relatório de resumos de utilização de benefícios é destinado. Necessário para o escopo da ID do benefício. Não há suporte para ordem de benefício ou qualquer escopo de faturamento.

benefitOrderId

string

ID da ordem de benefício para a qual o relatório de resumos de utilização de benefícios é destinado. Necessário para escopos de ordem de benefício e id de benefício. Não há suporte para nenhum escopo de faturamento.

billingAccountId

string

Conta de faturamento para a qual o relatório de resumos de utilização de benefícios é destinado. Necessário para os escopos da conta de faturamento e do perfil de faturamento. Não há suporte para nenhum escopo de benefício.

billingProfileId

string

ID do perfil de faturamento para o qual o relatório de resumos de utilização de benefícios se destina. Necessário para o escopo do perfil de faturamento. Não há suporte para conta de faturamento ou qualquer escopo de benefício.

kind

benefitKind

O tipo de dados de benefício solicitados. Necessário para os escopos da conta de faturamento e do perfil de faturamento. Implícito e não a ser passado nos âmbitos dos benefícios. Os valores suportados são Reserva e Plano de Poupança

Respostas

Name 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, falhar ou ser concluído.

202 Accepted

Aceito. O pedido será processado. Use o cabeçalho do local para verificar o status.

Cabeçalhos

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

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=2024-08-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=2024-08-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 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 resumos de utilização de benefícios assíncronos Solicitar entrada, status e relatório sas url.

BenefitUtilizationSummariesRequest

Propriedades de uma solicitação de resumos de utilização de benefícios assíncronos.

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 de tijolos não dados. As porcentagens 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 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'

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.

Name Tipo Description
reportUrl

BenefitUtilizationSummaryReportSchema

URL do Sas para o relatório de resumos de utilização de benefícios assíncronos. Ficará vazio se o relatório estiver no estado em Execução ou Falha.

secondaryReportUrl

BenefitUtilizationSummaryReportSchema

Sas url para assíncrono relatório de resumos de utilização de benefícios no armazenamento secundário em caso de interrupção primária. Ficará vazio se o relatório estiver no estado em Execução ou Falha.

validUntil

string

A data em que a url sas fornecida em reportUrl expira.

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.

BenefitUtilizationSummariesOperationStatus

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

Name Tipo Description
input

BenefitUtilizationSummariesRequest

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

properties

AsyncOperationStatusProperties

Contém sas url para o relatório de resumos de utilização de benefícios assíncronos e uma data em que a url é válida até. Esses valores estarão vazios se o relatório estiver no estado Em execução ou 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ícios assíncronos.

Name Tipo Description
benefitId

string

ID do benefício para o qual o relatório de resumos de utilização de benefícios é destinado. Necessário para o escopo da ID do benefício. Não há suporte para ordem de benefício ou qualquer escopo de faturamento.

benefitOrderId

string

ID da ordem de benefício para a qual o relatório de resumos de utilização de benefícios é destinado. Necessário para escopos de ordem de benefício e id de benefício. Não há suporte para nenhum escopo de faturamento.

billingAccountId

string

Conta de faturamento para a qual o relatório de resumos de utilização de benefícios é destinado. Necessário para os escopos da conta de faturamento e do perfil de faturamento. Não há suporte para nenhum escopo de benefício.

billingProfileId

string

ID do perfil de faturamento para o qual o relatório de resumos de utilização de benefícios se destina. Necessário para o escopo do perfil de faturamento. Não há suporte para conta de faturamento ou qualquer escopo de benefício.

endDate

string

A data final dos dados resumidos que serão servidos no relatório.

grain

grain

Os dados dos resumos são servidos no relatório. Os valores aceites são 'Diário' ou 'Mensal'.

kind

benefitKind

O tipo de dados de benefício solicitados. Necessário para os escopos da conta de faturamento e do perfil de faturamento. Implícito e não a ser passado nos âmbitos dos benefícios. Os valores suportados são Reserva e Plano de Poupança

startDate

string

A data de início dos dados resumidos que serão servidos 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 de tijolos não dados. As porcentagens 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 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.

OperationStatusType

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

Name Tipo Description
Complete

string

Failed

string

Running

string