Generate Detailed Cost Report - Create Operation

Referência

Serviço:: Cost Management

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

Gera o relatório de custos detalhado para o intervalo de datas fornecido, período de faturamento (somente clientes corporativos) ou ID da fatura de forma assíncrona em um determinado escopo. A chamada retorna um 202 com cabeçalho Azure-Consumption-AsyncOperation fornecendo um link para a operação criada. Uma chamada na operação fornecerá o status e, se a operação for concluída, o arquivo de blob onde o relatório de custo detalhado gerado está sendo armazenado.

POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
scope	path	True	string	O ID de recurso ARM para assinatura, grupo de recursos, conta de cobrança ou outros escopos de cobrança. Para obter detalhes, consulte https://aka.ms/costmgmt/scopes.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Tipo	Description
billingPeriod	string	Período de faturamento no formato YearMonth(por exemplo, 202008). Somente para clientes corporativos legados podem usar isso. Só pode ter um dos parâmetros timePeriod ou invoiceId ou billingPeriod. Se nenhum fornecido custo do mês atual é fornecido.
customerId	string	ID do Cliente para escopos do Contrato de Cliente Microsoft (ID da Fatura também é necessária para isso).
invoiceId	string	ID da fatura para os escopos do Pay-as-you-go e do Contrato de Cliente da Microsoft. Só pode ter um dos parâmetros timePeriod ou invoiceId ou billingPeriod. Se nenhum fornecido custo do mês atual é fornecido.
metric	GenerateDetailedCostReportMetricType	O tipo de relatório detalhado. Por padrão, ActualCost é fornecido
timePeriod	GenerateDetailedCostReportTimePeriod	Tem período de tempo para extrair dados para o relatório detalhado de custo. Só pode ter um dos parâmetros timePeriod ou invoiceId ou billingPeriod. Se nenhum fornecido custo do mês atual é fornecido.

Respostas

Name	Tipo	Description
200 OK	GenerateDetailedCostReportOperationResult	Processamento do pedido concluído.
202 Accepted		Aceito. O pedido será processado. Use o cabeçalho Localização para verificar o status. Cabeçalhos Location: string Azure-Consumption-AsyncOperation: string Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	GenerateDetailedCostReportErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Name

Tipo

Description

200 OK

GenerateDetailedCostReportOperationResult

Processamento do pedido concluído.

202 Accepted

Aceito. O pedido será processado. Use o cabeçalho Localização para verificar o status.

Cabeçalhos

Location: string
Azure-Consumption-AsyncOperation: string
Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

GenerateDetailedCostReportErrorResponse

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

GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod

GenerateDetailedCostReportByBillingProfileAndInvoiceId

GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId

GenerateDetailedCostReportByCustomerAndTimePeriod

GenerateDetailedCostReportBySubscriptionAndTimePeriod

GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod

Pedido de amostra

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

{
  "metric": "ActualCost",
  "billingPeriod": "202008"
}

Resposta da amostra

Código de estado:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Consumption/operationResult",
  "properties": {
    "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
    "validTill": "2020-12-08T05:55:59.4394737Z"
  }
}

Código de estado:: 202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Azure-Consumption-AsyncOperation: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Retry-After: 60

GenerateDetailedCostReportByBillingProfileAndInvoiceId

Pedido de amostra

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

{
  "metric": "ActualCost",
  "invoiceId": "M1234567"
}

Resposta da amostra

Código de estado:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Consumption/operationResult",
  "properties": {
    "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
    "validTill": "2020-12-08T05:55:59.4394737Z"
  }
}

Código de estado:: 202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Azure-Consumption-AsyncOperation: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Retry-After: 60

GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId

Pedido de amostra

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

{
  "metric": "ActualCost",
  "invoiceId": "M1234567",
  "customerId": "456789"
}

Resposta da amostra

Código de estado:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Consumption/operationResult",
  "properties": {
    "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
    "validTill": "2020-12-08T05:55:59.4394737Z"
  }
}

Código de estado:: 202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Azure-Consumption-AsyncOperation: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Retry-After: 60

GenerateDetailedCostReportByCustomerAndTimePeriod

Pedido de amostra

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

{
  "metric": "ActualCost",
  "timePeriod": {
    "start": "2020-03-01",
    "end": "2020-03-15"
  }
}

Resposta da amostra

Código de estado:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Consumption/operationResult",
  "properties": {
    "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
    "validTill": "2020-12-08T05:55:59.4394737Z"
  }
}

Código de estado:: 202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Azure-Consumption-AsyncOperation: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Retry-After: 60

GenerateDetailedCostReportBySubscriptionAndTimePeriod

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

{
  "metric": "ActualCost",
  "timePeriod": {
    "start": "2020-03-01",
    "end": "2020-03-15"
  }
}

Resposta da amostra

Código de estado:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Consumption/operationResult",
  "properties": {
    "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
    "validTill": "2020-12-08T05:55:59.4394737Z"
  }
}

Código de estado:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000?api-version=2021-10-01
Azure-Consumption-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2021-10-01
Retry-After: 60

Definições

Name	Description
ErrorDetails	Os detalhes do erro.
GenerateDetailedCostReportDefinition	A definição de um relatório detalhado de custos.
GenerateDetailedCostReportErrorResponse	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: 413 Entidade de solicitação muito grande - A solicitação está limitada. A quantidade de dados necessária para atender à solicitação excede o tamanho máximo permitido de 2Gb. Em vez disso, utilize a nossa funcionalidade de Exportações. 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".
GenerateDetailedCostReportMetricType	O tipo de relatório detalhado. Por padrão, ActualCost é fornecido
GenerateDetailedCostReportOperationResult	O resultado da operação de longa duração para relatório detalhado de custos.
GenerateDetailedCostReportTimePeriod	As datas de início e término para extrair dados para o relatório detalhado de custo.

ErrorDetails

Object

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.

GenerateDetailedCostReportDefinition

Object

A definição de um relatório detalhado de custos.

Name	Tipo	Description
billingPeriod	string	Período de faturamento no formato YearMonth(por exemplo, 202008). Somente para clientes corporativos legados podem usar isso. Só pode ter um dos parâmetros timePeriod ou invoiceId ou billingPeriod. Se nenhum fornecido custo do mês atual é fornecido.
customerId	string	ID do Cliente para escopos do Contrato de Cliente Microsoft (ID da Fatura também é necessária para isso).
invoiceId	string	ID da fatura para os escopos do Pay-as-you-go e do Contrato de Cliente da Microsoft. Só pode ter um dos parâmetros timePeriod ou invoiceId ou billingPeriod. Se nenhum fornecido custo do mês atual é fornecido.
metric	GenerateDetailedCostReportMetricType	O tipo de relatório detalhado. Por padrão, ActualCost é fornecido
timePeriod	GenerateDetailedCostReportTimePeriod	Tem período de tempo para extrair dados para o relatório detalhado de custo. Só pode ter um dos parâmetros timePeriod ou invoiceId ou billingPeriod. Se nenhum fornecido custo do mês atual é fornecido.

GenerateDetailedCostReportErrorResponse

Object

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:

413 Entidade de solicitação muito grande - A solicitação está limitada. A quantidade de dados necessária para atender à solicitação excede o tamanho máximo permitido de 2Gb. Em vez disso, utilize a nossa funcionalidade de Exportações.
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.

GenerateDetailedCostReportMetricType

Enumeração

O tipo de relatório detalhado. Por padrão, ActualCost é fornecido

Valor	Description
ActualCost
AmortizedCost

GenerateDetailedCostReportOperationResult

Object

O resultado da operação de longa duração para relatório detalhado de custos.

Name	Tipo	Description
id	string	A ID do recurso ARM da operação de longa duração.
name	string	O nome da operação de longa duração.
properties.downloadUrl	string	O URL para baixar o relatório gerado.
properties.expiryTime	string (date-time)	O momento em que o URL do relatório se torna inválido/expira em UTC, por exemplo, 2020-12-08T05:55:59.4394737Z.
properties.validTill	string (date-time)	O momento em que o URL do relatório se torna inválido/expira em UTC, por exemplo, 2020-12-08T05:55:59.4394737Z.
type	string	O tipo de operação de longa duração.

GenerateDetailedCostReportTimePeriod

Object

As datas de início e término para extrair dados para o relatório detalhado de custo.

Name	Tipo	Description
end	string	A data final para a qual extrair dados. Exemplo de formato 2020-03-15
start	string	A data de início a partir da qual extrair dados. Exemplo de formato 2020-03-15

Partilhar via

Generate Detailed Cost Report - Create Operation

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod

Pedido de amostra

Resposta da amostra

GenerateDetailedCostReportByBillingProfileAndInvoiceId

Pedido de amostra

Resposta da amostra

GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId

Pedido de amostra

Resposta da amostra

GenerateDetailedCostReportByCustomerAndTimePeriod

Pedido de amostra

Resposta da amostra

GenerateDetailedCostReportBySubscriptionAndTimePeriod

Pedido de amostra

Resposta da amostra

Definições

ErrorDetails

GenerateDetailedCostReportDefinition

GenerateDetailedCostReportErrorResponse

GenerateDetailedCostReportMetricType

GenerateDetailedCostReportOperationResult

GenerateDetailedCostReportTimePeriod

Recursos adicionais