Get-RASAVDWorkspaceStatus

Get-RASAVDWorkspaceStatus

Retrieves the status of one or multiple AVD Workspaces.

Get-RASAVDWorkspaceStatus [[- Id ] <uint> ] [ < CommonParameters > ]

Get-RASAVDWorkspaceStatus [[- InputObject ] < AVDWorkspace > ] [ < CommonParameters > ]

Get-RASAVDWorkspaceStatus [[- Name ] <string> ] [[- SiteId ] <uint> ] [ < CommonParameters > ]

Retrieves information about the status of one or multiple AVD Workspaces.

The cmdlet returns an object of type AVDWorkspaceStatus.

To see the complete list of object properties, use the Format-List cmdlet (see examples).

The result set contains only the major properties of a group; it does not include the complete list of settings supported in RAS.

- InputObject < AVDWorkspace >
An object of type AVDWorkspace representing the AVD Workspace.

To obtain the object, use the Get-RASAVDWorkspace cmdlet.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

- Name <string>
The name of the Azure Virtual Desktop Workspace for which to retrieve the information.

This must be the actual Azure Virtual Desktop Workspace name.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

- SiteId <uint>
Site ID from which to retrieve the Azure Virtual Desktop Workspace information.

If the parameter is omitted, the Licensing Server site ID will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

- Id <uint>
The ID of a Azure Virtual Desktop Workspace for which to retrieve the information.

        Required?                    false

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

< CommonParameters >

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

AVDWorkspace

AVDWorkspaceStatus

---------- EXAMPLE 1 ----------

Get-RASAVDWorkspaceStatus -ID 1 | Format-List

Retrieves the status of the Workspace specified by Id.

The Format-List cmdlet formats the display output to include all available Workspace properties.