transparent_data_encryptions

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

Overview

Name	transparent_data_encryptions
Type	Resource
Id	azure.sql.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.
scanState	string	Specifies the encryption scan state of the transparent data encryption. Known values are: "None", "Resume", "Running", "Suspend", "Aborted", and "Completed". (None, Resume, Running, Suspend, Aborted, Completed)
state	string	Specifies the state of the transparent data encryption. Required. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_database

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.
scanState	string	Specifies the encryption scan state of the transparent data encryption. Known values are: "None", "Resume", "Running", "Suspend", "Aborted", and "Completed". (None, Resume, Running, Suspend, Aborted, Completed)
state	string	Specifies the state of the transparent data encryption. Required. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, server_name, database_name, tde_name, subscription_id		Gets a logical database's transparent data encryption.
list_by_database	select	resource_group_name, server_name, database_name, subscription_id		Gets a list of the logical database's transparent data encryption.
create_or_update	insert	resource_group_name, server_name, database_name, tde_name, subscription_id		Updates a logical database's transparent data encryption configuration.
create_or_update	replace	resource_group_name, server_name, database_name, tde_name, subscription_id		Updates a logical database's transparent data encryption configuration.
resume	exec	resource_group_name, server_name, database_name, tde_name, subscription_id		Resume ongoing logical database's Transparent Data Encryption scan configuration.
suspend	exec	resource_group_name, server_name, database_name, tde_name, subscription_id		Suspend ongoing logical database's Transparent Data Encryption scan 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
database_name	string	The name of the database. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string
tde_name	string	The name of the transparent data encryption configuration. "current" Required.

SELECT examples

get

Gets a logical database's transparent data encryption.

SELECT
id,
name,
scanState,
state,
systemData,
type
FROM azure.sql.transparent_data_encryptions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND tde_name = '{{ tde_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_database

Gets a list of the logical database's transparent data encryption.

SELECT
id,
name,
scanState,
state,
systemData,
type
FROM azure.sql.transparent_data_encryptions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Updates a logical database's transparent data encryption configuration.

INSERT INTO azure.sql.transparent_data_encryptions (
properties,
resource_group_name,
server_name,
database_name,
tde_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ database_name }}',
'{{ tde_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: transparent_data_encryptions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the transparent_data_encryptions resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the transparent_data_encryptions resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the transparent_data_encryptions resource.
  - name: tde_name
    value: "{{ tde_name }}"
    description: Required parameter for the transparent_data_encryptions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the transparent_data_encryptions resource.
  - name: properties
    description: |
      Resource properties.
    value:
      state: "{{ state }}"
      scanState: "{{ scanState }}"

REPLACE examples

create_or_update

Updates a logical database's transparent data encryption configuration.

REPLACE azure.sql.transparent_data_encryptions
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND database_name = '{{ database_name }}' --required
AND tde_name = '{{ tde_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

Lifecycle Methods

resume

Resume ongoing logical database's Transparent Data Encryption scan configuration.

EXEC azure.sql.transparent_data_encryptions.resume 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@tde_name='{{ tde_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

suspend

Suspend ongoing logical database's Transparent Data Encryption scan configuration.

EXEC azure.sql.transparent_data_encryptions.suspend 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@tde_name='{{ tde_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;