Remove-RASAVDHostPool

NAME

Remove-RASAVDHostPool

SYNOPSIS

The cmdlet removes an object of type Azure Virtual Desktop Host Pool.

SYNTAX

Remove-RASAVDHostPool [-Id] <uint> [<CommonParameters>]

Remove-RASAVDHostPool [-InputObject] <AVDHostPool> [<CommonParameters>]

Remove-RASAVDHostPool [-Name] <string> [[-SiteId] <uint>] [<CommonParameters>]

DESCRIPTION

Removes an Azure Virtual Desktop Host Pool

PARAMETERS

-Name <string> The name of the Azure Virtual Desktop Host Pool to remove from a site.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to remove the Azure Virtual Desktop Host Pool.

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 Host Pool to remove from the site.

To obtain the ID, use the Get-AVDHostPool cmdlet.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <AVDHostPool> The Azure Virtual Desktop Host Pool Settings to remove from a site.

To obtain a Azure Virtual Desktop object, use the Get-AVDHostPool command.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        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

AVDHostPool

OUTPUTS

-none-

EXAMPLES

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

Remove-RASAVDHostPool -Name "AVDHostPool"

Removes the AVD Host Pool with Name AVDHostPool. ---------- EXAMPLE 2 ----------

Remove-RASAVDHostPool -Id 1

Removes the AVD Host Pool with Id 1.

RELATED LINKS

• Get-RASAVDHostPool
• Set-RASAVDHostPool
• New-RASAVDHostPool