Edit

Get-AzSynapseSqlScript

  • Reference
Module:
Az.Synapse

Gets information about sql scripts in a Synapse workspace.

Syntax

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

Description

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

Examples

Example 1

Get-AzSynapseSqlScript -workspaceName ContosoWorkspace

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

Example 2

Get-AzSynapseSqlScript -workspaceName ContosoWorkspace -Name "ContosoSqlScript"

Gets a single sql script called ContosoSqlScript in the workspace ContosoWorkspace.

Example 3

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseSqlScript -Name ContosoSqlScript

Gets a single sql script called ContosoSqlScript 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

The sql script name.

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

PSSqlScriptResource