Get-AzSynapseLinkConnectionDetailedStatus

Reference

Module:: Az.Synapse

Gets detail status about a link connection in workspace.

Syntax

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

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

Description

The Get-AzSynapseLinkConnectionDetailedStatus cmdlet gets detail status about a link connection in workspace. After starting/stopping a link connection, you can use this cmdlet to get the status of the link connection.

Examples

Example 1

Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection

Gets detail status about link connection ContosoLinkConnection in the workspace ContosoWorkspace.

Example 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseLinkConnectionDetailedStatus -Name ContosoLinkConnection

This command gets detail status about link connection ContosoLinkConnection under a workspace through pipeline.

Example 3

Start-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection

Starts a link connection named ContosoLinkConnection in workspace ContosoWorkspace, it will cost some time to start, then you can call Get-AzSynapseLinkConnectionDetailedStatus to monitor its status.

Example 4

Stop-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection

Stops a link connection named ContosoLinkConnection in workspace ContosoWorkspace, it will cost some time from running to stop, then you can call Get-AzSynapseLinkConnectionDetailedStatus to monitor its status.

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:	True
Accept pipeline input:	True
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

String

Outputs

PSLinkConnectionDetailedStatus