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
location	string	Resource location.
properties	object	Represents the properties of the resource.

list

Name	Datatype	Description
location	string	Resource location.
properties	object	Represents the properties of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, transparentDataEncryptionName		Get a SQL pool's transparent data encryption configuration.
list	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName		Get list of SQL pool's transparent data encryption configurations.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, transparentDataEncryptionName		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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
sqlPoolName	string	SQL pool name
subscriptionId	string	The ID of the target subscription.
transparentDataEncryptionName	string	The name of the transparent data encryption configuration.
workspaceName	string	The name of the workspace.

SELECT examples

get

Get a SQL pool's transparent data encryption configuration.

SELECT
location,
properties
FROM azure.synapse.sql_pool_transparent_data_encryptions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
AND transparentDataEncryptionName = '{{ transparentDataEncryptionName }}' -- required
;

list

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

SELECT
location,
properties
FROM azure.synapse.sql_pool_transparent_data_encryptions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.synapse.sql_pool_transparent_data_encryptions (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
sqlPoolName,
transparentDataEncryptionName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ sqlPoolName }}',
'{{ transparentDataEncryptionName }}'
RETURNING
location,
properties
;

Manifest

# Description fields are for documentation purposes
- name: sql_pool_transparent_data_encryptions
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_pool_transparent_data_encryptions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_pool_transparent_data_encryptions resource.
    - name: workspaceName
      value: string
      description: Required parameter for the sql_pool_transparent_data_encryptions resource.
    - name: sqlPoolName
      value: string
      description: Required parameter for the sql_pool_transparent_data_encryptions resource.
    - name: transparentDataEncryptionName
      value: string
      description: Required parameter for the sql_pool_transparent_data_encryptions resource.
    - name: properties
      value: object
      description: |
        Represents the properties of the resource.