keys

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

Overview

Name	keys
Type	Resource
Id	azure.synapse.keys

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.
isActiveCMK	boolean	Used to activate the workspace after a customer managed key is provided.
keyVaultUrl	string	The Key Vault Url of the workspace key.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_workspace

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.
isActiveCMK	boolean	Used to activate the workspace after a customer managed key is provided.
keyVaultUrl	string	The Key Vault Url of the workspace key.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, key_name, subscription_id		Gets a workspace key.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		Returns a list of keys in a workspace.
create_or_update	insert	resource_group_name, workspace_name, key_name, subscription_id		Creates or updates a workspace key.
create_or_update	replace	resource_group_name, workspace_name, key_name, subscription_id		Creates or updates a workspace key.
delete	delete	resource_group_name, workspace_name, key_name, subscription_id		Deletes a workspace key.

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
key_name	string	The name of the workspace key. 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

Gets a workspace key.

SELECT
id,
name,
isActiveCMK,
keyVaultUrl,
type
FROM azure.synapse.keys
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND key_name = '{{ key_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

Returns a list of keys in a workspace.

SELECT
id,
name,
isActiveCMK,
keyVaultUrl,
type
FROM azure.synapse.keys
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

Creates or updates a workspace key.

INSERT INTO azure.synapse.keys (
properties,
resource_group_name,
workspace_name,
key_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ key_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: keys
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the keys resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the keys resource.
  - name: key_name
    value: "{{ key_name }}"
    description: Required parameter for the keys resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the keys resource.
  - name: properties
    value:
      isActiveCMK: {{ isActiveCMK }}
      keyVaultUrl: "{{ keyVaultUrl }}"

REPLACE examples

create_or_update

Creates or updates a workspace key.

REPLACE azure.synapse.keys
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND key_name = '{{ key_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes a workspace key.

DELETE FROM azure.synapse.keys
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND key_name = '{{ key_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;