Share via


Update-AzWvdHostPool

Mettez à jour un pool d’hôtes.

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

Mettez à jour un pool d’hôtes.

Exemples

Exemple 1 : Mettre à jour un pool d’hôtes Windows Virtual Desktop par nom

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

Cette commande met à jour un pool d’hôtes Windows Virtual Desktop dans un groupe de ressources.

Paramètres

-AgentUpdateMaintenanceWindow

Liste des fenêtres de maintenance. Les fenêtres de maintenance sont longues de 2 heures. Pour construire, consultez la section NOTES pour les propriétés AGENTUPDATEMAINTENANCEWINDOW et créez une table de hachage.

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

-AgentUpdateMaintenanceWindowTimeZone

Fuseau horaire pour la maintenance telle que définie dans https://learn.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Doit être défini si useLocalTime a la valeur true.

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

-AgentUpdateType

Type de maintenance pour les composants hôtes de session.

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

-AgentUpdateUseSessionHostLocalTime

Indique s’il faut utiliser localTime de la machine virtuelle.

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

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

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

-CustomRdpProperty

Propriété rdp personnalisée de HostPool.

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

-DefaultProfile

Le paramètre DefaultProfile n’est pas fonctionnel. Utilisez le paramètre SubscriptionId lorsqu’il est disponible si vous exécutez l’applet de commande sur un autre abonnement.

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

-Description

Description de HostPool.

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

-FriendlyName

Nom convivial de HostPool.

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-LoadBalancerType

Type de l’équilibreur de charge.

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

-MaxSessionLimit

Limite de session maximale de HostPool.

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

-Name

Nom du pool d’hôtes dans le groupe de ressources spécifié

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

-PersonalDesktopAssignmentType

Type PersonalDesktopAssignment pour HostPool.

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

-PreferredAppGroupType

Type de groupe d’applications préféré, par défaut pour le groupe d’applications de bureau

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

-PublicNetworkAccess

Activé pour autoriser cet accès à cette ressource à partir du réseau public

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

-RegistrationInfoExpirationTime

Délai d’expiration du jeton d’inscription.

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

-RegistrationInfoRegistrationTokenOperation

Type de réinitialisation du jeton.

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

-ResourceGroupName

Nom du groupe de ressources. Le nom ne respecte pas la casse.

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

-Ring

Numéro d’anneau de HostPool.

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

-SsoadfsAuthority

URL du serveur ADFS client pour la signature de certificats WVD SSO.

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

-SsoClientId

ClientId pour la partie de confiance inscrite utilisée pour émettre des certificats WVD SSO.

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

-SsoClientSecretKeyVaultPath

Chemin d’accès à Azure KeyVault stockant le secret utilisé pour la communication avec ADFS.

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

-SsoSecretType

Type d’authentification unique Secret Type.

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

-StartVMOnConnect

Indicateur permettant d’activer/désactiver la fonctionnalité StartVMOn Connecter.

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

-SubscriptionId

ID de l’abonnement cible.

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

-Tag

balises à mettre à jour

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

-ValidationEnvironment

Environnement de validation.

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

-VMTemplate

Modèle de machine virtuelle pour la configuration de sessionhosts dans le pool d’hôtes.

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

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

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

Entrées

IDesktopVirtualizationIdentity

Sorties

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