spark_configuration

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

Overview

Name	spark_configuration
Type	Resource
Id	azure.synapse_artifacts.spark_configuration

Fields

The following fields are returned by SELECT queries:

get_spark_configuration

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
annotations	array	Annotations for SparkConfiguration.
configMergeRule	object	SparkConfiguration configMergeRule.
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".

get_spark_configurations_by_workspace

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
annotations	array	Annotations for SparkConfiguration.
configMergeRule	object	SparkConfiguration configMergeRule.
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_spark_configuration	select	spark_configuration_name, endpoint	If-None-Match	Gets a sparkConfiguration.
get_spark_configurations_by_workspace	select	endpoint		Lists sparkconfigurations.
create_or_update_spark_configuration	insert	spark_configuration_name, endpoint, configs	If-Match	Creates or updates a sparkconfiguration.
create_or_update_spark_configuration	replace	spark_configuration_name, endpoint, configs	If-Match	Creates or updates a sparkconfiguration.
delete_spark_configuration	delete	spark_configuration_name, endpoint		Deletes a sparkConfiguration.
rename_spark_configuration	exec	spark_configuration_name, endpoint		Renames a sparkConfiguration.

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
endpoint	string	The service endpoint host (no scheme). (default: )
spark_configuration_name	string	The spark Configuration name. Required.
If-Match	string	ETag of the sparkConfiguration entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.
If-None-Match	string	ETag of the sparkConfiguration entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. Default value is None.

SELECT examples

get_spark_configuration

Gets a sparkConfiguration.

SELECT
id,
name,
annotations,
configMergeRule,
configs,
created,
createdBy,
description,
etag,
notes,
type
FROM azure.synapse_artifacts.spark_configuration
WHERE spark_configuration_name = '{{ spark_configuration_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND If-None-Match = '{{ If-None-Match }}'
;

get_spark_configurations_by_workspace

Lists sparkconfigurations.

SELECT
id,
name,
annotations,
configMergeRule,
configs,
created,
createdBy,
description,
etag,
notes,
type
FROM azure.synapse_artifacts.spark_configuration
WHERE endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_or_update_spark_configuration

Creates or updates a sparkconfiguration.

INSERT INTO azure.synapse_artifacts.spark_configuration (
description,
configs,
annotations,
notes,
createdBy,
created,
configMergeRule,
spark_configuration_name,
endpoint,
If-Match
)
SELECT 
'{{ description }}',
'{{ configs }}' /* required */,
'{{ annotations }}',
'{{ notes }}',
'{{ createdBy }}',
'{{ created }}',
'{{ configMergeRule }}',
'{{ spark_configuration_name }}',
'{{ endpoint }}',
'{{ If-Match }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: spark_configuration
props:
  - name: spark_configuration_name
    value: "{{ spark_configuration_name }}"
    description: Required parameter for the spark_configuration resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the spark_configuration resource.
  - name: description
    value: "{{ description }}"
    description: |
      Description about the SparkConfiguration.
  - name: configs
    value: "{{ configs }}"
    description: |
      SparkConfiguration configs. Required.
  - name: annotations
    value:
      - "{{ annotations }}"
    description: |
      Annotations for SparkConfiguration.
  - name: notes
    value: "{{ notes }}"
    description: |
      additional Notes.
  - name: createdBy
    value: "{{ createdBy }}"
    description: |
      The identity that created the resource.
  - name: created
    value: "{{ created }}"
    description: |
      The timestamp of resource creation.
  - name: configMergeRule
    value: "{{ configMergeRule }}"
    description: |
      SparkConfiguration configMergeRule.
  - name: If-Match
    value: "{{ If-Match }}"
    description: ETag of the sparkConfiguration entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.
    description: ETag of the sparkConfiguration entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

REPLACE examples

create_or_update_spark_configuration

Creates or updates a sparkconfiguration.

REPLACE azure.synapse_artifacts.spark_configuration
SET 
description = '{{ description }}',
configs = '{{ configs }}',
annotations = '{{ annotations }}',
notes = '{{ notes }}',
createdBy = '{{ createdBy }}',
created = '{{ created }}',
configMergeRule = '{{ configMergeRule }}'
WHERE 
spark_configuration_name = '{{ spark_configuration_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND configs = '{{ configs }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete_spark_configuration

Deletes a sparkConfiguration.

DELETE FROM azure.synapse_artifacts.spark_configuration
WHERE spark_configuration_name = '{{ spark_configuration_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

rename_spark_configuration

Renames a sparkConfiguration.

EXEC azure.synapse_artifacts.spark_configuration.rename_spark_configuration 
@spark_configuration_name='{{ spark_configuration_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;