Get-RASAVDHost
NAME
Get-RASAVDHost
SYNOPSIS
The cmdlet returns an object of type Azure Virtual Desktop Host properties.
SYNTAX
Get-RASAVDHost [[-SiteId]** (uint)] [ProviderId (uint)] [(CommonParameters)]
Get-RASAVDHost [VMId] (string)** [[-SiteId] (uint)] -ProviderId (uint) [(CommonParameters)]
DESCRIPTION
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.
PARAMETERS
VMId (string)
The ID of the VM for which to retrieve the information.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? falseProviderId (uint)
Provider Id from which to retrieve the AVD Host.
Required? true
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? falseSiteId (uint)
Site ID from which to retrieve the AVD Host.
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(CommonParameters)
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation. INPUTS
-none-
OUTPUTS
EXAMPLES
**---------- EXAMPLE 1 ----------
Get-RASAVDHost -VMID "42311235-09c5-ca15-337d-b9723015edf0" -ProviderID 1 | Format-List
Retrieves information about the AVD Host properties specified by the VMId and ProviderId.
To retrieve the info from a specific site, specify the -SiteId parameter.
The Format-List cmdlet formats the display output to include all available group properties. **---------- EXAMPLE 2 ----------
Get-RASAVDHost -ProviderID 1
Retrieves all the AVD Hosts found within the Provider with Id 1.
RELATED LINKS
Last updated