Compartir a través de

az devcenter admin devbox-definition

  • Referencia

Nota:

Esta referencia forma parte de la extensión de devcenter para la CLI de Azure (versión 2.51.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az devcenter admin devbox-definition . Obtenga más información sobre las extensiones.

Administrar definiciones de cuadros de desarrollo.

Comandos

Nombre Description Tipo Estado
az devcenter admin devbox-definition create

Cree una definición de cuadro de desarrollo.

 Extensión GA
az devcenter admin devbox-definition delete

Elimina una definición de cuadro de desarrollo.

 Extensión GA
az devcenter admin devbox-definition list

Enumera las definiciones del cuadro de desarrollo configuradas para un centro de desarrollo o un proyecto.

 Extensión GA
az devcenter admin devbox-definition show

Obtiene una definición de cuadro de desarrollo configurada para un centro de desarrollo o un proyecto.

 Extensión GA
az devcenter admin devbox-definition update

Actualice una definición de cuadro de desarrollo.

 Extensión GA
az devcenter admin devbox-definition wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición.

 Extensión GA

az devcenter admin devbox-definition create

Cree una definición de cuadro de desarrollo.

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]

Ejemplos

Crear

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"

Parámetros requeridos

--dev-center --dev-center-name -d

Nombre del centro de desarrollo. Use az configure -d dev-center=<dev_center_name> para configurar un valor predeterminado.

--devbox-definition-name --name -n

Nombre de la definición del cuadro de desarrollo.

--image-reference

Información de referencia de imagen. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--os-storage-type

El tipo de almacenamiento usado para el disco del sistema operativo de los cuadros de desarrollo creados mediante esta definición.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--sku

La SKU para los cuadros de desarrollo creados con esta definición. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Parámetros opcionales

--hibernate-support

Indica si los cuadros de desarrollo creados con esta definición son capaces de hibernación. No todas las imágenes son capaces de admitir la hibernación. Para obtener más información, consulte https://aka.ms/devbox/hibernate.

valores aceptados: Disabled, Enabled
--location -l

Ubicación geográfica donde reside el recurso. Los valores de: az account list-locations. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>. Cuando no se especifique, se usará la ubicación del grupo de recursos.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--tags

Etiquetas del recurso. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az devcenter admin devbox-definition delete

Elimina una definición de cuadro de desarrollo.

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]

Ejemplos

Eliminar

az devcenter admin devbox-definition delete --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

Parámetros opcionales

--dev-center --dev-center-name -d

Nombre del centro de desarrollo. Use az configure -d dev-center=<dev_center_name> para configurar un valor predeterminado.

--devbox-definition-name --name -n

Nombre de la definición del cuadro de desarrollo.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--yes -y

No solicita confirmación.

valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az devcenter admin devbox-definition list

Enumera las definiciones del cuadro de desarrollo configuradas para un centro de desarrollo o un proyecto.

az devcenter admin devbox-definition list --resource-group
                                          [--dev-center]
                                          [--max-items]
                                          [--next-token]
                                          [--project]

Ejemplos

Enumerar por centro de desarrollo

az devcenter admin devbox-definition list --dev-center-name "Contoso" --resource-group "rg1"

Enumerar por proyecto

az devcenter admin devbox-definition list --project-name "ContosoProject" --resource-group "rg1"

Parámetros requeridos

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--dev-center --dev-center-name -d

Nombre del centro de desarrollo. Use az configure -d dev-center=<dev_center_name> para configurar un valor predeterminado.

--max-items

Número total de elementos que se van a devolver en la salida del comando. Si el número total de elementos disponibles es mayor que el valor especificado, se proporciona un token en la salida del comando. Para reanudar la paginación, proporcione el valor del token en --next-token el argumento de un comando posterior.

--next-token

Token para especificar dónde iniciar la paginación. Este es el valor del token de una respuesta truncada anteriormente.

--project --project-name

Nombre del proyecto. Use az configure -d project=<project_name> para configurar un valor predeterminado.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az devcenter admin devbox-definition show

Obtiene una definición de cuadro de desarrollo configurada para un centro de desarrollo o un proyecto.

az devcenter admin devbox-definition show [--dev-center]
                                          [--devbox-definition-name]
                                          [--ids]
                                          [--project]
                                          [--resource-group]
                                          [--subscription]

Ejemplos

Obtención de una definición de cuadro de desarrollo del centro de desarrollo

az devcenter admin devbox-definition show --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

Obtención de una definición de cuadro de desarrollo de proyecto

az devcenter admin devbox-definition show --name "WebDevBox" --project-name "ContosoProject" --resource-group "rg1"

Parámetros opcionales

--dev-center --dev-center-name -d

Nombre del centro de desarrollo. Use az configure -d dev-center=<dev_center_name> para configurar un valor predeterminado.

--devbox-definition-name --name -n

Nombre de la definición del cuadro de desarrollo.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--project --project-name

Nombre del proyecto. Use az configure -d project=<project_name> para configurar un valor predeterminado.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az devcenter admin devbox-definition update

Actualice una definición de cuadro de desarrollo.

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]

Ejemplos

Actualizar

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"

Parámetros opcionales

--add

Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string o JSON string>.

--dev-center --dev-center-name -d

Nombre del centro de desarrollo. Use az configure -d dev-center=<dev_center_name> para configurar un valor predeterminado.

--devbox-definition-name --name -n

Nombre de la definición del cuadro de desarrollo.

--force-string

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--hibernate-support
Vista previa

Indica si los cuadros de desarrollo creados con esta definición son capaces de hibernación. No todas las imágenes son capaces de admitir la hibernación. Para obtener más información, consulte https://aka.ms/devbox/hibernate.

valores aceptados: Disabled, Enabled
--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--image-reference

Información de referencia de imagen. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--os-storage-type

El tipo de almacenamiento usado para el disco del sistema operativo de los cuadros de desarrollo creados mediante esta definición.

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=.

--sku

La SKU para los cuadros de desarrollo creados con esta definición. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--tags

Etiquetas del recurso. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az devcenter admin devbox-definition wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición.

az devcenter admin devbox-definition wait [--created]
                                          [--custom]
                                          [--deleted]
                                          [--dev-center]
                                          [--devbox-definition-name]
                                          [--exists]
                                          [--ids]
                                          [--interval]
                                          [--resource-group]
                                          [--subscription]
                                          [--timeout]
                                          [--updated]

Parámetros opcionales

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

valor predeterminado: False
--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Espere hasta que se elimine.

valor predeterminado: False
--dev-center --dev-center-name -d

Nombre del centro de desarrollo. Use az configure -d dev-center=<dev_center_name> para configurar un valor predeterminado.

--devbox-definition-name --name -n

Nombre de la definición del cuadro de desarrollo.

--exists

Espere hasta que exista el recurso.

valor predeterminado: False
--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--interval

Intervalo de sondeo en segundos.

valor predeterminado: 30
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--timeout

Espera máxima en segundos.

valor predeterminado: 3600
--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.