Environments - Get Operation

Service:

Dev Center

API Version:

2025-02-01

Gets an environment action result.

GET {endpoint}/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{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.
environmentName	path	True	string	Environment name. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
operationId	path	True	string uuid	Unique identifier for the environment operation. Regex pattern: ^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$
projectName	path	True	string	Name of the project. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
userId	path	True	string	The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Regex pattern: ^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	EnvironmentOperation: EnvironmentDeleteOperation EnvironmentDeployOperation	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

Gets an environment action result.

Sample request

HTTP

GET https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/me/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680?api-version=2025-02-01

Sample response

Status code:

200

{
  "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680",
  "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680",
  "status": "Succeeded",
  "kind": "Deploy",
  "environmentParameters": {
    "paramA": "valueA",
    "paramB": "valueB"
  },
  "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93",
  "startTime": "2022-09-06T16:58:51.7229492+00:00",
  "endTime": "2022-09-06T16:59:51.7229492+00:00"
}

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/Guidelines.md#7102-error-condition-responses.
EnvironmentDeleteOperation	Information about a delete operation on an environment.
EnvironmentDeployOperation	Information about a deploy operation on an environment.
EnvironmentOperationKind	The type of environment operation.
OperationState	Provisioning state of the resource.

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/Guidelines.md#7102-error-condition-responses.

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

EnvironmentDeleteOperation

Object

Information about a delete operation on an environment.

Name	Type	Description
createdByObjectId	string	The object ID of the actor which initiated the operation.
endTime	string	The time the operation finished, in RFC3339 format.
environmentParameters		Parameters object for the environment at the time of the operation.
error	Azure.Core.Foundations.Error	Provisioning or operation error details. Populated only for error states.
kind	string: Delete	The kind of operation that occurred.
operationId	string	Unique identifier for the environment operation.
startTime	string	The time the operation started, in RFC3339 format.
status	OperationState	The operation status.
uri	string	The unique URI for the environment operation.

EnvironmentDeployOperation

Object

Information about a deploy operation on an environment.

Name	Type	Description
createdByObjectId	string	The object ID of the actor which initiated the operation.
endTime	string	The time the operation finished, in RFC3339 format.
environmentParameters		Parameters object for the environment at the time of the operation.
error	Azure.Core.Foundations.Error	Provisioning or operation error details. Populated only for error states.
kind	string: Deploy	The kind of operation that occurred.
operationId	string	Unique identifier for the environment operation.
startTime	string	The time the operation started, in RFC3339 format.
status	OperationState	The operation status.
uri	string	The unique URI for the environment operation.

EnvironmentOperationKind

Enumeration

The type of environment operation.

Value	Description
Delete	The operation represents a delete.
Deploy	The operation represents a deployment.

OperationState

Enumeration

Provisioning state of the resource.

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