Compartilhar via

az devcenter admin devbox-definition

  • Referência

Observação

Essa referência faz parte da extensão devcenter para a CLI do Azure (versão 2.51.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az devcenter admin devbox-definition . 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.

 Extensão GA
az devcenter admin devbox-definition delete

Exclua uma definição de caixa de desenvolvimento.

 Extensão GA
az devcenter admin devbox-definition list

Listar definições de caixa de desenvolvimento configuradas para um centro de desenvolvimento ou projeto.

 Extensão GA
az devcenter admin devbox-definition show

Obtenha uma definição de caixa de desenvolvimento configurada para um centro de desenvolvimento ou um projeto.

 Extensão GA
az devcenter admin devbox-definition update

Atualize uma definição de caixa de desenvolvimento.

 Extensão GA
az devcenter admin devbox-definition wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

 Extensão GA

az devcenter admin devbox-definition create

Crie uma definição de caixa de desenvolvimento.

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]

Exemplos

Criar

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

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

O nome do centro de desenvolvimento. Use az configure -d dev-center=<dev_center_name> para configurar um padrão.

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

O nome da definição da caixa de desenvolvimento.

--image-reference

Informações de referência de imagem. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--os-storage-type

O tipo de armazenamento usado para o disco do sistema operacional das caixas de desenvolvimento criadas usando essa definição.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--sku

A SKU para caixas de desenvolvimento criadas usando essa definição. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros Opcionais

--hibernate-support

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 suportar hibernação. Para saber mais veja https://aka.ms/devbox/hibernate.

valores aceitos: Disabled, Enabled
--location -l

A geolocalização onde o recurso vive. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>. Quando não especificado, o local do grupo de recursos será usado.

--no-wait

Não aguarde a conclusão da operação de execução longa.

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

Tags de recursos. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az devcenter admin devbox-definition delete

Exclua uma definição de caixa de desenvolvimento.

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]

Exemplos

Delete

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

Parâmetros Opcionais

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

O nome do centro de desenvolvimento. Use az configure -d dev-center=<dev_center_name> para configurar um padrão.

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

O nome da definição da caixa de desenvolvimento.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--no-wait

Não aguarde a conclusão da operação de execução longa.

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

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--yes -y

Não solicite confirmação.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

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]
                                          [--max-items]
                                          [--next-token]
                                          [--project]

Exemplos

Lista por centro de desenvolvimento

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

Lista por projeto

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

Parâmetros Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

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

O nome do centro de desenvolvimento. Use az configure -d dev-center=<dev_center_name> para configurar um padrão.

--max-items

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 no --next-token argumento de um comando subsequente.

--next-token

Token para especificar onde iniciar a paginação. Esse é o valor de token de uma resposta truncada anteriormente.

--project --project-name

O nome do projeto. Use az configure -d project=<project_name> para configurar um padrão.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

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]
                                          [--devbox-definition-name]
                                          [--ids]
                                          [--project]
                                          [--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 de projeto

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

Parâmetros Opcionais

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

O nome do centro de desenvolvimento. Use az configure -d dev-center=<dev_center_name> para configurar um padrão.

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

O nome da definição da caixa de desenvolvimento.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--project --project-name

O nome do projeto. Use az configure -d project=<project_name> para configurar um padrão.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az devcenter admin devbox-definition update

Atualize uma definição de caixa de desenvolvimento.

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]

Exemplos

Atualizar

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

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string ou cadeia de caracteres> JSON.

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

O nome do centro de desenvolvimento. Use az configure -d dev-center=<dev_center_name> para configurar um padrão.

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

O nome da definição da caixa de desenvolvimento.

--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.

valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--hibernate-support
Versão Prévia

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 suportar hibernação. Para saber mais veja https://aka.ms/devbox/hibernate.

valores aceitos: Disabled, Enabled
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--image-reference

Informações de referência de imagem. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--no-wait

Não aguarde a conclusão da operação de execução longa.

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

O tipo de armazenamento usado para o disco do sistema operacional das caixas de desenvolvimento criadas usando essa definição.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list OU --remove propertyToRemove.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=.

--sku

A SKU para caixas de desenvolvimento criadas usando essa definição. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--tags

Tags de recursos. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

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]
                                          [--devbox-definition-name]
                                          [--exists]
                                          [--ids]
                                          [--interval]
                                          [--resource-group]
                                          [--subscription]
                                          [--timeout]
                                          [--updated]

Parâmetros Opcionais

--created

Aguarde até criar com 'provisioningState' em 'Succeeded'.

valor padrão: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

valor padrão: False
--dev-center --dev-center-name -d

O nome do centro de desenvolvimento. Use az configure -d dev-center=<dev_center_name> para configurar um padrão.

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

O nome da definição da caixa de desenvolvimento.

--exists

Aguarde até que o recurso exista.

valor padrão: False
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--interval

Intervalo de sondagem em segundos.

valor padrão: 30
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--timeout

Espera máxima em segundos.

valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.