workspace_managed_sql_server_encryption_protector

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

Overview

Name	workspace_managed_sql_server_encryption_protector
Type	Resource
Id	azure.synapse.workspace_managed_sql_server_encryption_protector

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.
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'. Known values are: "ServiceManaged" and "AzureKeyVault".
subregion	string	Subregion of the encryption protector.
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

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.
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'. Known values are: "ServiceManaged" and "AzureKeyVault".
subregion	string	Subregion of the encryption protector.
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, workspace_name, encryption_protector_name, subscription_id		Get workspace server's encryption protector. Get workspace managed sql server's encryption protector.
list	select	resource_group_name, workspace_name, subscription_id		Get list of encryption protectors for the server. Get list of encryption protectors for workspace managed sql server.
create_or_update	insert	resource_group_name, workspace_name, encryption_protector_name, subscription_id		Updates workspace server's encryption protector. Updates workspace managed sql server's encryption protector.
create_or_update	replace	resource_group_name, workspace_name, encryption_protector_name, subscription_id		Updates workspace server's encryption protector. Updates workspace managed sql server's encryption protector.
revalidate	exec	resource_group_name, workspace_name, encryption_protector_name, subscription_id		Revalidates server's existing encryption protector. 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
encryption_protector_name	string	The name of the encryption protector. "current" Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Get workspace server's encryption protector. Get workspace managed sql server's encryption protector.

SELECT
id,
name,
kind,
location,
serverKeyName,
serverKeyType,
subregion,
thumbprint,
type,
uri
FROM azure.synapse.workspace_managed_sql_server_encryption_protector
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND encryption_protector_name = '{{ encryption_protector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get list of encryption protectors for the server. Get list of encryption protectors for workspace managed sql server.

SELECT
id,
name,
kind,
location,
serverKeyName,
serverKeyType,
subregion,
thumbprint,
type,
uri
FROM azure.synapse.workspace_managed_sql_server_encryption_protector
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Updates workspace server's encryption protector. Updates workspace managed sql server's encryption protector.

INSERT INTO azure.synapse.workspace_managed_sql_server_encryption_protector (
properties,
resource_group_name,
workspace_name,
encryption_protector_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ encryption_protector_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
location,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace_managed_sql_server_encryption_protector
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace_managed_sql_server_encryption_protector resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the workspace_managed_sql_server_encryption_protector resource.
  - name: encryption_protector_name
    value: "{{ encryption_protector_name }}"
    description: Required parameter for the workspace_managed_sql_server_encryption_protector resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_managed_sql_server_encryption_protector resource.
  - name: properties
    value:
      serverKeyName: "{{ serverKeyName }}"
      serverKeyType: "{{ serverKeyType }}"

REPLACE examples

create_or_update

Updates workspace server's encryption protector. Updates workspace managed sql server's encryption protector.

REPLACE azure.synapse.workspace_managed_sql_server_encryption_protector
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND encryption_protector_name = '{{ encryption_protector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
kind,
location,
properties,
type;

Lifecycle Methods

revalidate

Revalidates server's existing encryption protector. Revalidates workspace managed sql server's existing encryption protector.

EXEC azure.synapse.workspace_managed_sql_server_encryption_protector.revalidate 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@encryption_protector_name='{{ encryption_protector_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;