Edit

Share via


Remove-RdsRegistrationInfo

Removes registration information from a host pool.

Syntax

Default (Default)

Remove-RdsRegistrationInfo
    [-TenantName] <String>
    [-HostPoolName] <String>
    [<CommonParameters>]

Description

The Remove-RdsRegistrationInfo removes the registration information from the specified host pool.

If there is no registration information for the host pool, the cmdlet will succeed silently.

Examples

Example 1: Remove registration information from a host pool

PS C:\> Remove-RdsRegistrationInfo -TenantName "contoso" -HostPoolName "contosoHostPool"

This command removes the registration information from the specified host pool.

Parameters

-HostPoolName

The name of the host pool.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-TenantName

The name of the tenant.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.String

Outputs

System.Object