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

Successfully retrieved the specified server encryption protector.

Name	Datatype	Description
kind	string	Kind of encryption protector. This is metadata used for the Azure portal experience.
location	string	Resource location.
properties	object	Resource properties.

list_by_server

Successfully retrieved the list of server encryption protector.

Name	Datatype	Description
kind	string	Kind of encryption protector. This is metadata used for the Azure portal experience.
location	string	Resource location.
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, encryptionProtectorName, subscriptionId		Gets a server encryption protector.
list_by_server	select	resourceGroupName, serverName, subscriptionId		Gets a list of server encryption protectors
create_or_update	insert	resourceGroupName, serverName, encryptionProtectorName, subscriptionId		Updates an existing encryption protector.
revalidate	exec	resourceGroupName, serverName, encryptionProtectorName, subscriptionId		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
encryptionProtectorName	string	The name of the encryption protector to be updated.
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.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a server encryption protector.

SELECT
kind,
location,
properties
FROM azure.sql.encryption_protectors
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND encryptionProtectorName = '{{ encryptionProtectorName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_server

Gets a list of server encryption protectors

SELECT
kind,
location,
properties
FROM azure.sql.encryption_protectors
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Updates an existing encryption protector.

INSERT INTO azure.sql.encryption_protectors (
data__properties,
resourceGroupName,
serverName,
encryptionProtectorName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ encryptionProtectorName }}',
'{{ subscriptionId }}'
RETURNING
kind,
location,
properties
;

Manifest

# Description fields are for documentation purposes
- name: encryption_protectors
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the encryption_protectors resource.
    - name: serverName
      value: string
      description: Required parameter for the encryption_protectors resource.
    - name: encryptionProtectorName
      value: string
      description: Required parameter for the encryption_protectors resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the encryption_protectors resource.
    - name: properties
      value: object
      description: |
        Resource properties.

Lifecycle Methods

revalidate

Revalidates an existing encryption protector.

EXEC azure.sql.encryption_protectors.revalidate 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@encryptionProtectorName='{{ encryptionProtectorName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;