Get-AzSynapseLinkConnectionDetailedStatus
Gets detail status about a link connection in workspace.
Syntax
GetByName (Default)
Get-AzSynapseLinkConnectionDetailedStatus
-WorkspaceName <String>
-Name <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByObject
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.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The Synapse link connection name for Azure Sql Database.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | LinkConnectionName |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WorkspaceName
Name of Synapse workspace.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WorkspaceObject
workspace input object, usually passed through the pipeline.
Parameter properties
| Type: | PSSynapseWorkspace |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
