az devcenter dev environment
Note
This reference is part of the devcenter extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az devcenter dev environment command. Learn more about extensions.
Manage environments.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az devcenter dev environment create |
Create an environment. |
Extension | GA |
| az devcenter dev environment delay-action |
Delay an environment action. |
Extension | GA |
| az devcenter dev environment delete |
Delete an environment and all its associated resources. |
Extension | GA |
| az devcenter dev environment deploy |
Update an environment. |
Extension | GA |
| az devcenter dev environment list |
List the environments for a project or list the environments for a user within a project. |
Extension | GA |
| az devcenter dev environment list-action |
List specific environment actions. |
Extension | GA |
| az devcenter dev environment list-operation |
Lists operations on the environment which have occurred within the past 90 days. |
Extension | GA |
| az devcenter dev environment show |
Get an environment. |
Extension | GA |
| az devcenter dev environment show-action |
Retrieve a specific environment action. |
Extension | GA |
| az devcenter dev environment show-logs-by-operation |
Gets the logs for an operation on an environment. |
Extension | GA |
| az devcenter dev environment show-operation |
Gets an environment action result. |
Extension | GA |
| az devcenter dev environment show-outputs |
Gets outputs from the environment. |
Extension | GA |
| az devcenter dev environment skip-action |
Skip a specific environment action. |
Extension | GA |
| az devcenter dev environment update |
Update an environment. |
Extension | GA |
| az devcenter dev environment update-expiration-date |
Update the environment expiration. |
Extension | GA |
az devcenter dev environment create
Create an environment.
az devcenter dev environment create --catalog-name
--environment-definition-name
--environment-name
--environment-type
--project
[--dev-center]
[--endpoint]
[--expiration]
[--no-wait]
[--parameters]
[--user-id]Examples
Create using dev center
az devcenter dev environment create --dev-center-name "ContosoDevCenter" --project-name "DevProject" --catalog-name "main" --environment-definition-name "helloworld" --environment-type "DevTest" --parameters "{\"functionAppRuntime\":\"node\",\"storageAccountType\":\"Standard_LRS\"}" --name "mydevenv" --user-id "00000000-0000-0000-0000-000000000000"Create using endpoint
az devcenter dev environment create --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --catalog-name "main" --environment-definition-name "helloworld" --environment-type "DevTest" --parameters "{\"functionAppRuntime\":\"node\",\"storageAccountType\":\"Standard_LRS\"}" --name "mydevenv" --user-id "00000000-0000-0000-0000-000000000000"Required Parameters
Name of the catalog.
Name of the environment definition.
The name of the environment.
Environment type.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.
The time the expiration date will be triggered (UTC), after which the environment and associated resources will be deleted. The string format is ISO format.
Do not wait for the long-running operation to finish.
Parameters object for the environment. Expected value: json-string/json-file/@json-file.
The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter dev environment delay-action
Delay an environment action.
az devcenter dev environment delay-action --action-name
--delay-time
--environment-name
--project
[--dev-center]
[--endpoint]
[--user-id]Examples
Delay using endpoint
az devcenter dev environment delay-action --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --name "mydevenv" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000" --action-name "myEnv-Delete" --delay-time "04:30"Required Parameters
The name of an action that will take place on an environment.
The delayed timespan from the scheduled action time. Format HH:MM.
The name of the environment.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.
The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter dev environment delete
Delete an environment and all its associated resources.
az devcenter dev environment delete --environment-name
--project
[--dev-center]
[--endpoint]
[--no-wait]
[--user-id]
[--yes]Examples
Delete using dev center
az devcenter dev environment delete --dev-center-name "ContosoDevCenter" --name "mydevenv" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"Delete using endpoint
az devcenter dev environment delete --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --name "mydevenv" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"Required Parameters
The name of the environment.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.
Do not wait for the long-running operation to finish.
The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter dev environment deploy
Update an environment.
az devcenter dev environment deploy --environment-name
--project
[--dev-center]
[--endpoint]
[--expiration]
[--no-wait]
[--parameters]
[--user-id]Examples
Update using dev center
az devcenter dev environment deploy --dev-center-name "ContosoDevCenter" --project-name "DevProject" --name "mydevenv" --user-id "00000000-0000-0000-0000-000000000000" --parameters "{\"functionAppRuntime\":\"node\",\"storageAccountType\":\"Standard_LRS\"}"Update using endpoint
az devcenter dev environment deploy --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --name "mydevenv" --user-id "00000000-0000-0000-0000-000000000000" --parameters "{\"functionAppRuntime\":\"node\",\"storageAccountType\":\"Standard_LRS\"}"Required Parameters
The name of the environment.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.
The date of environment expiration. Must be an ISO string.
Do not wait for the long-running operation to finish.
Parameters object for the environment. Expected value: json-string/json-file/@json-file.
The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter dev environment list
List the environments for a project or list the environments for a user within a project.
az devcenter dev environment list --project
[--dev-center]
[--endpoint]
[--user-id]Examples
List by project using dev center
az devcenter dev environment list --dev-center-name "ContosoDevCenter" --project-name "DevProject"List by project using endpoint
az devcenter dev environment list --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject"List by user and project using dev center
az devcenter dev environment list --dev-center-name "ContosoDevCenter" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"List by user and project using endpoint
az devcenter dev environment list --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"Required Parameters
The name of the project. Use az configure -d project=<project_name> to configure a default.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.
The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter dev environment list-action
List specific environment actions.
az devcenter dev environment list-action --environment-name
--project
[--dev-center]
[--endpoint]
[--user-id]Examples
List using endpoint
az devcenter dev environment list-action --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --name "mydevenv" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"Required Parameters
The name of the environment.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.
The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter dev environment list-operation
Lists operations on the environment which have occurred within the past 90 days.
az devcenter dev environment list-operation --environment-name
--project
[--dev-center]
[--endpoint]
[--user-id]Examples
List using endpoint
az devcenter dev environment list-operation --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --name "mydevenv" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"Required Parameters
The name of the environment.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.
The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter dev environment show
Get an environment.
az devcenter dev environment show --environment-name
--project
[--dev-center]
[--endpoint]
[--user-id]Examples
Get using endpoint
az devcenter dev environment show --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --name "mydevenv" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"Required Parameters
The name of the environment.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.
The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter dev environment show-action
Retrieve a specific environment action.
az devcenter dev environment show-action --action-name
--environment-name
--project
[--dev-center]
[--endpoint]
[--user-id]Examples
Get using endpoint
az devcenter dev environment show-action --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --name "mydevenv" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000" --action-name "myEnv-Delete"Required Parameters
The name of an action that will take place on an environment.
The name of the environment.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.
The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter dev environment show-logs-by-operation
Gets the logs for an operation on an environment.
az devcenter dev environment show-logs-by-operation --environment-name
--operation-id
--project
[--dev-center]
[--endpoint]
[--user-id]Examples
Get using endpoint
az devcenter dev environment show-logs-by-operation --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --name "mydevenv" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000" --operation-id "f5dbdfab-fa0e-4831-8d13-25359aa5e680"Required Parameters
The name of the environment.
The ID of the operation.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.
The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter dev environment show-operation
Gets an environment action result.
az devcenter dev environment show-operation --environment-name
--operation-id
--project
[--dev-center]
[--endpoint]
[--user-id]Examples
Get using endpoint
az devcenter dev environment show-operation --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --name "mydevenv" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000" --operation-id "f5dbdfab-fa0e-4831-8d13-25359aa5e680"Required Parameters
The name of the environment.
The ID of the operation.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.
The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter dev environment show-outputs
Gets outputs from the environment.
az devcenter dev environment show-outputs --environment-name
--project
[--dev-center]
[--endpoint]
[--user-id]Examples
Get using endpoint
az devcenter dev environment show-outputs --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --name "mydevenv" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"Required Parameters
The name of the environment.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.
The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter dev environment skip-action
Skip a specific environment action.
az devcenter dev environment skip-action --action-name
--environment-name
--project
[--dev-center]
[--endpoint]
[--user-id]Examples
Skip using endpoint
az devcenter dev environment skip-action --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --name "mydevenv" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000" --action-name "myEnv-Delete"Required Parameters
The name of an action that will take place on an environment.
The name of the environment.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.
The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter dev environment update
Update an environment.
az devcenter dev environment update --environment-name
--project
[--dev-center]
[--endpoint]
[--expiration]
[--no-wait]
[--parameters]
[--user-id]Examples
Update using dev center
az devcenter dev environment update --dev-center-name "ContosoDevCenter" --project-name "DevProject" --name "mydevenv" --user-id "00000000-0000-0000-0000-000000000000" --parameters "{\"functionAppRuntime\":\"node\",\"storageAccountType\":\"Standard_LRS\"}"Update using endpoint
az devcenter dev environment update --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --name "mydevenv" --user-id "00000000-0000-0000-0000-000000000000" --parameters "{\"functionAppRuntime\":\"node\",\"storageAccountType\":\"Standard_LRS\"}"Required Parameters
The name of the environment.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.
The date of environment expiration. Must be an ISO string.
Do not wait for the long-running operation to finish.
Parameters object for the environment. Expected value: json-string/json-file/@json-file.
The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter dev environment update-expiration-date
Update the environment expiration.
az devcenter dev environment update-expiration-date --environment-name
--project
[--dev-center]
[--endpoint]
[--expiration]
[--user-id]Examples
Get using endpoint
az devcenter dev environment update-expiration-date --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --name "mydevenv" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000" --expiration "2025-11-30T22:35:00+00:00"Required Parameters
The name of the environment.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.
The time the expiration date will be triggered (UTC), after which the environment and associated resources will be deleted. The string format is ISO format.
The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for