Get-AzSynapseLinkedService

  • Reference
Module:
Az.Synapse

Gets information about linked services in workspace.

Syntax

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

Description

The Get-AzSynapseLinkedService cmdlet gets information about linked services in workspace. If you specify the name of a linked service, this cmdlet gets information about that linked service. If you do not specify a name, this cmdlet gets information about all the linked services in the workspace.

Examples

Example 1

Get-AzSynapseLinkedService -WorkspaceName ContosoWorkspace

This command gets information about all linked services in the workspace named ContosoWorkspace.

Example 2

Get-AzSynapseLinkedService -WorkspaceName ContosoWorkspace -Name ContosoLinkedService

This command gets information about the linked service named ContosoLinkedService in the workspace named ContosoWorkspace.

Example 3

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseLinkedService -Name ContosoLinkedService

This command gets information about the linked service named ContosoLinkedService in the workspace named ContosoWorkspace through pipeline.

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 linked service name.

Type:String
Aliases:LinkedServiceName
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

Outputs

PSLinkedServiceResource