Compartilhar via

az devcenter admin pool

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

Aciona uma atualização do status do pool.

 Extensão GA
az devcenter admin pool show

Pegue uma piscina.

 Extensão GA
az devcenter admin pool update

Atualizar 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 --devbox-definition-name
                               --local-administrator {Disabled, Enabled}
                               --name
                               --project
                               --resource-group
                               [--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]
                               [--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 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 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"

Parâmetros Exigidos

--devbox-definition-name -d

Nome de uma definição de caixa de desenvolvimento no projeto pai deste pool.

--local-administrator

Indica se os proprietários de caixas de desenvolvimento neste 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

--display-name

O nome de exibição do pool.

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

--managed-virtual-network-regions -m

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

--network-connection-name -c

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

--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
--single-sign-on-status

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

valores aceitos: Disabled, Enabled
--stop-on-disconnect
Versão Prévia

Pare ao desconectar as definições de configuração para caixas de desenvolvimento criadas neste pool. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--tags

Tags de recursos. Suporte taquigráfico-sintaxe, json-file 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 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 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 do recurso".

--name --pool-name -n

Nome do pool.

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

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

Aciona 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 do recurso".

--name --pool-name -n

Nome do pool.

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

Pegue uma piscina.

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

Atualizar um pool.

az devcenter admin pool update [--add]
                               [--devbox-definition-name]
                               [--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]
                               [--subscription]
                               [--tags]
                               [--virtual-network-type {Managed, Unmanaged}]

Exemplos

Atualizar

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

--devbox-definition-name -d

Nome de uma definição de caixa de desenvolvimento no projeto pai deste pool.

--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 para 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 do recurso".

--local-administrator

Indica se os proprietários de caixas de desenvolvimento neste 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ário quando managedNetworkType é Gerenciado). Suporte taquigráfico-sintaxe, json-file 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 deste pool.

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

--single-sign-on-status

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

valores aceitos: Disabled, Enabled
--stop-on-disconnect
Versão Prévia

Pare ao desconectar as definições de configuração para caixas de desenvolvimento criadas neste pool. 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.

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