az devcenter admin pool

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 na primeira vez que você executar um comando pool de administradores do az devcenter comando. Saiba mais sobre extensões.

Gerenciar pools.

Comandos

Nome	Description	Tipo	Status
az devcenter admin pool create	Crie um pool.	Extensão	GA
az devcenter admin pool delete	Excluir um pool.	Extensão	GA
az devcenter admin pool list	Listar pools para um projeto.	Extensão	GA
az devcenter admin pool run-health-check	Dispara uma atualização do status do pool.	Extensão	GA
az devcenter admin pool show	Obtenha um pool.	Extensão	GA
az devcenter admin pool update	Atualize um pool.	Extensão	GA
az devcenter admin pool wait	Coloque a CLI em um estado de espera até que uma condição seja atendida.	Extensão	GA

az devcenter admin pool create

Crie um pool.

az devcenter admin pool create --local-administrator {Disabled, Enabled}
                               --name
                               --project
                               --resource-group
                               [--devbox-definition-image-reference]
                               [--devbox-definition-name]
                               [--devbox-definition-sku]
                               [--devbox-definition-type {Reference, Value}]
                               [--display-name]
                               [--location]
                               [--managed-virtual-network-regions]
                               [--network-connection-name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--single-sign-on-status {Disabled, Enabled}]
                               [--stop-on-disconnect]
                               [--stop-on-no-connect]
                               [--tags]
                               [--virtual-network-type {Managed, Unmanaged}]

Exemplos

Criar pool usando rede não gerenciada

az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" --virtual-network-type "Unmanaged" --single-sign-on-status "Enabled"

Criar pool usando a rede gerenciada

az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" --virtual-network-type "Managed" --managed-virtual-network-region ["westus3"] --single-sign-on-status "Enabled"

Criar um pool com o stop on disconnect habilitado

az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" --virtual-network-type "Unmanaged" --single-sign-on-status "Enabled" --stop-on-disconnect status="Enabled" grace-period-minutes="60"

Criar pool usando a definição de imagem

az devcenter admin pool create --location "eastus" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" --virtual-network-type "Unmanaged" --single-sign-on-status "Enabled" --devbox-definition-type "Value" --devbox-definition-image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/images/~Catalog~image2~project-sample-2" --devbox-definition-sku name=""general_i_8c32gb256ssd_v2"

Parâmetros Exigidos

--local-administrator

Indica se os proprietários de caixas de desenvolvimento nesse pool são adicionados como administradores locais na caixa de desenvolvimento.

Valores aceitos: Disabled, Enabled

--name --pool-name -n

Nome do pool.

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

Parâmetros Opcionais

--devbox-definition-image-reference -i

Versão Prévia

Informações de referência de imagem para uma definição dos computadores criados a partir desse pool. Será ignorado se o parâmetro devbox-definition-type for Reference ou não for fornecido. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--devbox-definition-name -d

Nome de uma definição de caixa de desenvolvimento no projeto pai desse pool. Será ignorado se o parâmetro devbox-definition-type for Value.

--devbox-definition-sku -s

Versão Prévia

A SKU para Caixas de Desenvolvimento criadas a partir do Pool. Será ignorado se o parâmetro devbox-definition-type for Reference ou não for fornecido. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--devbox-definition-type -t

Indica se o pool é criado a partir de uma Definição de Caixa de Desenvolvimento existente ou se um é fornecido diretamente.

Valores aceitos: Reference, Value

--display-name

O nome de exibição do pool.

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

--managed-virtual-network-regions -m

As regiões da rede virtual gerenciada (necessárias quando managedNetworkType é Gerenciado). Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--network-connection-name -c

Nome de uma conexão de rede no projeto pai desse pool.

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

--single-sign-on-status

Indica se as Caixas de Desenvolvimento nesse pool são criadas com logon único habilitado. Também exige que o logon único seja habilitado no locatário.

Valores aceitos: Disabled, Enabled

--stop-on-disconnect

Interrompa as configurações de desconexão das caixas de desenvolvimento criadas nesse pool. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--stop-on-no-connect

Versão Prévia

Pare sem nenhuma configuração de conexão para Caixas de Desenvolvimento criadas neste pool. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--tags

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

--virtual-network-type

Indica se o pool usa uma Rede Virtual gerenciada pela Microsoft ou uma rede fornecida pelo cliente.

Valores aceitos: Managed, Unmanaged

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 pool delete

Excluir um pool.

az devcenter admin pool delete [--ids]
                               [--name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--project]
                               [--resource-group]
                               [--subscription]
                               [--yes]

Exemplos

Excluir

az devcenter admin pool delete --name "DevPool" --project-name "DevProject" --resource-group "rg1"

Parâmetros Opcionais

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

--name --pool-name -n

Nome do pool.

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

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

--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 pool list

Listar pools para um projeto.

az devcenter admin pool list --project
                             --resource-group
                             [--max-items]
                             [--next-token]

Exemplos

Lista

az devcenter admin pool list --project-name "DevProject" --resource-group "rg1"

Parâmetros Exigidos

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

Parâmetros Opcionais

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

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 pool run-health-check

Dispara uma atualização do status do pool.

az devcenter admin pool run-health-check [--ids]
                                         [--name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--project]
                                         [--resource-group]
                                         [--subscription]

Exemplos

Executar verificação de integridade

az devcenter admin pool run-health-check --name "DevPool" --project-name "DevProject" --resource-group "rg1"

Parâmetros Opcionais

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

--name --pool-name -n

Nome do pool.

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

--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 pool show

Obtenha um pool.

az devcenter admin pool show [--ids]
                             [--name]
                             [--project]
                             [--resource-group]
                             [--subscription]

Exemplos

Obter

az admin pool show --name "DevPool" --project-name "DevProject" --resource-group "rg1"

Parâmetros Opcionais

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

--name --pool-name -n

Nome do pool.

--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 pool update

Atualize um pool.

az devcenter admin pool update [--add]
                               [--devbox-definition-image-reference]
                               [--devbox-definition-name]
                               [--devbox-definition-sku]
                               [--devbox-definition-type {Reference, Value}]
                               [--display-name]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--ids]
                               [--local-administrator {Disabled, Enabled}]
                               [--managed-virtual-network-regions]
                               [--name]
                               [--network-connection-name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--project]
                               [--remove]
                               [--resource-group]
                               [--set]
                               [--single-sign-on-status {Disabled, Enabled}]
                               [--stop-on-disconnect]
                               [--stop-on-no-connect]
                               [--subscription]
                               [--tags]
                               [--virtual-network-type {Managed, Unmanaged}]

Exemplos

Atualização

az devcenter admin pool update --devbox-definition-name "WebDevBox2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --stop-on-disconnect status="Disabled"

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

--devbox-definition-image-reference -i

Versão Prévia

Informações de referência de imagem para uma definição dos computadores criados a partir desse pool. Será ignorado se o parâmetro devbox-definition-type for Reference ou não for fornecido. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--devbox-definition-name -d

Nome de uma definição de caixa de desenvolvimento no projeto pai desse pool. Será ignorado se o parâmetro devbox-definition-type for Value.

--devbox-definition-sku -s

Versão Prévia

A SKU para Caixas de Desenvolvimento criadas a partir do Pool. Será ignorado se o parâmetro devbox-definition-type for Reference ou não for fornecido. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--devbox-definition-type -t

Indica se o pool é criado a partir de uma Definição de Caixa de Desenvolvimento existente ou se um é fornecido diretamente.

Valores aceitos: Reference, Value

--display-name

O nome de exibição do pool.

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

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

--local-administrator

Indica se os proprietários de caixas de desenvolvimento nesse pool são adicionados como administradores locais na caixa de desenvolvimento.

Valores aceitos: Disabled, Enabled

--managed-virtual-network-regions -m

As regiões da rede virtual gerenciada (necessárias quando managedNetworkType é Gerenciado). Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--name --pool-name -n

Nome do pool.

--network-connection-name -c

Nome de uma conexão de rede no projeto pai desse pool.

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

--project --project-name

O nome do projeto. Use az configure -d project=<project_name> para configurar um padrã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>.

--single-sign-on-status

Indica se as Caixas de Desenvolvimento nesse pool são criadas com logon único habilitado. Também exige que o logon único seja habilitado no locatário.

Valores aceitos: Disabled, Enabled

--stop-on-disconnect

Interrompa as configurações de desconexão das caixas de desenvolvimento criadas nesse pool. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--stop-on-no-connect

Versão Prévia

Pare sem nenhuma configuração de conexão para Caixas de Desenvolvimento criadas neste pool. 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.

--virtual-network-type

Indica se o pool usa uma Rede Virtual gerenciada pela Microsoft ou uma rede fornecida pelo cliente.

Valores aceitos: Managed, Unmanaged

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 pool wait

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

az devcenter admin pool wait [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--name]
                             [--project]
                             [--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

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

--name --pool-name -n

Nome do pool.

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

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