Remove-RASAVDHost

NAME

Remove-RASAVDHost

SYNOPSIS

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

SYNTAX

Remove-RASAVDHost [[-SiteId]** (uint)] -AzureId (string) -HostPoolId (uint) [(CommonParameters)]

Remove-RASAVDHost [[-SiteId]** (uint)] -ProviderId (uint) -VMId (string) [(CommonParameters)]

DESCRIPTION

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

PARAMETERS

ProviderId (uint)

The Provider ID.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

VMId (string)

The VM ID.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

HostPoolId (uint)

Host Pool Id.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

AzureId (string)

The Azure Host ID.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID from which to retrieve the AVD Host 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

(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-RASAVDHost -HostPoolID 1 -AzureID "/subscriptions/b64739563-74S9-849s-ks94-89sa5nbj83oe/resourceGroups/My-Resource-Group/providers/Microsoft.Compute/virtualMachines/My-Virtual-Machine"

Removes an AVD Host from a Standalone AVD Host Pool. **---------- EXAMPLE 2 ----------

Remove-RASAVDHost -ProviderId 1 -SiteId 1 -VMID "42311235-09c5-ca15-337d-b9723015edf0"

Removes AVD Hosts from a Templated AVD Host Pool.

Last updated