Generate Cost Details Report - Create Operation

  • Referência
Serviço:
Cost Management
Versão da API:
2024-08-01

Esta API é a substituição de todas as APIs de Detalhes de Uso lançadas anteriormente. Solicite a geração de um relatório de detalhes de custo 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 inicial para solicitar um relatório retornará um 202 com um cabeçalho 'Local' e 'Repetir-Depois'. O cabeçalho 'Local' fornecerá o ponto de extremidade a ser pesquisado para obter o resultado da geração do relatório. O 'Retry-After' fornece a duração para aguardar antes da sondagem para o relatório gerado. Uma chamada para sondar a operação de relatório fornecerá uma resposta 202 com um cabeçalho 'Local' se a operação ainda estiver em andamento. Quando a operação de geração de relatório for concluída, o ponto de extremidade de sondagem fornecerá uma resposta 200, juntamente com detalhes sobre o(s) blob(s) de relatório que estão disponíveis para download. Os detalhes sobre o(s) ficheiro(s) disponível(is) para download estarão disponíveis no corpo da resposta à votação. Para entender os detalhes de custo (anteriormente conhecidos como detalhes de uso) campos encontrados em arquivos, consulte https://video2.skills-academy.com/en-us/azure/cost-management-billing/automate/understand-usage-details-fields

POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport?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, conta de cobrança ou outros escopos de cobrança. Atualmente, o Grupo de Recursos e o Grupo de Gerenciamento não são suportados. 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 do Pedido

Name Tipo Description
billingPeriod

string

Este parâmetro só pode ser utilizado por clientes do Enterprise Agreement. Use o formato YearMonth(por exemplo, 202008). Este parâmetro não pode ser usado junto com os parâmetros invoiceId ou timePeriod. Se um parâmetro timePeriod, invoiceId ou billingPeriod não for fornecido no corpo da solicitação, a API retornará o custo do mês atual.
invoiceId

string

Este parâmetro só pode ser usado por clientes do Contrato de Cliente da Microsoft. Além disso, ele só pode ser usado no escopo Perfil de Faturamento ou Cliente. Este parâmetro não pode ser usado junto com os parâmetros billingPeriod ou timePeriod. Se um parâmetro timePeriod, invoiceId ou billingPeriod não for fornecido no corpo da solicitação, a API retornará o custo do mês atual.
metric

CostDetailsMetricType

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

CostDetailsTimePeriod

O intervalo de datas específico dos detalhes de custos solicitados para o relatório. Este parâmetro não pode ser usado junto com os parâmetros invoiceId ou billingPeriod. Se um parâmetro timePeriod, invoiceId ou billingPeriod não for fornecido no corpo da solicitação, a API retornará o custo do mês atual. A API só permite que os dados sejam extraídos por 1 mês ou menos e não mais de 13 meses. Se nenhum timePeriod ou billingPeriod ou invoiceId for fornecido, a API assumirá como padrão o período de tempo do mês aberto

Respostas

Name Tipo Description
200 OK

CostDetailsOperationResults

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
  • Retry-After: integer
204 No Content

Sem conteúdo. O pedido foi bem-sucedido, mas não obteve resultados.
Other Status Codes

GenerateCostDetailsReportErrorResponse

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

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod
GenerateCostDetailsReportByBillingProfileAndInvoiceId
GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId
GenerateCostDetailsReportByCustomerAndTimePeriod
GenerateCostDetailsReportByDepartmentsAndTimePeriod
GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod
GenerateCostDetailsReportBySubscriptionAndTimePeriod

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod

Pedido de amostra

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

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

Resposta da amostra

Código de estado:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2024-08-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/billingAccounts/12345",
      "requestBody": {
        "metric": "ActualCost",
        "billingPeriod": "202205"
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}
Código de estado:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-08-01
Retry-After: 60
Código de estado:
204

GenerateCostDetailsReportByBillingProfileAndInvoiceId

Pedido de amostra

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

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

Resposta da amostra

Código de estado:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2024-08-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579",
      "requestBody": {
        "metric": "ActualCost",
        "billingPeriod": "202205"
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}
Código de estado:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-08-01
Retry-After: 60
Código de estado:
204

GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId

Pedido de amostra

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

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

Resposta da amostra

Código de estado:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2024-08-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579",
      "requestBody": {
        "metric": "ActualCost",
        "billingPeriod": "202205"
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}
Código de estado:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-08-01
Retry-After: 60
Código de estado:
204

GenerateCostDetailsReportByCustomerAndTimePeriod

Pedido de amostra

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?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": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2024-08-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579",
      "requestBody": {
        "metric": "ActualCost",
        "timePeriod": {
          "start": "2020-03-01",
          "end": "2020-03-15"
        }
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}
Código de estado:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-08-01
Retry-After: 60
Código de estado:
204

GenerateCostDetailsReportByDepartmentsAndTimePeriod

Pedido de amostra

POST https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?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": "providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2024-08-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/departments/12345",
      "requestBody": {
        "metric": "ActualCost",
        "timePeriod": {
          "start": "2020-03-01",
          "end": "2020-03-15"
        }
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}
Código de estado:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-08-01
Retry-After: 60
Código de estado:
204

GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod

Pedido de amostra

POST https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/generateCostDetailsReport?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": "providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2024-08-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/enrollmentAccounts/1234",
      "requestBody": {
        "metric": "ActualCost",
        "timePeriod": {
          "start": "2020-03-01",
          "end": "2020-03-15"
        }
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}
Código de estado:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-08-01
Retry-After: 60
Código de estado:
204

GenerateCostDetailsReportBySubscriptionAndTimePeriod

Pedido de amostra

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateCostDetailsReport?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/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2024-08-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "subscriptions/00000000-0000-0000-0000-000000000000",
      "requestBody": {
        "metric": "ActualCost",
        "timePeriod": {
          "start": "2020-03-01",
          "end": "2020-03-15"
        }
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}
Código de estado:
202 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-08-01
Retry-After: 60
Código de estado:
204

Definições

Name Description
BlobInfo

As informações de blob geradas por esta operação.
CostDetailsDataFormat

O formato dos dados do relatório
CostDetailsMetricType

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

O resultado da operação de longa duração para detalhes de custo Api.
CostDetailsStatusType

O status da operação de detalhes de custo
CostDetailsTimePeriod

As datas de início e término para extrair dados para o relatório detalhado de custo. A API só permite que os dados sejam extraídos por 1 mês ou menos e não mais de 13 meses.
ErrorDetails

Os detalhes do erro.
GenerateCostDetailsReportErrorResponse

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:

  • 400 Bad Request - Carga útil de solicitação inválida. A carga útil de solicitação fornecida não está em um formato json ou teve um membro inválido não aceito na carga de solicitação.

  • 400 Bad Request - Carga útil de solicitação inválida: só pode ter timePeriod ou invoiceId ou billingPeriod. A API só permite que os dados sejam extraídos para timePeriod ou invoiceId ou billingPeriod. O cliente deve fornecer apenas um desses parâmetros.

  • 400 Bad Request - A data de início deve ser posterior. A API só permite que os dados sejam extraídos no máximo daqui a 13 meses.

  • 400 Bad Request - O intervalo máximo de datas permitido é de 1 mês. A API só permite que os dados sejam extraídos por 1 mês ou menos.

  • 429 TooManyRequests - A solicitação está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "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".
GenerateCostDetailsReportRequestDefinition

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

BlobInfo

As informações de blob geradas por esta operação.

Name Tipo Description
blobLink

string

Link para o blob para baixar o arquivo.
byteCount

integer

Bytes no blob.

CostDetailsDataFormat

O formato dos dados do relatório

Name Tipo Description
Csv

string

Formato de dados Csv.

CostDetailsMetricType

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

Name Tipo Description
ActualCost

string

Dados de custos reais.
AmortizedCost

string

Dados de custos amortizados.

CostDetailsOperationResults

O resultado da operação de longa duração para detalhes de custo Api.

Name Tipo Description
error

ErrorDetails

Os detalhes do erro.
id

string

O id da operação de longa duração.
manifest.blobCount

integer

O número total de blobs.
manifest.blobs

BlobInfo[]

Lista de informações de blob geradas por esta operação.
manifest.byteCount

integer

O número total de bytes em todos os blobs.
manifest.compressData

boolean

São os dados em formato comprimido.
manifest.dataFormat

CostDetailsDataFormat

O formato dos dados do relatório
manifest.manifestVersion

string

A versão Manifest.
manifest.requestContext.requestBody

GenerateCostDetailsReportRequestDefinition

O corpo da carga útil da solicitação fornecido na chamada Detalhes de custo
manifest.requestContext.requestScope

string

O escopo da solicitação.
name

string

O nome da operação de longa duração.
status

CostDetailsStatusType

O status da operação de detalhes de custo
type

string

O tipo de operação de longa duração.
validTill

string

O momento em que o URL do relatório se torna inválido/expira em UTC, por exemplo, 2020-12-08T05:55:59.4394737Z.

CostDetailsStatusType

O status da operação de detalhes de custo

Name Tipo Description
Completed

string

A operação está concluída.
Failed

string

Falha na operação.
NoDataFound

string

A operação está concluída e nenhum dado de custo foi encontrado.

CostDetailsTimePeriod

As datas de início e término para extrair dados para o relatório detalhado de custo. A API só permite que os dados sejam extraídos por 1 mês ou menos e não mais de 13 meses.

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

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.

GenerateCostDetailsReportErrorResponse

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:

  • 400 Bad Request - Carga útil de solicitação inválida. A carga útil de solicitação fornecida não está em um formato json ou teve um membro inválido não aceito na carga de solicitação.

  • 400 Bad Request - Carga útil de solicitação inválida: só pode ter timePeriod ou invoiceId ou billingPeriod. A API só permite que os dados sejam extraídos para timePeriod ou invoiceId ou billingPeriod. O cliente deve fornecer apenas um desses parâmetros.

  • 400 Bad Request - A data de início deve ser posterior. A API só permite que os dados sejam extraídos no máximo daqui a 13 meses.

  • 400 Bad Request - O intervalo máximo de datas permitido é de 1 mês. A API só permite que os dados sejam extraídos por 1 mês ou menos.

  • 429 TooManyRequests - A solicitação está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "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.

GenerateCostDetailsReportRequestDefinition

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

Name Tipo Description
billingPeriod

string

Este parâmetro só pode ser utilizado por clientes do Enterprise Agreement. Use o formato YearMonth(por exemplo, 202008). Este parâmetro não pode ser usado junto com os parâmetros invoiceId ou timePeriod. Se um parâmetro timePeriod, invoiceId ou billingPeriod não for fornecido no corpo da solicitação, a API retornará o custo do mês atual.
invoiceId

string

Este parâmetro só pode ser usado por clientes do Contrato de Cliente da Microsoft. Além disso, ele só pode ser usado no escopo Perfil de Faturamento ou Cliente. Este parâmetro não pode ser usado junto com os parâmetros billingPeriod ou timePeriod. Se um parâmetro timePeriod, invoiceId ou billingPeriod não for fornecido no corpo da solicitação, a API retornará o custo do mês atual.
metric

CostDetailsMetricType

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

CostDetailsTimePeriod

O intervalo de datas específico dos detalhes de custos solicitados para o relatório. Este parâmetro não pode ser usado junto com os parâmetros invoiceId ou billingPeriod. Se um parâmetro timePeriod, invoiceId ou billingPeriod não for fornecido no corpo da solicitação, a API retornará o custo do mês atual. A API só permite que os dados sejam extraídos por 1 mês ou menos e não mais de 13 meses. Se nenhum timePeriod ou billingPeriod ou invoiceId for fornecido, a API assumirá como padrão o período de tempo do mês aberto