Get-AzSynapseSparkConfiguration

Reference

Module:: Az.Synapse

Gets information about spark configurations in a workspace.

Syntax

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

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

Description

The Get-AzSynapseSparkConfiguration cmdlet gets information about spark configurations in a workspace. If you specify the name of a spark configuration, the cmdlet gets information about that spark configuration. If you do not specify a name, the cmdlet gets information about all spark configurations in the workspace.

Examples

Example 1

Get-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace

Gets a list of all spark configurations in the workspace ContosoWorkspace.

Example 2

Get-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -Name ContosoSparkConfiguration

Gets a single spark configuration called ContosoSparkConfiguration in the workspace ContosoWorkspace.

Example 3

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseSparkConfiguration -Name ContosoSparkConfiguration

Gets a single spark configuration called ContosoSparkConfiguration 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 Spark Configuration name.

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

PSSparkConfigurationResource