Session Host Provisioning Statuses - Get

Служба:

Desktop Virtualization

Версия API:

2026-04-01-preview

Получение состояния подготовки узла сеансов для заданного пула узлов.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/sessionHostProvisioningStatuses/default?api-version=2026-04-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Имя пула узлов в указанной группе ресурсов
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя нечувствительно к регистру.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	SessionHostManagementProvisioningStatus	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	выдать себя за учетную запись пользователя

Примеры

SessionHostManagements_SessionHostProvisioningStatuses_Get

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/sessionHostProvisioningStatuses/default?api-version=2026-04-01-preview

Пример ответа

Код состояния:

200

{
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/sessionHostProvisioningStatuses/default",
  "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3",
  "status": "Failed",
  "startTime": "2020-10-26T13:45:39.6554616Z",
  "endTime": "2020-10-26T13:45:42.7025301Z",
  "percentComplete": 1,
  "error": {
    "code": "BadArgument",
    "message": "The provided database 'foo' has an invalid username."
  }
}

Определения

Имя	Описание
CanaryPolicy	Политика о том, следует ли выделять канареечную виртуальную машину (одну виртуальную машину для проверки конфигурации) во время операции подготовки узла сеансов.
createdByType	Тип учётной записи, создавшей ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Подробности ошибки.
ErrorResponse	Ответ на ошибку
FailedSessionHostCleanupPolicySHC	Политика, которая должна применяться в случае сбоя операции подготовки узла сеансов.
HostPoolUpdateConfigurationProperties	Конфигурации обновления пула узлов сети.
SessionHostManagement	Схема для свойств SessionHostManagement.
SessionHostManagementProvisioningOperationProgress	Сведения о ходе выполнения операции подготовки SessionHostManagement.
SessionHostManagementProvisioningOperationStatus	Состояние операции для SessionHostManagementUpdate.
SessionHostManagementProvisioningStatus	Схема для свойств SessionHostManagementUpdateStatus.
SessionHostManagementProvisioningStatusProperties	Контейнер свойств для статусов подготовки sessionHostManagement.
SessionHostProvisioningConfigurationProperties	Конфигурация для операций подготовки узла сеансов.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

CanaryPolicy

Перечисление

Политика о том, следует ли выделять канареечную виртуальную машину (одну виртуальную машину для проверки конфигурации) во время операции подготовки узла сеансов.

Значение	Описание
Auto	Решение о том, следует ли предоставлять виртуальную машину Canary.
Never	Никогда не инициализируйте Canary VM.
Always	Всегда инициализируйте виртуальную машину Canary.

createdByType

Перечисление

Тип учётной записи, создавшей ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Объект

Подробности ошибки.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

FailedSessionHostCleanupPolicySHC

Перечисление

Политика, которая должна применяться в случае сбоя операции подготовки узла сеансов.

Значение	Описание
KeepAll	Сохраните все.
KeepOne	Оставьте одного.
KeepNone	Не оставляйте ничего.

HostPoolUpdateConfigurationProperties

Объект

Конфигурации обновления пула узлов сети.

Имя	Тип	Описание
deleteOriginalVm	boolean	Стоит ли сохранять оригинальный диск. Значение по умолчанию — ложь.
logOffDelayMinutes	integer (int32)	Льготный период перед выходом пользователей из системы в минутах.
logOffMessage	string maxLength: 260	Сообщение о выходе из системы отправлено пользователю для выхода из системы. Значение по умолчанию — пустая строка.
maxVmsRemoved	integer (int32) minimum: 1	Максимальное количество виртуальных машин, которые будут удалены во время обновления пула узлов.

SessionHostManagement

Объект

Схема для свойств SessionHostManagement.

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса.
properties.failedSessionHostCleanupPolicy	FailedSessionHostCleanupPolicySHC	Политика, которая должна применяться в случае сбоя операции подготовки узла сеансов.
properties.provisioning	SessionHostProvisioningConfigurationProperties	Параметры, которые применяются при подготовке узлов сеансов.
properties.scheduledDateTimeZone	string	Часовой пояс для операций sessionHostManagement, определенных в https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Должно быть установлено, если useLocalTime имеет значение true.
properties.update	HostPoolUpdateConfigurationProperties	Параметры для обновления пула узлов сети.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

SessionHostManagementProvisioningOperationProgress

Объект

Сведения о ходе выполнения операции подготовки SessionHostManagement.

Имя	Тип	Описание
executionStartTime	string (date-time)	Время создания операции sessionHostManagement.
finalSessionHostsCount	integer (int32)	Окончательное число экземпляров пула узлов для этой операции подготовки.
initialSessionHostsCount	integer (int32)	Начальное количество экземпляров пула узлов для этой операции подготовки.
sessionHostsCompleted	integer (int32)	Количество sessionHosts, выполненных в операции подготовки sessionHostManagement.
sessionHostsInProgress	integer (int32)	Количество хостов sessionHost, выполняемых в операции подготовки sessionHostManagement

SessionHostManagementProvisioningOperationStatus

Перечисление

Состояние операции для SessionHostManagementUpdate.

Значение	Описание
Scheduled	Операция проводится по расписанию.
ValidatingSessionHostProvisioning	В настоящее время операция проверяет подготовку.
Cancelling	Отмена операции.
ProvisioningSessionHosts	В настоящее время выполняется инициализация узлов сеансов.
Succeeded	Операция выполнена успешно.
Failed	Операция не удалась.
Canceled	Операция отменена.

SessionHostManagementProvisioningStatus

Объект

Схема для свойств SessionHostManagementUpdateStatus.

Имя	Тип	Описание
endTime	string (date-time)	Время окончания операции.
error	ErrorDetail	При наличии сведений об ошибке операции.
id	string (arm-id)	Полный идентификатор для асинхронной операции.
name	string	Имя асинхронной операции.
percentComplete	number (double) minimum: 0 maximum: 100	Процент завершенной операции.
properties	SessionHostManagementProvisioningStatusProperties	Настраиваемые свойства состояния подготовки узла сеансов.
startTime	string (date-time)	Время начала операции.
status	SessionHostManagementProvisioningOperationStatus	Состояние операции.

SessionHostManagementProvisioningStatusProperties

Объект

Контейнер свойств для статусов подготовки sessionHostManagement.

Имя	Тип	Описание
correlationId	string	Идентификатор корреляции для Log Analytics.
progress	SessionHostManagementProvisioningOperationProgress	Информация о ходе выполнения операции sessionHostManagement.
scheduledDateTime	string (date-time)	Метка времени, на которую запланировано обновление.
sessionHostManagement	SessionHostManagement	SessionHostManagement, используемые для операции.

SessionHostProvisioningConfigurationProperties

Объект

Конфигурация для операций подготовки узла сеансов.

Имя	Тип	Описание
canaryPolicy	CanaryPolicy	Политика о том, следует ли выделять канареечную виртуальную машину (одну виртуальную машину для проверки конфигурации) во время операции подготовки узла сеансов.
instanceCount	integer (int32) minimum: 1	Количество узлов сеансов, которые должны существовать в пуле узлов.
setDrainMode	boolean	Следует ли переводить узел сеансов в режим стока после подготовки.

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Идентификатор, создавший ресурс.
createdByType	createdByType	Тип учётной записи, создавшей ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.