sql_pool_transparent_data_encryptions

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

Overview

Name	sql_pool_transparent_data_encryptions
Type	Resource
Id	azure.synapse.sql_pool_transparent_data_encryptions

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.
location	string	Resource location.
status	string	The status of the database transparent data encryption. Known values are: "Enabled" and "Disabled".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
location	string	Resource location.
status	string	The status of the database transparent data encryption. Known values are: "Enabled" and "Disabled".
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, workspace_name, sql_pool_name, transparent_data_encryption_name, subscription_id		Get a SQL pool's transparent data encryption configuration. Get a SQL pool's transparent data encryption configuration.
list	select	resource_group_name, workspace_name, sql_pool_name, subscription_id		SQL pool's transparent data encryption configurations. Get list of SQL pool's transparent data encryption configurations.
create_or_update	insert	resource_group_name, workspace_name, sql_pool_name, transparent_data_encryption_name, subscription_id		Creates or updates a Sql pool's transparent data encryption configuration. Creates or updates a Sql pool's transparent data encryption configuration.
create_or_update	replace	resource_group_name, workspace_name, sql_pool_name, transparent_data_encryption_name, subscription_id		Creates or updates a Sql pool's transparent data encryption configuration. Creates or updates a Sql pool's transparent data encryption configuration.

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.
sql_pool_name	string	SQL pool name. Required.
subscription_id	string
transparent_data_encryption_name	string	The name of the transparent data encryption configuration. "current" Required.
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Get a SQL pool's transparent data encryption configuration. Get a SQL pool's transparent data encryption configuration.

SELECT
id,
name,
location,
status,
type
FROM azure.synapse.sql_pool_transparent_data_encryptions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND transparent_data_encryption_name = '{{ transparent_data_encryption_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

SQL pool's transparent data encryption configurations. Get list of SQL pool's transparent data encryption configurations.

SELECT
id,
name,
location,
status,
type
FROM azure.synapse.sql_pool_transparent_data_encryptions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Sql pool's transparent data encryption configuration. Creates or updates a Sql pool's transparent data encryption configuration.

INSERT INTO azure.synapse.sql_pool_transparent_data_encryptions (
properties,
resource_group_name,
workspace_name,
sql_pool_name,
transparent_data_encryption_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ sql_pool_name }}',
'{{ transparent_data_encryption_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: sql_pool_transparent_data_encryptions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sql_pool_transparent_data_encryptions resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the sql_pool_transparent_data_encryptions resource.
  - name: sql_pool_name
    value: "{{ sql_pool_name }}"
    description: Required parameter for the sql_pool_transparent_data_encryptions resource.
  - name: transparent_data_encryption_name
    value: "{{ transparent_data_encryption_name }}"
    description: Required parameter for the sql_pool_transparent_data_encryptions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sql_pool_transparent_data_encryptions resource.
  - name: properties
    value:
      status: "{{ status }}"

REPLACE examples

create_or_update

Creates or updates a Sql pool's transparent data encryption configuration. Creates or updates a Sql pool's transparent data encryption configuration.

REPLACE azure.synapse.sql_pool_transparent_data_encryptions
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND sql_pool_name = '{{ sql_pool_name }}' --required
AND transparent_data_encryption_name = '{{ transparent_data_encryption_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
type;