encryption_protectors

Creates, updates, deletes, gets or lists an encryption_protectors resource.

Overview

Name	encryption_protectors
Type	Resource
Id	azure.sql.encryption_protectors

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.
autoRotationEnabled	boolean	Key auto rotation opt-in flag. Either true or false.
keyVersion	string	The version of the server key being used as encryption protector.
kind	string	Kind of encryption protector. This is metadata used for the Azure portal experience.
location	string	Resource location.
serverKeyName	string	The name of the server key.
serverKeyType	string	The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. Required. Known values are: "ServiceManaged" and "AzureKeyVault". (ServiceManaged, AzureKeyVault)
subregion	string	Subregion of the encryption protector.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
thumbprint	string	Thumbprint of the server key.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uri	string	The URI of the server key.

list_by_server

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.
autoRotationEnabled	boolean	Key auto rotation opt-in flag. Either true or false.
keyVersion	string	The version of the server key being used as encryption protector.
kind	string	Kind of encryption protector. This is metadata used for the Azure portal experience.
location	string	Resource location.
serverKeyName	string	The name of the server key.
serverKeyType	string	The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. Required. Known values are: "ServiceManaged" and "AzureKeyVault". (ServiceManaged, AzureKeyVault)
subregion	string	Subregion of the encryption protector.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
thumbprint	string	Thumbprint of the server key.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uri	string	The URI of the server key.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, encryption_protector_name, subscription_id		Gets a server encryption protector.
list_by_server	select	resource_group_name, server_name, subscription_id		Gets a list of server encryption protectors.
create_or_update	insert	resource_group_name, server_name, encryption_protector_name, subscription_id		Updates an existing encryption protector.
create_or_update	replace	resource_group_name, server_name, encryption_protector_name, subscription_id		Updates an existing encryption protector.
revalidate	exec	resource_group_name, server_name, encryption_protector_name, subscription_id		Revalidates an existing encryption protector.

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
encryption_protector_name	string	The name of the encryption protector to be retrieved. "current" 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

SELECT examples

get

Gets a server encryption protector.

SELECT
id,
name,
autoRotationEnabled,
keyVersion,
kind,
location,
serverKeyName,
serverKeyType,
subregion,
systemData,
thumbprint,
type,
uri
FROM azure.sql.encryption_protectors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND encryption_protector_name = '{{ encryption_protector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Gets a list of server encryption protectors.

SELECT
id,
name,
autoRotationEnabled,
keyVersion,
kind,
location,
serverKeyName,
serverKeyType,
subregion,
systemData,
thumbprint,
type,
uri
FROM azure.sql.encryption_protectors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Updates an existing encryption protector.

INSERT INTO azure.sql.encryption_protectors (
properties,
resource_group_name,
server_name,
encryption_protector_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ encryption_protector_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: encryption_protectors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the encryption_protectors resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the encryption_protectors resource.
  - name: encryption_protector_name
    value: "{{ encryption_protector_name }}"
    description: Required parameter for the encryption_protectors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the encryption_protectors resource.
  - name: properties
    description: |
      Resource properties.
    value:
      subregion: "{{ subregion }}"
      serverKeyName: "{{ serverKeyName }}"
      serverKeyType: "{{ serverKeyType }}"
      uri: "{{ uri }}"
      thumbprint: "{{ thumbprint }}"
      autoRotationEnabled: {{ autoRotationEnabled }}
      keyVersion: "{{ keyVersion }}"

REPLACE examples

create_or_update

Updates an existing encryption protector.

REPLACE azure.sql.encryption_protectors
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND encryption_protector_name = '{{ encryption_protector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
kind,
location,
properties,
systemData,
type;

Lifecycle Methods

revalidate

Revalidates an existing encryption protector.

EXEC azure.sql.encryption_protectors.revalidate 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@encryption_protector_name='{{ encryption_protector_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;