az devcenter admin devbox-definition
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 admin devbox-definition command. Learn more about extensions.
Manage dev box definitions.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az devcenter admin devbox-definition create |
Create a dev box definition. |
Extension | GA |
| az devcenter admin devbox-definition delete |
Delete a dev box definition. |
Extension | GA |
| az devcenter admin devbox-definition list |
List dev box definitions configured for a dev center or project. |
Extension | GA |
| az devcenter admin devbox-definition show |
Get a dev box definition configured for a dev center or a project. |
Extension | GA |
| az devcenter admin devbox-definition update |
Update a dev box definition. |
Extension | GA |
| az devcenter admin devbox-definition wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az devcenter admin devbox-definition create
Create a dev box definition.
az devcenter admin devbox-definition create --dev-center
--devbox-definition-name
--image-reference
--os-storage-type
--resource-group
--sku
[--hibernate-support {Disabled, Enabled}]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--tags]Examples
Create
az devcenter admin devbox-definition create --location "eastus" --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" --os-storage-type "ssd_1024gb" --sku name="general_a_8c32gb_v1" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"Required Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The name of the dev box definition.
Image reference information. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The storage type used for the operating system disk of dev boxes created using this definition.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The SKU for dev boxes created using this definition. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Optional Parameters
Indicates whether dev boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate.
The geo-location where the resource lives. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>. When not specified, the location of the resource group will be used.
Do not wait for the long-running operation to finish.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 admin devbox-definition delete
Delete a dev box definition.
az devcenter admin devbox-definition delete [--dev-center]
[--devbox-definition-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]Examples
Delete
az devcenter admin devbox-definition delete --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The name of the dev box definition.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 admin devbox-definition list
List dev box definitions configured for a dev center or project.
az devcenter admin devbox-definition list --resource-group
[--dev-center]
[--max-items]
[--next-token]
[--project]Examples
List by dev center
az devcenter admin devbox-definition list --dev-center-name "Contoso" --resource-group "rg1"List by project
az devcenter admin devbox-definition list --project-name "ContosoProject" --resource-group "rg1"Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
The name of the project. Use az configure -d project=<project_name> to configure a default.
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 admin devbox-definition show
Get a dev box definition configured for a dev center or a project.
az devcenter admin devbox-definition show [--dev-center]
[--devbox-definition-name]
[--ids]
[--project]
[--resource-group]
[--subscription]Examples
Get a dev center dev box definition
az devcenter admin devbox-definition show --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"Get a project dev box definition
az devcenter admin devbox-definition show --name "WebDevBox" --project-name "ContosoProject" --resource-group "rg1"Optional Parameters
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The name of the dev box definition.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 admin devbox-definition update
Update a dev box definition.
az devcenter admin devbox-definition update [--add]
[--dev-center]
[--devbox-definition-name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--hibernate-support {Disabled, Enabled}]
[--ids]
[--image-reference]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--os-storage-type]
[--remove]
[--resource-group]
[--set]
[--sku]
[--subscription]
[--tags]Examples
Update
az devcenter admin devbox-definition update --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The name of the dev box definition.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Indicates whether dev boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Image reference information. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
The storage type used for the operating system disk of dev boxes created using this definition.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
The SKU for dev boxes created using this definition. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 admin devbox-definition wait
Place the CLI in a waiting state until a condition is met.
az devcenter admin devbox-definition wait [--created]
[--custom]
[--deleted]
[--dev-center]
[--devbox-definition-name]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.
The name of the dev box definition.
Wait until the resource exists.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
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