Get-AzWvdWorkspace
Get a workspace.
Syntax
Get-AzWvdWorkspace
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzWvdWorkspace
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzWvdWorkspace
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-InitialSkip <Int32>]
[-IsDescending]
[-PageSize <Int32>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzWvdWorkspace
-InputObject <IDesktopVirtualizationIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>] Description
Get a workspace.
Examples
Example 1: Get a Windows Virtual Desktop Workspace by name
Get-AzWvdWorkspace -ResourceGroupName ResourceGroupName -Name WorkspaceName
Location Name Type
-------- ---- ----
eastus WorkspaceName Microsoft.DesktopVirtualization/workspacesThis command gets a Windows Virtual Desktop Workspace in a Resource Group.
Example 2: List Windows Virtual Desktop Workspaces
Get-AzWvdWorkspace -ResourceGroupName ResourceGroupName
Location Name Type
-------- ---- ----
eastus WorkspaceName1 Microsoft.DesktopVirtualization/workspaces
eastus WorkspaceName2 Microsoft.DesktopVirtualization/workspacesThis command lists a Windows Virtual Desktop Workspaces in a Resource Group.
Parameters
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InitialSkip
Initial number of items to skip.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IDesktopVirtualizationIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IsDescending
Indicates whether the collection is descending.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The name of the workspace
| Type: | String |
| Aliases: | WorkspaceName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PageSize
Number of items per page.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription.
| Type: | String[] |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
IDesktopVirtualizationIdentity
Outputs
Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20231004Preview.IWorkspace