az desktopvirtualization hostpool

Note

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	Status
az desktopvirtualization hostpool create	Crie um pool de hosts.	Extension	disponibilidade geral
az desktopvirtualization hostpool delete	Exclua um pool de hosts.	Extension	disponibilidade geral
az desktopvirtualization hostpool list	Listar pools de hosts.	Extension	disponibilidade geral
az desktopvirtualization hostpool retrieve-registration-token	Token de registro do pool de hosts.	Extension	disponibilidade geral
az desktopvirtualization hostpool show	Mostrar um pool de hosts.	Extension	disponibilidade geral
az desktopvirtualization hostpool update	Atualize um pool de hosts.	Extension	disponibilidade geral

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.

Propriedade	Valor
Valores aceites:	BYODesktop, Personal, Pooled

--load-balancer-type

O tipo do balanceador de carga.

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

Propriedade	Valor
Valores aceites:	Desktop, None, RailApplications

--resource-group -g

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

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

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

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

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

Propriedade	Valor
Default value:	False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--force

Sinalizador de força para excluir sessionHost.

Propriedade	Valor
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 que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--name -n

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--resource-group -g

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--subscription

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--yes -y

Não solicite confirmação.

Propriedade	Valor
Default value:	False

Parâmetros de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Propriedade	Valor
Default value:	False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade	Valor
Grupo de parâmetros:	Pagination Arguments

--next-token

Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

Propriedade	Valor
Grupo de parâmetros:	Pagination Arguments

--resource-group -g

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.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

Propriedade	Valor
Default value:	False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--ids

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--name -n

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--resource-group -g

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--subscription

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

Parâmetros de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Propriedade	Valor
Default value:	False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--ids

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--name -n

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--resource-group -g

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--subscription

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

Parâmetros de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Propriedade	Valor
Default value:	False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments

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

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Valores aceites:	0, 1, f, false, n, no, t, true, y, yes

--friendly-name

Nome amigável de HostPool.

--ids

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--load-balancer-type

O tipo do balanceador de carga.

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--personal-desktop-assignment-type

Tipo PersonalDesktopAssignment para HostPool.

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

Propriedade	Valor
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 <indexToRemove> OU --remove propertyToRemove.

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments

--resource-group -g

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

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

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments

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

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

Propriedade	Valor
Valores aceites:	0, 1, f, false, n, no, t, true, y, yes

--subscription

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--tags

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

--validation-environment

É ambiente de validação.

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Propriedade	Valor
Default value:	False

Feedback

Esta página foi útil?

Partilhar via

az desktopvirtualization hostpool

Comandos

az desktopvirtualization hostpool create

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az desktopvirtualization hostpool delete

Exemplos

Parâmetros Opcionais

az desktopvirtualization hostpool list

Exemplos

Parâmetros Opcionais

az desktopvirtualization hostpool retrieve-registration-token

Exemplos

Parâmetros Opcionais

az desktopvirtualization hostpool show

Exemplos

Parâmetros Opcionais

az desktopvirtualization hostpool update

Exemplos

Parâmetros Opcionais

Feedback