Get-AzSynapseLinkConnection

Module:

Az.Synapse

Gets information about link connections in workspace.

Syntax

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

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

Description

The Get-AzSynapseLinkConnection cmdlet gets information about link connections in a workspace. If you specify the name of a link connection, the cmdlet gets information about that link connection. If you do not specify a name, the cmdlet gets information about all link connections in the workspace.

Examples

Example 1

Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace

Gets a list of all link connections in the workspace ContosoWorkspace.

Example 2

Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection

Gets a single link connection named ContosoLinkConnection in the workspace ContosoWorkspace.

Example 3

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseLinkConnection

This command gets all link connections under a workspace 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 link connection name for Azure Sql Database.

Type:	String
Aliases:	LinkConnectionName
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

PSLinkConnectionResource