Get-AzSynapseKqlScript

Module:

Az.Synapse

Gets information about KQL scripts in a workspace.

Syntax

Get-AzSynapseKqlScript
   -WorkspaceName <String>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

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

Description

The Get-AzSynapseKqlScript cmdlet gets information about KQL scripts in a workspace. If you specify the name of a KQL script, the cmdlet gets information about that KQL script. If you do not specify a name, the cmdlet gets information about all KQL scripts in the workspace.

Examples

Example 1

Get-AzSynapseKqlScript -WorkspaceName ContosoWorkspace

Gets a list of all KQL scripts in the workspace ContosoWorkspace.

Example 2

Get-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -Name ContosoKqlScript

Gets a single KQL script called ContosoKqlScript in the workspace ContosoWorkspace.

Example 3

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseKqlScript -Name ContosoKqlScript

Gets a single KQL script called ContosoKqlScript in the workspace 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

KQL script name.

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

PSKqlScriptResource