Get-AzSynapseManagedPrivateEndpoint

Reference

Module:: Az.Synapse

Gets information about mananged private endpoints in a workspace

Syntax

Get-AzSynapseManagedPrivateEndpoint
   -WorkspaceName <String>
   [-Name <String>]
   [-VirtualNetworkName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseManagedPrivateEndpoint
   -WorkspaceObject <PSSynapseWorkspace>
   [-Name <String>]
   [-VirtualNetworkName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzSynapseManagedPrivateEndpoint cmdlet gets information about mananged private endpoints in a workspace. If you specify the name of a mananged private endpoint, the cmdlet gets information about that mananged private endpoint. If you do not specify a name, the cmdlet gets information about all mananged private endpoints in the workspace.

Examples

Example 1

Get-AzSynapseManagedPrivateEndpoint -WorkspaceName ContosoWorkspace -Name ContosoManagedPrivateEndpoint

Gets a single mananged private endpoint called ContosoManagedPrivateEndpoint in the workspace ContosoWorkspace.

Example 2

Get-AzSynapseManagedPrivateEndpoint -WorkspaceName ContosoWorkspace

Gets a list of all mananged private endpoints in the workspace ContosoWorkspace.

Example 3

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseManagedPrivateEndpoint -Name ContosoManagedPrivateEndpoint

Gets a single mananged private endpoint called ContosoManagedPrivateEndpoint in the workspace ContosoWorkspace through pipeline.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The Synapse Managed Private Endpoint Name.

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

-VirtualNetworkName

Managed Virtual Network Name is default.

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

-WorkspaceName

Name of Synapse workspace.

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

-WorkspaceObject

workspace input object, usually passed through the pipeline.

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

Inputs

PSSynapseWorkspace

Outputs

PSManagedPrivateEndpointResource