Update-AzWvdHostPool

Модуль:
Az.DesktopVirtualization Module

обновите пул узлов.

Синтаксис

UpdateExpanded (По умолчанию) 

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

UpdateViaJsonString 

Update-AzWvdHostPool
    -Name <String>
    -ResourceGroupName <String>
    -JsonString <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaJsonFilePath 

Update-AzWvdHostPool
    -Name <String>
    -ResourceGroupName <String>
    -JsonFilePath <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded 

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

Описание

обновите пул узлов.

Примеры

Пример 1. Обновление Windows HostPool на виртуальном рабочем столе по имени

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

Эта команда обновляет Windows HostPool виртуального рабочего стола в группе ресурсов.

Параметры

-AgentUpdateMaintenanceWindow

Список окон обслуживания. Срок обслуживания составляет 2 часа.

Свойства параметров

Тип:

IMaintenanceWindowPatchProperties[]

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-AgentUpdateMaintenanceWindowTimeZone

Часовой пояс для обслуживания, определенный в https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Необходимо задать, если значение useLocalTime имеет значение true.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-AgentUpdateType

Тип обслуживания компонентов узла сеанса.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-AgentUpdateUseSessionHostLocalTime

Следует ли использовать localTime виртуальной машины.

Свойства параметров

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Confirm

Запрашивает подтверждение перед запуском cmdlet.

Свойства параметров

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:Cf

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-CustomRdpProperty

Настраиваемое свойство rdp объекта HostPool.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-DefaultProfile

Параметр DefaultProfile не работает. Используйте параметр SubscriptionId, если он доступен при выполнении командлета в другой подписке.

Свойства параметров

Тип:PSObject
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Description

Описание HostPool.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-FriendlyName

Понятное имя HostPool.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-InputObject

Параметр удостоверения

Свойства параметров

Тип:IDesktopVirtualizationIdentity
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateViaIdentityExpanded
Position:Named
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-JsonFilePath

Путь к json-файлу, предоставленному операции обновления

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateViaJsonFilePath
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-JsonString

Строка JSON, предоставленная операции обновления

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateViaJsonString
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-LoadBalancerType

Тип подсистемы балансировки нагрузки.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-MaxSessionLimit

Максимальное ограничение сеанса HostPool.

Свойства параметров

Тип:Int32
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Name

Имя пула узлов в указанной группе ресурсов

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:HostPoolName

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaJsonString
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaJsonFilePath
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-PersonalDesktopAssignmentType

Тип PersonalDesktopAssignment для HostPool.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-PreferredAppGroupType

Тип предпочитаемой группы приложений по умолчанию — группа классических приложений

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-PublicNetworkAccess

Включено, чтобы разрешить доступ к этому ресурсу из публичной сети

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-RegistrationInfoExpirationTime

Время окончания срока действия маркера регистрации.

Свойства параметров

Тип:DateTime
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-RegistrationInfoRegistrationTokenOperation

Тип сброса маркера.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ResourceGroupName

Имя группы ресурсов. Имя регистронезависимо.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaJsonString
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaJsonFilePath
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Ring

Номер кольца HostPool.

Свойства параметров

Тип:Int32
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SsoadfsAuthority

URL-адрес сервера ADFS клиента для подписывания сертификатов единого входа WVD.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SsoClientId

ClientId для зарегистрированной проверяющей стороны, используемой для выдачи сертификатов единого входа WVD.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SsoClientSecretKeyVaultPath

Путь к Azure KeyVault, в котором хранится секрет, используемый для обмена данными с ADFS.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SsoSecretType

Тип единого входа в Secret Type.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-StartVMOnConnect

Флаг для включения или отключения функции StartVMOnConnect.

Свойства параметров

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SubscriptionId

Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).

Свойства параметров

Тип:String
Default value:(Get-AzContext).Subscription.Id
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaJsonString
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaJsonFilePath
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Tag

Теги для обновления

Свойства параметров

Тип:Hashtable
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ValidationEnvironment

Среда проверки.

Свойства параметров

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-VMTemplate

Шаблон виртуальной машины для конфигурации sessionhosts в hostpool.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

UpdateExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
UpdateViaIdentityExpanded
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-WhatIf

Показывает, что произойдет, если командлет будет запущен. Командлет не запускается.

Свойства параметров

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:Wi

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Входные данные

IDesktopVirtualizationIdentity

Выходные данные

IHostPool