Start-AzSynapseLinkConnection

Module:

Az.Synapse

Starts a link connection.

Syntax

Start-AzSynapseLinkConnection
     -WorkspaceName <String>
     -Name <String>
     [-PassThru]
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-AzSynapseLinkConnection
     -WorkspaceObject <PSSynapseWorkspace>
     -Name <String>
     [-PassThru]
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-AzSynapseLinkConnection
     -InputObject <PSLinkConnectionResource>
     [-PassThru]
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Start-AzSynapseLinkConnection cmdlet starts a link connection in workspace. It will cost some time from starting to running, after calling this cmdlet you can check the detail status by calling Get-AzSynapseLinkConnectionDetailedStatus.

Examples

Example 1

Start-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection

This command starts a link connection named ContosoLinkConnection in workspace.

Example 2

$ws = Get-AzSynapseWorkspace -Workspacename ContosoWorkspace
$ws | Start-AzSynapseLinkConnection -Name ContosoLinkConnection

This command starts a link connection named ContosoLinkConnection in workspace through pipeline.

Example 3

$linkConnection = Get-AzSynapseLinkConnection -Workspacename ContosoWorkspace -Name ContosoLinkConnection
$linkConnection | Start-AzSynapseLinkConnection

This command starts a link connection named ContosoLinkConnection in workspace through pipeline.

Example 4

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

WorkspaceName     : ContosoWorkspace
Id                : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Name              : ContosoLinkConnection
IsApplyingChanges :
IsPartiallyFailed : False
StartTime         : 2022-03-10T07:57:37.8730044Z
StopTime          :
Status            : Starting
ContinuousRunId   : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Error             :

The Start-AzSynapseLinkConnection command starts a link connection named ContosoLinkConnection in workspace, then you can call Get-AzSynapseLinkConnectionDetailedStatus to get status of the link connection.

Parameters

-AsJob

Run cmdlet in the background

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

-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 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

-InputObject

The Synapse link connection object for Azure Sql Database.

Type:	PSLinkConnectionResource
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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:	False
Accept wildcard characters:	False

-PassThru

This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful.

Type:	SwitchParameter
Position:	Named
Default value:	None
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

-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

PSLinkConnectionResource

Outputs

Boolean