az devcenter admin devbox-definition
Note
Essa referência faz parte da extensão de devcenter para a CLI do Azure (versão 2.67.0 ou superior). A extensão instalará automaticamente a primeira vez que você executar um comando az devcenter admin devbox-definition comando. Saiba mais sobre extensões.
Gerenciar definições de caixa de desenvolvimento.
Comandos
| Nome | Description | Tipo | Status |
|---|---|---|---|
| az devcenter admin devbox-definition create |
Crie uma definição de caixa de desenvolvimento. |
Extension | GA |
| az devcenter admin devbox-definition delete |
Excluir uma definição de caixa de desenvolvimento. |
Extension | GA |
| az devcenter admin devbox-definition list |
Listar definições de caixa de desenvolvimento configuradas para um centro de desenvolvimento ou projeto. |
Extension | GA |
| az devcenter admin devbox-definition show |
Obtenha uma definição de caixa de desenvolvimento configurada para um centro de desenvolvimento ou um projeto. |
Extension | GA |
| az devcenter admin devbox-definition update |
Atualize uma definição de caixa de desenvolvimento. |
Extension | GA |
| az devcenter admin devbox-definition wait |
Coloque a CLI em um estado de espera até que uma condição seja atendida. |
Extension | GA |
az devcenter admin devbox-definition create
Crie uma definição de caixa de desenvolvimento.
az devcenter admin devbox-definition create --dev-center --dev-center-name
--devbox-definition-name --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]
Exemplos
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"
Parâmetros Exigidos
O nome do centro de desenvolvimento. Use az configure -d dev-center=<dev_center_name> para configurar um padrão.
O nome da definição da caixa de desenvolvimento.
Informações de referência de imagem. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
O tipo de armazenamento usado para o disco do sistema operacional de caixas de desenvolvimento criadas usando essa definição.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
A SKU para caixas de desenvolvimento criadas usando essa definição. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.
Indica se as caixas de desenvolvimento criadas com essa definição são capazes de hibernação. Nem todas as imagens são capazes de dar suporte à hibernação. Para saber mais, consulte https://aka.ms/devbox/hibernate.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
| Valores aceitos: | Disabled, Enabled |
A localização geográfica onde o recurso reside. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>. Quando não for especificado, o local do grupo de recursos será usado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Body Arguments |
Não aguarde a conclusão da operação de execução prolongada.
| Propriedade | Valor |
|---|---|
| Valores aceitos: | 0, 1, f, false, n, no, t, true, y, yes |
Tags de recursos. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Body Arguments |
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az devcenter admin devbox-definition delete
Excluir uma definição de caixa de desenvolvimento.
az devcenter admin devbox-definition delete [--dev-center --dev-center-name]
[--devbox-definition-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Exemplos
Delete
az devcenter admin devbox-definition delete --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.
O nome do centro de desenvolvimento. Use az configure -d dev-center=<dev_center_name> para configurar um padrão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
O nome da definição da caixa de desenvolvimento.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Não aguarde a conclusão da operação de execução prolongada.
| Propriedade | Valor |
|---|---|
| Valores aceitos: | 0, 1, f, false, n, no, t, true, y, yes |
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Não solicite confirmação.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az devcenter admin devbox-definition list
Listar definições de caixa de desenvolvimento configuradas para um centro de desenvolvimento ou projeto.
az devcenter admin devbox-definition list --resource-group
[--dev-center --dev-center-name]
[--max-items]
[--next-token]
[--project --project-name]
Exemplos
Lista por centro de desenvolvimento
az devcenter admin devbox-definition list --dev-center-name "Contoso" --resource-group "rg1"
Listar por projeto
az devcenter admin devbox-definition list --project-name "ContosoProject" --resource-group "rg1"
Parâmetros Exigidos
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.
O nome do centro de desenvolvimento. Use az configure -d dev-center=<dev_center_name> para configurar um padrão.
Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token em --next-token argumento de um comando subsequente.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Pagination Arguments |
Token para especificar onde iniciar a paginação. Esse é o valor do token de uma resposta truncada anteriormente.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Pagination Arguments |
O nome do projeto. Use az configure -d project=<project_name> para configurar um padrão.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az devcenter admin devbox-definition show
Obtenha uma definição de caixa de desenvolvimento configurada para um centro de desenvolvimento ou um projeto.
az devcenter admin devbox-definition show [--dev-center --dev-center-name]
[--devbox-definition-name --name]
[--ids]
[--project --project-name]
[--resource-group]
[--subscription]
Exemplos
Obter uma definição de caixa de desenvolvimento do centro de desenvolvimento
az devcenter admin devbox-definition show --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"
Obter uma definição de caixa de desenvolvimento do projeto
az devcenter admin devbox-definition show --name "WebDevBox" --project-name "ContosoProject" --resource-group "rg1"
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.
O nome do centro de desenvolvimento. Use az configure -d dev-center=<dev_center_name> para configurar um padrão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
O nome da definição da caixa de desenvolvimento.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
O nome do projeto. Use az configure -d project=<project_name> para configurar um padrão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az devcenter admin devbox-definition update
Atualize uma definição de caixa de desenvolvimento.
az devcenter admin devbox-definition update [--add]
[--dev-center --dev-center-name]
[--devbox-definition-name --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]
Exemplos
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"
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.
Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Generic Update Arguments |
O nome do centro de desenvolvimento. Use az configure -d dev-center=<dev_center_name> para configurar um padrão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
O nome da definição da caixa de desenvolvimento.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter em JSON.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Generic Update Arguments |
| Valores aceitos: | 0, 1, f, false, n, no, t, true, y, yes |
Indica se as caixas de desenvolvimento criadas com essa definição são capazes de hibernação. Nem todas as imagens são capazes de dar suporte à hibernação. Para saber mais, consulte https://aka.ms/devbox/hibernate.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
| Valores aceitos: | Disabled, Enabled |
Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Informações de referência de imagem. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
Não aguarde a conclusão da operação de execução prolongada.
| Propriedade | Valor |
|---|---|
| Valores aceitos: | 0, 1, f, false, n, no, t, true, y, yes |
O tipo de armazenamento usado para o disco do sistema operacional de caixas de desenvolvimento criadas usando essa definição.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Generic Update Arguments |
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Generic Update Arguments |
A SKU para caixas de desenvolvimento criadas usando essa definição. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Properties Arguments |
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Tags de recursos. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Body Arguments |
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az devcenter admin devbox-definition wait
Coloque a CLI em um estado de espera até que uma condição seja atendida.
az devcenter admin devbox-definition wait [--created]
[--custom]
[--deleted]
[--dev-center --dev-center-name]
[--devbox-definition-name --name]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.
Aguarde até ser criado com 'provisioningState' em 'Succeeded'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Valor padrão: | False |
Aguarde até que a condição atenda a uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
Aguarde até ser excluído.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Valor padrão: | False |
O nome do centro de desenvolvimento. Use az configure -d dev-center=<dev_center_name> para configurar um padrão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
O nome da definição da caixa de desenvolvimento.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Aguarde até que o recurso exista.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Valor padrão: | False |
Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Intervalo de sondagem em segundos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Valor padrão: | 30 |
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Espera máxima em segundos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Valor padrão: | 3600 |
Aguarde até que seja atualizado com provisioningState em 'Succeeded'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Valor padrão: | False |
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |