Stop-AzSynapseLinkConnection

Stops a link connection.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Stop-AzSynapseLinkConnection
    -WorkspaceName <String>
    -Name <String>
    [-PassThru]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzSynapseLinkConnection
    -WorkspaceObject <PSSynapseWorkspace>
    -Name <String>
    [-PassThru]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzSynapseLinkConnection
    -InputObject <PSLinkConnectionResource>
    [-PassThru]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

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

Examples

Example 1

Stop-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection

This command stops a link connection named ContosoLinkConnection in workspace.

Example 2

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

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

Example 3

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

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

Example 4

Stop-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-10T06:59:34.5820499Z
StopTime          : 2022-03-10T07:21:42.4895248Z
Status            : Stopping
ContinuousRunId   :
Error             :

This command stops 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
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
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
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
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
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
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
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceName

Name of Synapse workspace.

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

-WorkspaceObject

workspace input object, usually passed through the pipeline.

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

Inputs

PSSynapseWorkspace

PSLinkConnectionResource

Outputs

Boolean