keys

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

Overview

Name	keys
Type	Resource
Id	azure.synapse.keys

Fields

vw_keys

Name	Datatype	Description
is_active_cmk	text	field from the properties object
keyName	text	field from the properties object
key_vault_url	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
workspaceName	text	field from the properties object

keys

Name	Datatype	Description
properties	object	Key properties

Methods

Name	Accessible by	Required Params	Description
get	SELECT	keyName, resourceGroupName, subscriptionId, workspaceName	Gets a workspace key
list_by_workspace	SELECT	resourceGroupName, subscriptionId, workspaceName	Returns a list of keys in a workspace
create_or_update	INSERT	keyName, resourceGroupName, subscriptionId, workspaceName	Creates or updates a workspace key
delete	DELETE	keyName, resourceGroupName, subscriptionId, workspaceName	Deletes a workspace key

SELECT examples

Returns a list of keys in a workspace

vw_keys

SELECT
is_active_cmk,
keyName,
key_vault_url,
resourceGroupName,
subscriptionId,
workspaceName
FROM azure.synapse.vw_keys
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

keys

SELECT
properties
FROM azure.synapse.keys
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

INSERT example

Use the following StackQL query and manifest file to create a new keys resource.

All Properties

/*+ create */
INSERT INTO azure.synapse.keys (
keyName,
resourceGroupName,
subscriptionId,
workspaceName,
properties
)
SELECT 
'{{ keyName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: isActiveCMK
          value: boolean
        - name: keyVaultUrl
          value: string

DELETE example

Deletes the specified keys resource.

/*+ delete */
DELETE FROM azure.synapse.keys
WHERE keyName = '{{ keyName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';