spark_configuration

Creates, updates, deletes, gets or lists a spark_configuration resource.

Overview

Name	spark_configuration
Type	Resource
Id	azure.synapse.spark_configuration

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
annotations	array	Annotations for SparkConfiguration.
configMergeRule	object	SparkConfiguration merge configs.
configs	object	SparkConfiguration configs. Required.
created	string (date-time)	The timestamp of resource creation.
createdBy	string	The identity that created the resource.
description	string	Description about the SparkConfiguration.
etag	string	Resource Etag.
notes	string	additional Notes.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, spark_configuration_name, workspace_name, subscription_id		Get SparkConfiguration by name. Get SparkConfiguration by name in a workspace.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
spark_configuration_name	string	SparkConfiguration name. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Get SparkConfiguration by name. Get SparkConfiguration by name in a workspace.

SELECT
id,
name,
annotations,
configMergeRule,
configs,
created,
createdBy,
description,
etag,
notes,
type
FROM azure.synapse.spark_configuration
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND spark_configuration_name = '{{ spark_configuration_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;