workspace_managed_sql_server_encryption_protectors

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

Overview

Name	workspace_managed_sql_server_encryption_protectors
Type	Resource
Id	azure.synapse.workspace_managed_sql_server_encryption_protectors

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved 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

Successfully retrieved encryption protectors.

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	subscriptionId, resourceGroupName, workspaceName, encryptionProtectorName		Get workspace managed sql server's encryption protector.
list	select	subscriptionId, resourceGroupName, workspaceName		Get list of encryption protectors for workspace managed sql server.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, encryptionProtectorName		Updates workspace managed sql server's encryption protector.
revalidate	exec	subscriptionId, resourceGroupName, workspaceName, encryptionProtectorName		Revalidates workspace managed sql server's 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.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Get workspace managed sql server's encryption protector.

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

list

Get list of encryption protectors for workspace managed sql server.

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

INSERT examples

create_or_update

Updates workspace managed sql server's encryption protector.

INSERT INTO azure.synapse.workspace_managed_sql_server_encryption_protectors (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
encryptionProtectorName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ encryptionProtectorName }}'
RETURNING
kind,
location,
properties
;

Manifest

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

Lifecycle Methods

revalidate

Revalidates workspace managed sql server's existing encryption protector.

EXEC azure.synapse.workspace_managed_sql_server_encryption_protectors.revalidate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@encryptionProtectorName='{{ encryptionProtectorName }}' --required
;