Edit

Share via

Get-AzWvdPrivateEndpointConnection

Module:
Az.DesktopVirtualization Module

Get a private endpoint connection.

Syntax

List (Default) 

Get-AzWvdPrivateEndpointConnection
    -ResourceGroupName <String>
    -WorkspaceName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityWorkspace 

Get-AzWvdPrivateEndpointConnection
    -Name <String>
    -WorkspaceInputObject <IDesktopVirtualizationIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityHostPool 

Get-AzWvdPrivateEndpointConnection
    -Name <String>
    -HostPoolInputObject <IDesktopVirtualizationIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get1 

Get-AzWvdPrivateEndpointConnection
    -Name <String>
    -ResourceGroupName <String>
    -HostPoolName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get 

Get-AzWvdPrivateEndpointConnection
    -Name <String>
    -ResourceGroupName <String>
    -WorkspaceName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List1 

Get-AzWvdPrivateEndpointConnection
    -ResourceGroupName <String>
    -HostPoolName <String>
    [-SubscriptionId <String[]>]
    [-InitialSkip <Int32>]
    [-IsDescending]
    [-PageSize <Int32>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity1 

Get-AzWvdPrivateEndpointConnection
    -InputObject <IDesktopVirtualizationIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

Get-AzWvdPrivateEndpointConnection
    -InputObject <IDesktopVirtualizationIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get a private endpoint connection.

Examples

Example 1: Get a PrivateEndpointConnection by Workspace

Get-AzWvdPrivateEndpointConnection -ResourceGroupName ResourceGroupName -workspaceName WorkspaceName -privateEndpointConnectionName privateName

Name                                         PrivateEndpointId                                                                                                                           PrivateLinkServiceConnectionStateActionsRequired PrivateLinkServiceConnectionStateDescription PrivateLinkServiceConnectionStateStatus ProvisioningState
----                                         -----------------                                                                                                                           ------------------------------------------------ -------------------------------------------- --------------------------------------- -----------------
privateName1                                  /subscriptions/00000000-0000-0000-000000000000/resourceGroups/ResourceGroupName/providers/microsoft.network/privateendpoints/WorkspaceName  None                                             Auto-approved                                Approved                                Succeeded

Gets a private endpoint connection from a Workspace.

Example 1: List PrivateEndpointConnections by Workspace

Get-AzWvdPrivateEndpointConnection -ResourceGroupName ResourceGroupName -workspaceName WorkspaceName

Name                                         PrivateEndpointId                                                                                                                           PrivateLinkServiceConnectionStateActionsRequired PrivateLinkServiceConnectionStateDescription PrivateLinkServiceConnectionStateStatus ProvisioningState
----                                         -----------------                                                                                                                           ------------------------------------------------ -------------------------------------------- --------------------------------------- -----------------
privateName1                                  /subscriptions/00000000-0000-0000-000000000000/resourceGroups/ResourceGroupName/providers/microsoft.network/privateendpoints/WorkspaceName None                                             Auto-approved                                Approved                                Succeeded
privateName2                                  /subscriptions/00000000-0000-0000-000000000000/resourceGroups/ResourceGroupName/providers/microsoft.network/privateendpoints/WorkspaceName None                                             Auto-approved                                Approved                                Succeeded

Lists private endpoint connections from a Workspace.

Example 3: Get a PrivateEndpointConnection by HostPool

Get-AzWvdPrivateEndpointConnection -ResourceGroupName ResourceGroupName -HostPoolName hpName -privateEndpointConnectionName privateName

Name                                         PrivateEndpointId                                                                                                                     PrivateLinkServiceConnectionStateActionsRequired PrivateLinkServiceConnectionStateDescription PrivateLinkServiceConnectionStateStatus ProvisioningState
----                                         -----------------                                                                                                                     ------------------------------------------------ -------------------------------------------- --------------------------------------- -----------------
privateName1                                  /subscriptions/00000000-0000-0000-000000000000/resourceGroups/ResourceGroupName/providers/microsoft.network/privateendpoints/hpName  None                                             Auto-approved                                Approved                                Succeeded

Gets a private endpoint connection from a HostPool.

Example 1: List PrivateEndpointConnections by HostPool

Get-AzWvdPrivateEndpointConnection -ResourceGroupName ResourceGroupName -HostPoolName hpName

Name                                         PrivateEndpointId                                                                                                                    PrivateLinkServiceConnectionStateActionsRequired PrivateLinkServiceConnectionStateDescription PrivateLinkServiceConnectionStateStatus ProvisioningState
----                                         -----------------                                                                                                                    ------------------------------------------------ -------------------------------------------- --------------------------------------- -----------------
privateName1                                  /subscriptions/00000000-0000-0000-000000000000/resourceGroups/ResourceGroupName/providers/microsoft.network/privateendpoints/hpName None                                             Auto-approved                                Approved                                Succeeded
privateName2                                  /subscriptions/00000000-0000-0000-000000000000/resourceGroups/ResourceGroupName/providers/microsoft.network/privateendpoints/hpName None                                             Auto-approved                                Approved                                Succeeded

Lists private endpoint connections from a Hostpool.

Parameters

-DefaultProfile

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

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

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

-HostPoolInputObject

Identity Parameter

Parameter properties

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

Parameter sets

GetViaIdentityHostPool
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-HostPoolName

The name of the host pool within the specified resource group

Parameter properties

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

Parameter sets

Get1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InitialSkip

Initial number of items to skip.

Parameter properties

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

Parameter sets

List1
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter

Parameter properties

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

Parameter sets

GetViaIdentity1
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-IsDescending

Indicates whether the collection is descending.

Parameter properties

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

Parameter sets

List1
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

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

Parameter properties

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

Parameter sets

GetViaIdentityWorkspace
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetViaIdentityHostPool
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PageSize

Number of items per page.

Parameter properties

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

Parameter sets

List1
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

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

Parameter properties

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

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

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

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get1
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WorkspaceInputObject

Identity Parameter

Parameter properties

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

Parameter sets

GetViaIdentityWorkspace
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-WorkspaceName

The name of the workspace

Parameter properties

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

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
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

IDesktopVirtualizationIdentity

Outputs

IPrivateEndpointConnectionWithSystemData