Generate Detailed Cost Report - Create Operation

Referência

Serviço:: Cost Management

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

Gera o relatório de custo detalhado para intervalo de datas fornecido, período de cobrança (somente clientes empresariais) ou ID da Fatura de forma assíncrona em um determinado escopo. A chamada retorna um 202 com o 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 em que 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 de URI

Nome	Em	Obrigatório	Tipo	Description
scope	path	True	string	A ID de recurso do 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	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
billingPeriod	string	Período de cobrança no formato YearMonth(por exemplo, 202008). Somente para clientes empresariais herdados podem usá-lo. Só pode ter um dos parâmetros timePeriod ou invoiceId ou billingPeriod. Se nenhum custo de mês atual fornecido for fornecido.
customerId	string	ID do cliente para escopos do Contrato de Cliente da Microsoft (A ID da Fatura também é necessária para isso).
invoiceId	string	ID da fatura para escopos de Pagamento Conforme o Uso e Contrato de Cliente da Microsoft. Só pode ter um dos parâmetros timePeriod ou invoiceId ou billingPeriod. Se nenhum custo de mês atual fornecido for fornecido.
metric	GenerateDetailedCostReportMetricType	O tipo do relatório detalhado. Por padrão, ActualCost é fornecido
timePeriod	GenerateDetailedCostReportTimePeriod	Tem um período de tempo para efetuar pull de dados para o relatório detalhado de custos. Só pode ter um dos parâmetros timePeriod ou invoiceId ou billingPeriod. Se nenhum custo de mês atual fornecido for fornecido.

Respostas

Nome	Tipo	Description
200 OK	GenerateDetailedCostReportOperationResult	Processamento de solicitação concluído.
202 Accepted		Aceitado. A solicitação será processada. Use o cabeçalho Local 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 que descreve por que a operação falhou.

Nome

Tipo

Description

200 OK

GenerateDetailedCostReportOperationResult

Processamento de solicitação concluído.

202 Accepted

Aceitado. A solicitação será processada. Use o cabeçalho Local 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 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

GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod

GenerateDetailedCostReportByBillingProfileAndInvoiceId

GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId

GenerateDetailedCostReportByCustomerAndTimePeriod

GenerateDetailedCostReportBySubscriptionAndTimePeriod

GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod

Solicitação de exemplo

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 de exemplo

Código de status:: 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 status:: 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

Solicitação de exemplo

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 de exemplo

Código de status:: 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 status:: 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

Solicitação de exemplo

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 de exemplo

Código de status:: 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 status:: 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

Solicitação de exemplo

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 de exemplo

Código de status:: 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 status:: 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

Solicitação de exemplo

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 de exemplo

Código de status:: 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 status:: 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

Nome	Description
ErrorDetails	Os detalhes do erro.
GenerateDetailedCostReportDefinition	A definição de um relatório detalhado de custo.
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 é limitada. A quantidade de dados necessários para atender à solicitação excede o tamanho máximo permitido de 2 Gb. Em vez disso, utilize nosso recurso Exportações. 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".
GenerateDetailedCostReportMetricType	O tipo do relatório detalhado. Por padrão, ActualCost é fornecido
GenerateDetailedCostReportOperationResult	O resultado da operação de execução prolongada do relatório detalhado de custos.
GenerateDetailedCostReportTimePeriod	A data de início e término para efetuar pull de dados para o relatório detalhado de custos.

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.

GenerateDetailedCostReportDefinition

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

Nome	Tipo	Description
billingPeriod	string	Período de cobrança no formato YearMonth(por exemplo, 202008). Somente para clientes empresariais herdados podem usá-lo. Só pode ter um dos parâmetros timePeriod ou invoiceId ou billingPeriod. Se nenhum custo de mês atual fornecido for fornecido.
customerId	string	ID do cliente para escopos do Contrato de Cliente da Microsoft (A ID da Fatura também é necessária para isso).
invoiceId	string	ID da fatura para escopos de Pagamento Conforme o Uso e Contrato de Cliente da Microsoft. Só pode ter um dos parâmetros timePeriod ou invoiceId ou billingPeriod. Se nenhum custo de mês atual fornecido for fornecido.
metric	GenerateDetailedCostReportMetricType	O tipo do relatório detalhado. Por padrão, ActualCost é fornecido
timePeriod	GenerateDetailedCostReportTimePeriod	Tem um período de tempo para efetuar pull de dados para o relatório detalhado de custos. Só pode ter um dos parâmetros timePeriod ou invoiceId ou billingPeriod. Se nenhum custo de mês atual fornecido for fornecido.

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 é limitada. A quantidade de dados necessários para atender à solicitação excede o tamanho máximo permitido de 2 Gb. Em vez disso, utilize nosso recurso Exportações.
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.

GenerateDetailedCostReportMetricType

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

Nome	Tipo	Description
ActualCost	string
AmortizedCost	string

GenerateDetailedCostReportOperationResult

O resultado da operação de execução prolongada do relatório detalhado de custos.

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

GenerateDetailedCostReportTimePeriod

A data de início e término para efetuar pull de dados para o relatório detalhado de custos.

Nome	Tipo	Description
end	string	A data de término para a qual efetuar pull de dados. formato de exemplo 2020-03-15
start	string	A data de início da qual os dados serão extraídos. formato de exemplo 2020-03-15

Compartilhar via

Generate Detailed Cost Report - Create Operation

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod

Solicitação de exemplo

Resposta de exemplo

GenerateDetailedCostReportByBillingProfileAndInvoiceId

Solicitação de exemplo

Resposta de exemplo

GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId

Solicitação de exemplo

Resposta de exemplo

GenerateDetailedCostReportByCustomerAndTimePeriod

Solicitação de exemplo

Resposta de exemplo

GenerateDetailedCostReportBySubscriptionAndTimePeriod

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorDetails

GenerateDetailedCostReportDefinition

GenerateDetailedCostReportErrorResponse

GenerateDetailedCostReportMetricType

GenerateDetailedCostReportOperationResult

GenerateDetailedCostReportTimePeriod

Recursos adicionais