session_host_managements_update_status

Creates, updates, deletes, gets or lists a session_host_managements_update_status resource.

Overview

Name	session_host_managements_update_status
Type	Resource
Id	azure.desktop_virtualization.session_host_managements_update_status

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the session host update status.

Name	Datatype	Description
id	string	Fully qualified ID for the async operation.
name	string	Name of the async operation.
endTime	string (date-time)	The end time of the operation.
error	object	If present, details of the operation error.
percentComplete	number	Percent of the operation that is complete.
properties	object	The custom properties of the SessionHost Update Status.
startTime	string (date-time)	The start time of the operation.
status	string	Operation status. Current defined values are < Error | Scheduled | UpdatingSessionHosts | ValidatingSessionHostUpdate | Paused | Pausing | Cancelling > | Succeeded | Failed | Canceled

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, hostPoolName		Get the session host update status for a given hostpool.

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.

SELECT examples

get

Get the session host update status for a given hostpool.

SELECT
id,
name,
endTime,
error,
percentComplete,
properties,
startTime,
status
FROM azure.desktop_virtualization.session_host_managements_update_status
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND hostPoolName = '{{ hostPoolName }}' -- required
;