managed_database_transparent_data_encryptions

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

Overview

Name	managed_database_transparent_data_encryptions
Type	Resource
Id	azure.sql.managed_database_transparent_data_encryptions

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the managed database transparent data encryption.

Name	Datatype	Description
properties	object	Resource properties.

list_by_database

Successfully retrieved the list of managed database transparent data encryptions.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, managedInstanceName, databaseName, tdeName, subscriptionId		Gets a managed database's transparent data encryption.
list_by_database	select	resourceGroupName, managedInstanceName, databaseName, subscriptionId		Gets a list of managed database's transparent data encryptions.
create_or_update	insert	resourceGroupName, managedInstanceName, databaseName, tdeName, subscriptionId		Updates a database'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
databaseName	string	The name of the managed database for which the security alert policy is defined.
managedInstanceName	string	The name of the managed instance.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	string	The subscription ID that identifies an Azure subscription.
tdeName	string	The name of the transparent data encryption configuration.

SELECT examples

get

Gets a managed database's transparent data encryption.

SELECT
properties
FROM azure.sql.managed_database_transparent_data_encryptions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND tdeName = '{{ tdeName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_database

Gets a list of managed database's transparent data encryptions.

SELECT
properties
FROM azure.sql.managed_database_transparent_data_encryptions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Updates a database's transparent data encryption configuration.

INSERT INTO azure.sql.managed_database_transparent_data_encryptions (
data__properties,
resourceGroupName,
managedInstanceName,
databaseName,
tdeName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ managedInstanceName }}',
'{{ databaseName }}',
'{{ tdeName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: managed_database_transparent_data_encryptions
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the managed_database_transparent_data_encryptions resource.
    - name: managedInstanceName
      value: string
      description: Required parameter for the managed_database_transparent_data_encryptions resource.
    - name: databaseName
      value: string
      description: Required parameter for the managed_database_transparent_data_encryptions resource.
    - name: tdeName
      value: string
      description: Required parameter for the managed_database_transparent_data_encryptions resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the managed_database_transparent_data_encryptions resource.
    - name: properties
      value: object
      description: |
        Resource properties.