Generate Cost Details Report - Get Operation Results

Referência

Serviço:: Cost Management

Versão da API:: 2023-11-01

Obtenha o resultado da operação especificada. Esta ligação é fornecida no cabeçalho localização da resposta do pedido de criação CostDetails.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
operationId	path	True	string	O ID da operação de destino.
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.

Respostas

Name	Tipo	Description
200 OK	CostDetailsOperationResults	OK. O pedido foi efetuada com êxito.
202 Accepted		Aceite. A operação está em curso.
Other Status Codes	ErrorResponse	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

Get details of the operation result

Pedido de amostra

HTTP

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

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

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.
ErrorResponse	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: 429 TooManyRequests – o pedido é limitado. Repita 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 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.

ErrorResponse

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:

429 TooManyRequests – o pedido é limitado. Repita 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 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

Partilhar via