Remove-RASAVDHostPoolAssignment

NAME

Remove-RASAVDHostPoolAssignment

SYNOPSIS

Removes a user or group from the Azure Virtual Desktop Host Pool Assignment List.

SYNTAX

Remove-RASAVDHostPoolAssignment [-Id] <uint> [-Account <string>] [-SID <string>] [<CommonParameters>]

Remove-RASAVDHostPoolAssignment [-InputObject] <AVDHostPool> [-Account <string>] [-SID <string>] [<CommonParameters>]

Remove-RASAVDHostPoolAssignment [-Name] <string> [[-SiteId] <uint>] [-Account <string>] [-SID <string>] [<CommonParameters>]

DESCRIPTION

Removes a user or group from the Azure Virtual Desktop Host Pool Assignment List within an Azure Virtual Desktop Host Pool.

PARAMETERS

-Id <uint> ID for which to modify the Azure Virtual Desktop Host Pool settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The name of the target Azure Virtual Desktop Host Pool settings.

This must be the actual Azure Virtual Desktop Host Pool name used in the RAS farm.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID in which to modify the specified Azure Virtual Desktop Host Pool settings .

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

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <AVDHostPool> An object of type AVDHostPool for which to modify settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Account <string> The name of the account to remove from the Assignments.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SID <string> The SID of the account to remove from the Assignments.

        Required?                    false

        Position?                    named

        Default value                

        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

-none-

EXAMPLES

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

Remove-RASAVDHostPoolAssignment -Id 1 -Account "JaneDoe"

Removes a user from the AVD Host Pool Assignment List within the AVD Host Pool Settings specified by Id. ---------- EXAMPLE 2 ----------

Remove-RASAVDHostPoolAssignment -Name "Logon1" -Account "SID://DOMAIN/JaneDoe"

Removes a user from the AVD Host Pool Assignment List within the AVD Host Pool Settings specified by Name.

RELATED LINKS

• Get-RASAVDHostPool
• Set-RASAVDHostPool
• Add-RASAVDHostPoolAssignment
• Get-RASAVDHostPoolAssignment