initiate_session_host_updates
Creates, updates, deletes, gets or lists an initiate_session_host_updates resource.
Overview
| Name | initiate_session_host_updates |
| Type | Resource |
| Id | azure.desktop_virtualization.initiate_session_host_updates |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
post | exec | subscriptionId, resourceGroupName, hostPoolName | Initiates a hostpool update or schedule an update for the future. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
hostPoolName | string | The name of the host pool within the specified resource group |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
Lifecycle Methods
- post
Initiates a hostpool update or schedule an update for the future.
EXEC azure.desktop_virtualization.initiate_session_host_updates.post
@subscriptionId='{{ subscriptionId }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required,
@hostPoolName='{{ hostPoolName }}' --required
@@json=
'{
"scheduledDateTime": "{{ scheduledDateTime }}",
"scheduledDateTimeZone": "{{ scheduledDateTimeZone }}",
"update": "{{ update }}"
}'
;