Partilhar via

az desktopvirtualization hostpool

  • Referência

Nota

Essa referência faz parte da extensão desktopvirtualization para a CLI do Azure (versão 2.55.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az desktopvirtualization hostpool . Saiba mais sobre extensões.

Gerencie o pool de hosts de virtualização de desktop.

Comandos

Name Description Tipo Estado
az desktopvirtualization hostpool create

Crie um pool de hosts.

 Extensão GA
az desktopvirtualization hostpool delete

Exclua um pool de hosts.

 Extensão GA
az desktopvirtualization hostpool list

Listar pools de hosts.

 Extensão GA
az desktopvirtualization hostpool retrieve-registration-token

Token de registro do pool de hosts.

 Extensão GA
az desktopvirtualization hostpool show

Mostrar um pool de hosts.

 Extensão GA
az desktopvirtualization hostpool update

Atualize um pool de hosts.

 Extensão GA

az desktopvirtualization hostpool create

Crie um pool de hosts.

az desktopvirtualization hostpool create --host-pool-type {BYODesktop, Personal, Pooled}
                                         --load-balancer-type {BreadthFirst, DepthFirst, Persistent}
                                         --name
                                         --preferred-app-group-type {Desktop, None, RailApplications}
                                         --resource-group
                                         [--custom-rdp-property]
                                         [--description]
                                         [--friendly-name]
                                         [--location]
                                         [--max-session-limit]
                                         [--personal-desktop-assignment-type {Automatic, Direct}]
                                         [--registration-info]
                                         [--ring]
                                         [--sso-client-id]
                                         [--sso-client-secret-key-vault-path]
                                         [--sso-secret-type {Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault}]
                                         [--ssoadfs-authority]
                                         [--start-vm-on-connect {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--tags]
                                         [--validation-environment {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--vm-template]

Exemplos

Criar pool de hosts

az desktopvirtualization hostpool create -g rg -n hostpool-name --friendly-name friendly --host-pool-type Pooled --load-balancer-type BreadthFirst --max-session-limit 999999 --personal-desktop-assignment-type Automatic --preferred-app-group-type Desktop --registration-info expiration-time="yyyy-mm-ddT08:38:08.189Z" registration-token-operation=Update --sso-client-id client --sso-client-secret-key-vault-path https://keyvault/secret --sso-secret-type SharedKey --start-vm-on-connect false

Parâmetros Obrigatórios

--host-pool-type

Tipo de pool de hosts para área de trabalho.

valores aceites: BYODesktop, Personal, Pooled
--load-balancer-type

O tipo do balanceador de carga.

valores aceites: BreadthFirst, DepthFirst, Persistent
--name -n

O nome do pool de hosts dentro do grupo de recursos especificado.

--preferred-app-group-type -t

O tipo de grupo de aplicativos preferido, padrão para o grupo de aplicativos da área de trabalho.

valores aceites: Desktop, None, RailApplications
--resource-group -g

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

Parâmetros Opcionais

--custom-rdp-property

Propriedade rdp personalizada do pool de hosts.

--description

Descrição de HostPool.

--friendly-name

Nome amigável de HostPool.

--location -l

A geolocalização onde o recurso vive.

--max-session-limit

O limite máximo de sessão do HostPool.

--personal-desktop-assignment-type

Tipo PersonalDesktopAssignment para HostPool.

valores aceites: Automatic, Direct
--registration-info

As informações de registro do HostPool. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--ring

O número do anel de HostPool.

--sso-client-id

ClientId para a Terceira Parte Confiável registrada usada para emitir certificados SSO WVD.

--sso-client-secret-key-vault-path -p

Caminho para o Azure KeyVault armazenando o segredo usado para comunicação com o ADFS.

--sso-secret-type

O tipo de sinal único no Tipo Secreto.

valores aceites: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL para o servidor ADFS do cliente para assinar certificados SSO WVD.

--start-vm-on-connect

O sinalizador para ativar/desativar o recurso StartVMOnConnect.

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

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

--validation-environment

É ambiente de validação.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

Modelo de VM para configuração de hosts de sessão dentro do hostpool.

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az desktopvirtualization hostpool delete

Exclua um pool de hosts.

az desktopvirtualization hostpool delete [--force {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ids]
                                         [--name]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

Exemplos

Excluir pool de hosts

az desktopvirtualization hostpool delete -g rg -n hostpool-name

Parâmetros Opcionais

--force

Sinalizador de força para excluir sessionHost.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--ids

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

--name -n

O nome do pool de hosts dentro do grupo de recursos especificado.

--resource-group -g

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--yes -y

Não solicite confirmação.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az desktopvirtualization hostpool list

Listar pools de hosts.

az desktopvirtualization hostpool list [--max-items]
                                       [--next-token]
                                       [--resource-group]

Exemplos

Listar pool de hosts

az desktopvirtualization hostpool list -g rg

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 por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az desktopvirtualization hostpool retrieve-registration-token

Token de registro do pool de hosts.

az desktopvirtualization hostpool retrieve-registration-token [--ids]
                                                              [--name]
                                                              [--resource-group]
                                                              [--subscription]

Exemplos

Token de registro do pool de hosts.

az desktopvirtualization hostpool retrieve-registration-token -n hostpool-name -g rg

Parâmetros Opcionais

--ids

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

--name -n

O nome do pool de hosts dentro do grupo de recursos especificado.

--resource-group -g

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az desktopvirtualization hostpool show

Mostrar um pool de hosts.

az desktopvirtualization hostpool show [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]

Exemplos

Mostrar piscina de anfitriões

az desktopvirtualization hostpool show -g rg -n hostpool-name

Parâmetros Opcionais

--ids

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

--name -n

O nome do pool de hosts dentro do grupo de recursos especificado.

--resource-group -g

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az desktopvirtualization hostpool update

Atualize um pool de hosts.

az desktopvirtualization hostpool update [--add]
                                         [--custom-rdp-property]
                                         [--description]
                                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--friendly-name]
                                         [--ids]
                                         [--load-balancer-type {BreadthFirst, DepthFirst, Persistent}]
                                         [--max-session-limit]
                                         [--name]
                                         [--personal-desktop-assignment-type {Automatic, Direct}]
                                         [--preferred-app-group-type {Desktop, None, RailApplications}]
                                         [--registration-info]
                                         [--remove]
                                         [--resource-group]
                                         [--ring]
                                         [--set]
                                         [--sso-client-id]
                                         [--sso-client-secret-key-vault-path]
                                         [--sso-secret-type {Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault}]
                                         [--ssoadfs-authority]
                                         [--start-vm-on-connect {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--subscription]
                                         [--tags]
                                         [--validation-environment {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--vm-template]

Exemplos

Atualizar pool de hosts

az desktopvirtualization hostpool update -g rg -n hostpool-name --tags tag=test

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 ou JSON string>.

--custom-rdp-property

Propriedade rdp personalizada do pool de hosts.

--description

Descrição de HostPool.

--force-string

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

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--friendly-name

Nome amigável de HostPool.

--ids

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

--load-balancer-type

O tipo do balanceador de carga.

valores aceites: BreadthFirst, DepthFirst, Persistent
--max-session-limit

O limite máximo de sessão do HostPool.

--name -n

O nome do pool de hosts dentro do grupo de recursos especificado.

--personal-desktop-assignment-type

Tipo PersonalDesktopAssignment para HostPool.

valores aceites: Automatic, Direct
--preferred-app-group-type -t

O tipo de grupo de aplicativos preferido, padrão para o grupo de aplicativos da área de trabalho.

valores aceites: Desktop, None, RailApplications
--registration-info

As informações de registro do HostPool. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--remove

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

--resource-group -g

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

--ring

O número do anel de HostPool.

--set

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

--sso-client-id

ClientId para a Terceira Parte Confiável registrada usada para emitir certificados SSO WVD.

--sso-client-secret-key-vault-path -p

Caminho para o Azure KeyVault armazenando o segredo usado para comunicação com o ADFS.

--sso-secret-type

O tipo de sinal único no Tipo Secreto.

valores aceites: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault
--ssoadfs-authority

URL para o servidor ADFS do cliente para assinar certificados SSO WVD.

--start-vm-on-connect

O sinalizador para ativar/desativar o recurso StartVMOnConnect.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--tags

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

--validation-environment

É ambiente de validação.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--vm-template

Modelo de VM para configuração de hosts de sessão dentro do hostpool.

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.