Compartilhar via

Generate Cost Details Report - Get Operation Results

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

Obtenha o resultado da operação especificada. Esse link é fornecido no cabeçalho local da solicitação de criação do CostDetails.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
operationId
 path True

string

A ID da operação de destino.
scope
 path True

string

A ID de recurso do ARM para assinatura, conta de cobrança ou outros escopos de cobrança. Atualmente, não há suporte para Grupo de Recursos e Grupo de Gerenciamento. 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.

Respostas

Nome Tipo Description
200 OK

CostDetailsOperationResults

OKEY. A solicitação foi bem-sucedida.
202 Accepted

Aceitado. A operação está em andamento.
Other Status Codes

ErrorResponse

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

Get details of the operation result

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
BlobInfo

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

O formato de dados do relatório
CostDetailsMetricType

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

O resultado da operação de execução longa para a API de detalhes de custo.
CostDetailsStatusType

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

A data de início e término para efetuar pull de dados para o relatório detalhado de custos. A API só permite que os dados sejam extraídos por um mês ou menos e não com mais de 13 meses.
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 é 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".
GenerateCostDetailsReportRequestDefinition

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

BlobInfo

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

Nome Tipo Description
blobLink

string

Link para o blob para baixar o arquivo.
byteCount

integer

Bytes no blob.

CostDetailsDataFormat

O formato de dados do relatório

Nome Tipo Description
Csv

string

Formato de dados CSV.

CostDetailsMetricType

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

Nome Tipo Description
ActualCost

string

Dados de custo reais.
AmortizedCost

string

Dados de custo amortizados.

CostDetailsOperationResults

O resultado da operação de execução longa para a API de detalhes de custo.

Nome Tipo Description
error

ErrorDetails

Os detalhes do erro.
id

string

A ID da operação de execução longa.
manifest.blobCount

integer

O número total de blobs.
manifest.blobs

BlobInfo[]

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

integer

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

boolean

São os dados em formato compactado.
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 conteúdo da solicitação fornecido na chamada Detalhes do Custo
manifest.requestContext.requestScope

string

O escopo da solicitação.
name

string

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

CostDetailsStatusType

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

string

O tipo da operação de execução longa.
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.

CostDetailsStatusType

O status da operação de detalhes de custo

Nome Tipo Description
Completed

string

A operação foi concluída.
Failed

string

Falha na operação.
NoDataFound

string

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

CostDetailsTimePeriod

A data de início e término para efetuar pull de dados para o relatório detalhado de custos. A API só permite que os dados sejam extraídos por um mês ou menos e não com mais de 13 meses.

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

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.

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 é 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.

GenerateCostDetailsReportRequestDefinition

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

Nome Tipo Description
billingPeriod

string

Esse parâmetro só pode ser usado pelos clientes do Contrato Enterprise. Use o formato YearMonth(por exemplo, 202008). Esse 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

Esse parâmetro só pode ser usado pelos clientes do Contrato de Cliente da Microsoft. Além disso, ele só pode ser usado no perfil de cobrança ou no escopo do cliente. Esse 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 do relatório detalhado. Por padrão, ActualCost é fornecido
timePeriod

CostDetailsTimePeriod

O intervalo de datas específico dos detalhes de custo solicitados para o relatório. Esse 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 um mês ou menos e não com mais de 13 meses. Se nenhum timePeriod ou billingPeriod ou invoiceId for fornecido, a API usará como padrão o período de tempo de mês aberto