Partilhar via

Generate Cost Details Report - Create Operation

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

Esta API é a substituição de todas as APIs de Detalhes de Utilização anteriormente lançadas. Pedido para gerar um relatório de detalhes de custos para o intervalo de datas fornecido, período de faturação (Apenas clientes empresariais) ou ID da Fatura de forma assíncrona num determinado âmbito. A chamada inicial para pedir um relatório devolverá um 202 com um cabeçalho "Localização" e "Repetir Após". O cabeçalho "Localização" fornecerá o ponto final para consultar para obter o resultado da geração do relatório. O "Retry-After" fornece a duração a aguardar antes de consultar o relatório gerado. Uma chamada para consultar a operação de relatório fornecerá uma resposta 202 com um cabeçalho "Localização" se a operação ainda estiver em curso. Assim que a operação de geração de relatórios estiver concluída, o ponto final de consulta fornecerá uma resposta de 200, juntamente com os detalhes sobre os blob(s) de relatórios que estão disponíveis para transferência. Os detalhes sobre os ficheiros disponíveis para transferência estarão disponíveis no corpo de resposta da consulta. Para Compreender os detalhes dos custos (anteriormente conhecidos como detalhes de utilização) nos ficheiros, consulte https://learn.microsoft.com/en-us/azure/cost-management-billing/automate/understand-usage-details-fields

POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

Parâmetros do URI

Name Em Necessário Tipo Description
scope
 path True

string

O ID de Recurso do ARM para subscrição, conta de faturação ou outros âmbitos de faturação. Atualmente, o Grupo de Recursos e o Grupo de Gestão não são suportados. Para obter mais detalhes, veja https://aka.ms/costmgmt/scopes.
api-version
 query True

string

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

Corpo do Pedido

Name Tipo Description
billingPeriod

string

Este parâmetro só pode ser utilizado por Contrato Enterprise clientes. Utilize o formato YearMonth(por exemplo, 202008). Este parâmetro não pode ser utilizado juntamente com os parâmetros invoiceId ou timePeriod. Se um parâmetro timePeriod, invoiceId ou billingPeriod não for fornecido no corpo do pedido, a API devolverá o custo do mês atual.
invoiceId

string

Este parâmetro só pode ser utilizado por Contrato de Cliente Microsoft clientes. Além disso, só pode ser utilizado no Âmbito do Perfil de Faturação ou do Cliente. Este parâmetro não pode ser utilizado juntamente com os parâmetros billingPeriod ou timePeriod. Se um parâmetro timePeriod, invoiceId ou billingPeriod não for fornecido no corpo do pedido, a API devolverá o custo do mês atual.
metric

CostDetailsMetricType

O tipo do relatório detalhado. Por predefinição, é fornecido ActualCost
timePeriod

CostDetailsTimePeriod

O intervalo de datas específico dos detalhes de custos pedidos para o relatório. Este parâmetro não pode ser utilizado juntamente com os parâmetros invoiceId ou billingPeriod. Se um parâmetro timePeriod, invoiceId ou billingPeriod não for fornecido no corpo do pedido, a API devolverá o custo do mês atual. A API só permite que os dados sejam extraídos durante um mês ou menos e não mais de 13 meses. Se não for fornecido tempoPeriod ou faturaçãoPeriod ou invoiceId, a API será predefinida para o período de tempo do mês aberto

Respostas

Name Tipo Description
200 OK

CostDetailsOperationResults

Processamento de pedidos concluído.
202 Accepted

Aceite. O pedido será processado. Utilize o cabeçalho Localização para verificar o estado.

Cabeçalhos

  • Location: string
  • Retry-After: integer
204 No Content

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

GenerateCostDetailsReportErrorResponse

Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar 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=2023-11-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": "2023-11-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=2023-11-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=2023-11-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": "2023-11-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=2023-11-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=2023-11-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": "2023-11-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=2023-11-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=2023-11-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": "2023-11-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=2023-11-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=2023-11-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": "2023-11-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=2023-11-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=2023-11-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": "2023-11-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=2023-11-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=2023-11-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": "2023-11-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=2023-11-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 de dados do relatório
CostDetailsMetricType

O tipo do relatório detalhado. Por predefinição, é fornecido ActualCost
CostDetailsOperationResults

O resultado da operação de execução prolongada para a API de detalhes de custos.
CostDetailsStatusType

O estado da operação de detalhes de custos
CostDetailsTimePeriod

A data de início e de fim para solicitar dados para o relatório detalhado de custos. A API só permite que os dados sejam extraídos durante um 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 consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Algumas Respostas de erro:

  • 400 Pedido Incorreto - Payload de Pedido Inválido. O payload do pedido fornecido não está num formato json ou teve um membro inválido não aceite no payload do pedido.

  • 400 Pedido Incorreto - Payload de pedido inválido: só pode ter timePeriod, invoiceId ou billingPeriod. A API só permite que os dados sejam extraídos para timePeriod, invoiceId ou billingPeriod. O cliente deve fornecer apenas um destes parâmetros.

  • 400 Pedido Incorreto – a data de início tem de ser posterior a . A API só permite que os dados sejam extraídos daqui a 13 meses.

  • 400 Pedido Incorreto – o intervalo de datas máximo permitido é de 1 mês. A API só permite que os dados sejam extraídos durante um mês ou menos.

  • 429 TooManyRequests – o pedido é limitado. Repita depois de aguardar pelo tempo especificado no cabeçalho "repetir após".

  • 503 ServiceUnavailable - O serviço está temporariamente indisponível. Tente novamente após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.
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

Ligue ao blob para transferir o ficheiro.
byteCount

integer

Bytes no blob.

CostDetailsDataFormat

O formato de dados do relatório

Name Tipo Description
Csv

string

Formato de dados CSV.

CostDetailsMetricType

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

Name Tipo Description
ActualCost

string

Dados de custos reais.
AmortizedCost

string

Dados de custos amortizados.

CostDetailsOperationResults

O resultado da operação de execução prolongada para a API de detalhes de custos.

Name Tipo Description
error

ErrorDetails

Os detalhes do erro.
id

string

O ID da operação de execução prolongada.
manifest.blobCount

integer

O número total de blobs.
manifest.blobs

BlobInfo[]

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

integer

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

boolean

Os dados estão em formato comprimido.
manifest.dataFormat

CostDetailsDataFormat

O formato de dados do relatório
manifest.manifestVersion

string

A versão do Manifesto.
manifest.requestContext.requestBody

GenerateCostDetailsReportRequestDefinition

O corpo do payload do pedido fornecido na chamada Detalhes do Custo
manifest.requestContext.requestScope

string

O âmbito do pedido.
name

string

O nome da operação de execução prolongada.
status

CostDetailsStatusType

O estado da operação de detalhes de custos
type

string

O tipo da operação de execução prolongada.
validTill

string

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

CostDetailsStatusType

O estado da operação de detalhes de custos

Name Tipo Description
Completed

string

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

string

A operação falhou.
NoDataFound

string

A operação é Concluída e não foram encontrados dados de custos.

CostDetailsTimePeriod

A data de início e de fim para solicitar dados para o relatório detalhado de custos. A API só permite que os dados sejam extraídos durante um mês ou menos e não mais de 13 meses.

Name Tipo Description
end

string

A data de fim para a qual solicitar dados. formato de exemplo 2020-03-15
start

string

A data de início a partir da qual pretende extrair dados. formato de exemplo 2020-03-15

ErrorDetails

Os detalhes do erro.

Name Tipo Description
code

string

Código de erro.
message

string

Mensagem de erro a indicar o motivo pela qual a operação falhou.

GenerateCostDetailsReportErrorResponse

A resposta de erro indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Algumas Respostas de erro:

  • 400 Pedido Incorreto - Payload de Pedido Inválido. O payload do pedido fornecido não está num formato json ou teve um membro inválido não aceite no payload do pedido.

  • 400 Pedido Incorreto - Payload de pedido inválido: só pode ter timePeriod, invoiceId ou billingPeriod. A API só permite que os dados sejam extraídos para timePeriod, invoiceId ou billingPeriod. O cliente deve fornecer apenas um destes parâmetros.

  • 400 Pedido Incorreto – a data de início tem de ser posterior a . A API só permite que os dados sejam extraídos daqui a 13 meses.

  • 400 Pedido Incorreto – o intervalo de datas máximo permitido é de 1 mês. A API só permite que os dados sejam extraídos durante um mês ou menos.

  • 429 TooManyRequests – o pedido é limitado. Repita depois de aguardar pelo tempo especificado no cabeçalho "repetir após".

  • 503 ServiceUnavailable - O serviço está temporariamente indisponível. Tente novamente após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.

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 Contrato Enterprise clientes. Utilize o formato YearMonth(por exemplo, 202008). Este parâmetro não pode ser utilizado juntamente com os parâmetros invoiceId ou timePeriod. Se um parâmetro timePeriod, invoiceId ou billingPeriod não for fornecido no corpo do pedido, a API devolverá o custo do mês atual.
invoiceId

string

Este parâmetro só pode ser utilizado por Contrato de Cliente Microsoft clientes. Além disso, só pode ser utilizado no Âmbito do Perfil de Faturação ou do Cliente. Este parâmetro não pode ser utilizado juntamente com os parâmetros billingPeriod ou timePeriod. Se um parâmetro timePeriod, invoiceId ou billingPeriod não for fornecido no corpo do pedido, a API devolverá o custo do mês atual.
metric

CostDetailsMetricType

O tipo do relatório detalhado. Por predefinição, é fornecido ActualCost
timePeriod

CostDetailsTimePeriod

O intervalo de datas específico dos detalhes de custos pedidos para o relatório. Este parâmetro não pode ser utilizado juntamente com os parâmetros invoiceId ou billingPeriod. Se um parâmetro timePeriod, invoiceId ou billingPeriod não for fornecido no corpo do pedido, a API devolverá o custo do mês atual. A API só permite que os dados sejam extraídos durante um mês ou menos e não mais de 13 meses. Se não for fornecido tempoPeriod ou faturaçãoPeriod ou invoiceId, a API será predefinida para o período de tempo do mês aberto