Share via


Update-AzWvdHostPool

Uppdatera en värdpool.

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

Uppdatera en värdpool.

Exempel

Exempel 1: Uppdatera en Windows Virtual Desktop HostPool efter namn

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

Det här kommandot uppdaterar en Windows Virtual Desktop HostPool i en resursgrupp.

Parametrar

-AgentUpdateMaintenanceWindow

Lista över underhållsperioder. Underhållsfönstren är 2 timmar långa. Information om hur du skapar finns i AVSNITTET ANTECKNINGAR för AGENTUPDATEMAINTENANCEWINDOW-egenskaper och skapa en hash-tabell.

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

-AgentUpdateMaintenanceWindowTimeZone

Tidszon för underhåll enligt definitionen i https://learn.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Måste anges om useLocalTime är sant.

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

-AgentUpdateType

Typ av underhåll för sessionsvärdkomponenter.

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

-AgentUpdateUseSessionHostLocalTime

Om du vill använda localTime för den virtuella datorn.

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

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

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

-CustomRdpProperty

Anpassad rdp-egenskap för HostPool.

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

-DefaultProfile

Parametern DefaultProfile fungerar inte. Använd parametern SubscriptionId när den är tillgänglig om du kör cmdleten mot en annan prenumeration.

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

-Description

Beskrivning av HostPool.

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

-FriendlyName

Eget namn på HostPool.

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

-InputObject

Identitetsparameter För att skapa, se AVSNITTET ANTECKNINGAR för INPUTOBJECT-egenskaper och skapa en hash-tabell.

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

-LoadBalancerType

Typen av lastbalanserare.

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

-MaxSessionLimit

Maximal sessionsgräns för HostPool.

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

-Name

Namnet på värdpoolen i den angivna resursgruppen

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

-PersonalDesktopAssignmentType

PersonalDesktopAssignment-typ för HostPool.

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

-PreferredAppGroupType

Typ av önskad programgruppstyp, standard för skrivbordsprogramgrupp

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

-PublicNetworkAccess

Aktiverad för att ge den här resursen åtkomst från det offentliga nätverket

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

-RegistrationInfoExpirationTime

Förfallotid för registreringstoken.

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

-RegistrationInfoRegistrationTokenOperation

Typ av återställning av token.

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

-ResourceGroupName

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

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

-Ring

Ringnumret för HostPool.

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

-SsoadfsAuthority

URL till kundens ADFS-server för signering av WVD SSO-certifikat.

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

-SsoClientId

ClientId för den registrerade förlitande parten som används för att utfärda WVD SSO-certifikat.

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

-SsoClientSecretKeyVaultPath

Sökväg till Azure KeyVault som lagrar hemligheten som används för kommunikation till ADFS.

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

-SsoSecretType

Typen av enkel inloggning på hemlig typ.

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

-StartVMOnConnect

Flaggan för att aktivera/inaktivera Funktionen StartVMOn Anslut.

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

-SubscriptionId

ID för målprenumerationen.

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

-Tag

taggar som ska uppdateras

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

-ValidationEnvironment

Är valideringsmiljö.

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

-VMTemplate

VM-mall för konfiguration av sessionsvärdar i värdpoolen.

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

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

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

Indata

IDesktopVirtualizationIdentity

Utdata

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