Remove-AzSynapseLinkConnection
Deletes a link connection from workspace.
Syntax
Remove-AzSynapseLinkConnection
-WorkspaceName <String>
-Name <String>
[-PassThru]
[-AsJob]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-AzSynapseLinkConnection
-WorkspaceObject <PSSynapseWorkspace>
-Name <String>
[-PassThru]
[-AsJob]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-AzSynapseLinkConnection
-InputObject <PSLinkConnectionResource>
[-PassThru]
[-AsJob]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Remove-AzSynapseLinkConnection cmdlet removes a link connection from workspace. Only link connections in initial or stpped status can be removed.
Examples
Example 1
Remove-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnectionThis command removes the link connection named ContosoLinkConnection from the workspace named ContosoWorkspace.
Example 2
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Remove-AzSynapseLinkConnection -Name ContosoLinkConnectionThis command removes the link connection named ContosoLinkConnection from the workspace named ContosoWorkspace through pipeline.
Example 3
$linkConnection = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
$linkConnection | Remove-AzSynapseLinkConnectionThis command removes the link connection named ContosoLinkConnection from the workspace named ContosoWorkspace through pipeline.
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 |
-Force
Do not ask for confirmation.
| Type: | SwitchParameter |
| 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 |
