Share via


Update-AzWvdHostPool

Atualize um pool de hosts.

Syntax

Update-AzWvdHostPool
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-AgentUpdateMaintenanceWindow <IMaintenanceWindowPatchProperties[]>]
      [-AgentUpdateMaintenanceWindowTimeZone <String>]
      [-AgentUpdateType <SessionHostComponentUpdateType>]
      [-AgentUpdateUseSessionHostLocalTime]
      [-CustomRdpProperty <String>]
      [-Description <String>]
      [-FriendlyName <String>]
      [-LoadBalancerType <LoadBalancerType>]
      [-MaxSessionLimit <Int32>]
      [-PersonalDesktopAssignmentType <PersonalDesktopAssignmentType>]
      [-PreferredAppGroupType <PreferredAppGroupType>]
      [-PublicNetworkAccess <HostpoolPublicNetworkAccess>]
      [-RegistrationInfoExpirationTime <DateTime>]
      [-RegistrationInfoRegistrationTokenOperation <RegistrationTokenOperation>]
      [-Ring <Int32>]
      [-SsoClientId <String>]
      [-SsoClientSecretKeyVaultPath <String>]
      [-SsoSecretType <SsoSecretType>]
      [-SsoadfsAuthority <String>]
      [-StartVMOnConnect]
      [-Tag <Hashtable>]
      [-VMTemplate <String>]
      [-ValidationEnvironment]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzWvdHostPool
      -InputObject <IDesktopVirtualizationIdentity>
      [-AgentUpdateMaintenanceWindow <IMaintenanceWindowPatchProperties[]>]
      [-AgentUpdateMaintenanceWindowTimeZone <String>]
      [-AgentUpdateType <SessionHostComponentUpdateType>]
      [-AgentUpdateUseSessionHostLocalTime]
      [-CustomRdpProperty <String>]
      [-Description <String>]
      [-FriendlyName <String>]
      [-LoadBalancerType <LoadBalancerType>]
      [-MaxSessionLimit <Int32>]
      [-PersonalDesktopAssignmentType <PersonalDesktopAssignmentType>]
      [-PreferredAppGroupType <PreferredAppGroupType>]
      [-PublicNetworkAccess <HostpoolPublicNetworkAccess>]
      [-RegistrationInfoExpirationTime <DateTime>]
      [-RegistrationInfoRegistrationTokenOperation <RegistrationTokenOperation>]
      [-Ring <Int32>]
      [-SsoClientId <String>]
      [-SsoClientSecretKeyVaultPath <String>]
      [-SsoSecretType <SsoSecretType>]
      [-SsoadfsAuthority <String>]
      [-StartVMOnConnect]
      [-Tag <Hashtable>]
      [-VMTemplate <String>]
      [-ValidationEnvironment]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Atualize um pool de hosts.

Exemplos

Exemplo 1: Atualizar um Windows Virtual Desktop HostPool por nome

Update-AzWvdHostPool -ResourceGroupName ResourceGroupName `
                            -Name HostPoolName `
                            -LoadBalancerType 'BreadthFirst' `
                            -Description 'Description' `
                            -FriendlyName 'Friendly Name' `
                            -MaxSessionLimit 6 `
                            -CustomRdpProperty $null `
                            -Ring $null `
                            -ValidationEnvironment:$false

Location   Name                 Type
--------   ----                 ----
eastus     HostPoolName Microsoft.DesktopVirtualization/hostpools

Este comando atualiza um Windows Virtual Desktop HostPool em um grupo de recursos.

Parâmetros

-AgentUpdateMaintenanceWindow

Lista de janelas de manutenção. As janelas de manutenção têm 2 horas de duração. Para construir, consulte a seção NOTAS para propriedades AGENTUPDATEMAINTENANCEWINDOW e crie uma tabela de hash.

Type:IMaintenanceWindowPatchProperties[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AgentUpdateMaintenanceWindowTimeZone

Fuso horário para manutenção, conforme definido em https://learn.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Deve ser definido se useLocalTime for true.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AgentUpdateType

O tipo de manutenção para componentes de host de sessão.

Type:SessionHostComponentUpdateType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AgentUpdateUseSessionHostLocalTime

Se deve usar localTime da máquina virtual.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CustomRdpProperty

Propriedade rdp personalizada de HostPool.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

O parâmetro DefaultProfile não é funcional. Use o parâmetro SubscriptionId quando disponível se estiver executando o cmdlet em uma assinatura diferente.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Descrição de HostPool.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FriendlyName

Nome amigável de HostPool.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Parâmetro de identidade Para construir, consulte a seção NOTAS para propriedades INPUTOBJECT e crie uma tabela de hash.

Type:IDesktopVirtualizationIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LoadBalancerType

O tipo do balanceador de carga.

Type:LoadBalancerType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaxSessionLimit

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

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

Type:String
Aliases:HostPoolName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PersonalDesktopAssignmentType

Tipo PersonalDesktopAssignment para HostPool.

Type:PersonalDesktopAssignmentType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PreferredAppGroupType

O tipo de grupo de aplicativos preferido, padrão para Grupo de Aplicativos de Área de Trabalho

Type:PreferredAppGroupType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PublicNetworkAccess

Habilitado para permitir que esse recurso seja acessado a partir da rede pública

Type:HostpoolPublicNetworkAccess
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RegistrationInfoExpirationTime

Tempo de expiração do token de registro.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RegistrationInfoRegistrationTokenOperation

O tipo de redefinição do token.

Type:RegistrationTokenOperation
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Ring

O número do anel de HostPool.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SsoadfsAuthority

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SsoClientId

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SsoClientSecretKeyVaultPath

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SsoSecretType

O tipo de sinal único no Tipo Secreto.

Type:SsoSecretType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StartVMOnConnect

O sinalizador para ativar/desativar o recurso StartVMOnConnect.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

A ID da assinatura de destino.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

tags a serem atualizadas

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ValidationEnvironment

É ambiente de validação.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMTemplate

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

IDesktopVirtualizationIdentity

Saídas

Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20231004Preview.IHostPool