Get-AzSynapseSparkJobDefinition

Reference

Module:: Az.Synapse

Gets a Spark job definition in workspace.

Syntax

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

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

Description

The Get-AzSynapseSparkJobDefinition cmdlet gets information about Spark job definitions in workspace. If you specify the name of a Spark job definition, this cmdlet gets information about that Spark job definition. If you do not specify a name, this cmdlet gets information about all the Spark job definitions in the workspace.

Examples

Example 1

Get-AzSynapseSparkJobDefinition -WorkspaceName ContosoWorkspace

This command gets information about all Spark job definitions in the workspace named ContosoWorkspace.

Example 2

Get-AzSynapseSparkJobDefinition -WorkspaceName ContosoWorkspace -Name ContosoJobDefinition

This command gets information about the Spark job definition named ContosoSparkJobDefinition in the workspace named ContosoWorkspace.

Example 3

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseSparkJobDefinition -Name ContosoSparkJobDefinition

This command gets information about the Spark job definition named ContosoSparkJobDefinition 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 Spark job definition name.

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

PSSparkJobDefinitionResource

Share via