Generate Detailed Cost Report Operation Status - Get

Reference

Service:: Cost Management

API Version:: 2023-11-01

Get the status of the specified operation. This link is provided in the GenerateDetailedCostReport creation request response header.

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

URI Parameters

Name	In	Required	Type	Description
operationId	path	True	string	The target operation Id.
scope	path	True	string	The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	GenerateDetailedCostReportOperationStatuses	OK. The request has succeeded.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get details of the operation status

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationStatus/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "type": "Microsoft.Consumption/operationStatus",
  "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"
  },
  "error": {
    "code": "0",
    "message": null
  }
}

Definitions

Name	Description
ErrorDetails	The details of the error.
ErrorResponse	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. Some Error responses: 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header. 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.
GenerateDetailedCostReportOperationStatuses	The status of the long running operation for cost detailed report.
ReportOperationStatusType	The status of the long running operation.
Status	The status of the long running operation.

ErrorDetails

The details of the error.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

ErrorResponse

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Some Error responses:

429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header.
503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.

Name	Type	Description
error	ErrorDetails	The details of the error.

GenerateDetailedCostReportOperationStatuses

The status of the long running operation for cost detailed report.

Name	Type	Description
endTime	string	The endTime of the operation.
error	ErrorDetails	The details of the error.
id	string	The ID of the long running operation.
name	string	The name of the long running operation.
properties.downloadUrl	string	The URL to download the generated report.
properties.expiryTime	string	The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.
properties.validTill	string	The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.
startTime	string	The startTime of the operation.
status	Status	The status of the long running operation.
type	string	The type of the long running operation.

ReportOperationStatusType

The status of the long running operation.

Name	Type	Description
Completed	string
Failed	string
InProgress	string
NoDataFound	string
Queued	string
ReadyToDownload	string
TimedOut	string

Status