Compartilhar via

az devcenter admin devbox-definition

  • Referência

Nota

Essa referência faz parte da extensão de desenvolvimento 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.

 Extensão GA
az devcenter admin devbox-definition delete

Excluir 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 a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--os-storage-type

O tipo de armazenamento usado para o disco do sistema operacional de 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 a sintaxe abreviada, arquivo json 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 dar suporte à hibernação. Para saber mais, consulte https://aka.ms/devbox/hibernate.

Valores aceitos: Disabled, Enabled
--location -l

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.

--no-wait

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

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

Marcas de recurso. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

az devcenter admin devbox-definition delete

Excluir 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

Excluir

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 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'.

--no-wait

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

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 a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em 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"

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

--next-token

Token para especificar onde iniciar a paginação. Esse é o valor do 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 a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em 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 do 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 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'.

--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 a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em 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

Atualização

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 valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

--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 em JSON.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--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 dar suporte à hibernação. Para saber mais, consulte https://aka.ms/devbox/hibernate.

Valores aceitos: Disabled, Enabled
--ids

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'.

--image-reference

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

--no-wait

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

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 de caixas de desenvolvimento criadas usando essa definição.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --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 ser definido. Exemplo: --set property1.property2=<value>.

--sku

A SKU para caixas de desenvolvimento criadas usando essa definição. Suporte a sintaxe abreviada, arquivo json 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

Marcas de recurso. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em 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é ser criado com 'provisioningState' em 'Succeeded'.

Valor padrão: False
--custom

Aguarde até que a condição atenda 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 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'.

--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 a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.