Operation Statuses - Get

Service:

Dev Center

API Version:

2025-02-01

Get the status of an operation.

GET {endpoint}/projects/{projectName}/operationstatuses/{operationId}?api-version=2025-02-01

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)	The DevCenter-specific URI to operate on.
operationId	path	True	string (uuid) minLength: 36 maxLength: 36 pattern: ^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$	The operation id name.
projectName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	Name of the project.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	OperationStatus	The request has succeeded.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Security

OAuth2Auth

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

Scopes

Name	Description
https://devcenter.azure.com/.default

Examples

Get the status of an operation.

Sample request

HTTP

GET {endpoint}/projects/myProject/operationstatuses/fa067167-e49d-41bd-8dd8-de719b9de3b3?api-version=2025-02-01

Sample response

Status code:

200

{
  "id": "/projects/myProject/operationStatuses/fa067167-e49d-41bd-8dd8-de719b9de3b3",
  "name": "fa067167-e49d-41bd-8dd8-de719b9de3b3",
  "status": "Running",
  "startTime": "2024-01-24T21:14:58.472Z"
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
OperationState	Provisioning state of the resource.
OperationStatus	The current status of an async operation.

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

OperationState

Enumeration

Provisioning state of the resource.

Value	Description
NotStarted	The operation has not started.
Running	The operation is in progress.
Succeeded	The operation has completed successfully.
Failed	The operation has failed.
Canceled	The operation has been canceled by the user.

OperationStatus

Object

The current status of an async operation.

Name	Type	Description
endTime	string (date-time)	The end time of the operation, in RFC3339 format.
error	Azure.Core.Foundations.Error	Operation Error message.
id	string	Fully qualified ID for the operation status.
name	string (uuid) minLength: 36 maxLength: 36 pattern: ^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$	The operation id name.
percentComplete	number (double) minimum: 0 maximum: 100	Percent of the operation that is complete.
properties		Custom operation properties, populated only for a successful operation.
resourceId	string	The id of the resource.
startTime	string (date-time)	The start time of the operation, in RFC3339 format.
status	OperationState	Provisioning state of the resource.