Edit

Share via

Remove-AzWvdPrivateEndpointConnection

  • Reference
Module:
Az.DesktopVirtualization

Remove a connection.

Syntax

Remove-AzWvdPrivateEndpointConnection
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -WorkspaceName <String>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzWvdPrivateEndpointConnection
      -Name <String>
      -WorkspaceInputObject <IDesktopVirtualizationIdentity>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzWvdPrivateEndpointConnection
      -Name <String>
      -HostPoolInputObject <IDesktopVirtualizationIdentity>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzWvdPrivateEndpointConnection
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -HostPoolName <String>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzWvdPrivateEndpointConnection
      -InputObject <IDesktopVirtualizationIdentity>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzWvdPrivateEndpointConnection
      -InputObject <IDesktopVirtualizationIdentity>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Remove a connection.

Examples

Example 1: Remove the Private Endpoint Connection between the Private Endpoint and Windows Virtual Desktop HostPool by WVD Private Endpoint Connection Name and HostPoolName

Remove-AzWvdPrivateEndpointConnection -ResourceGroupName ResourceGroupName -Name WvdPrivateEndpointConnectionName -HostpoolName HostPoolName

<none>

This command removes the Private Endpoint Connection to the Windows Virtual Desktop HostPool in a Resource Group. It does not delete the Private Endpoint. Customers will need to separately delete the Private Endpoint.

Example 2: Remove the Private Endpoint Connection between the Private Endpoint and Windows Virtual Desktop Workspace by WVD Private Endpoint Connection Name and WorkspaceName

Remove-AzWvdPrivateEndpointConnection -ResourceGroupName ResourceGroupName -Name WvdPrivateEndpointConnectionName -WorkspaceName WorkspaceName

<none>

This command removes the Private Endpoint Connection to the Windows Virtual Desktop Workspace in a Resource Group. It does not delete the Private Endpoint. Customers will need to separately delete the Private Endpoint.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostPoolInputObject

Identity Parameter

Type:IDesktopVirtualizationIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-HostPoolName

The name of the host pool within the specified resource group

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter

Type:IDesktopVirtualizationIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The name of the private endpoint connection associated with the Azure resource.

Type:String
Aliases:PrivateEndpointConnectionName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Returns true when the command succeeds

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceInputObject

Identity Parameter

Type:IDesktopVirtualizationIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WorkspaceName

The name of the workspace

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IDesktopVirtualizationIdentity

Outputs

Boolean