Share via

Environments - Delay Action

  • Reference
Service:
Dev Center
API Version:
2024-02-01

Delays the occurrence of an action.

POST {endpoint}/projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}:delay?api-version=2024-02-01&until={until}

URI Parameters

Name In Required Type Description
actionName
 path True

string

Uniquely identifies the action.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
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}$
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.
until
 query True

string

date-time

The time to delay the Environment action until, in RFC3339 format.

Responses

Name Type Description
200 OK

EnvironmentAction

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

Delays the occurrence of an action.

Sample request

POST https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/me/environments/myEnv/actions/default:delay?api-version=2024-02-01&until=2022-09-30T17:00:00Z

Sample response

Status code:
200 
{
  "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default",
  "name": "default",
  "actionType": "Delete",
  "next": {
    "scheduledTime": "2023-09-30T17:00:00Z"
  },
  "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98",
  "lastModifiedAt": "2023-09-10T17:00:00Z"
}

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

An upcoming Environment Action.
EnvironmentActionType

The scheduled action types.
EnvironmentNextAction

Details about the next run of an action.

Azure.Core.Foundations.Error

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

A response containing error details.

Name Type Description
error

Azure.Core.Foundations.Error

The error object.

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.

Name Type Description
code

string

One of a server-defined set of error codes.
innererror

Azure.Core.Foundations.InnerError

Inner error.

EnvironmentAction

An upcoming Environment Action.

Name Type Description
actionType

EnvironmentActionType

The action that will be taken.
lastModifiedAt

string

Time the object was last modified, in RFC3339 format.
lastModifiedBy

string

Object Id of the user who last modified the action.
name

string

Uniquely identifies the action.
next

EnvironmentNextAction

Details about the next run of this action.
uri

string

Uri of the action resource.

EnvironmentActionType

The scheduled action types.

Name Type Description
Delete

string

The action will delete the environment and associated resources.

EnvironmentNextAction

Details about the next run of an action.

Name Type Description
scheduledTime

string

The time the action will be triggered (UTC), in RFC3339 format.