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

Workspace Key details

Name	Datatype	Description
properties	object	Keys resource properties

list_by_workspace

The list of workspace keys.

Name	Datatype	Description
properties	object	Keys resource properties

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, keyName		Gets a workspace key
list_by_workspace	select	subscriptionId, resourceGroupName, workspaceName		Returns a list of keys in a workspace
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, keyName		Creates or updates a workspace key
delete	delete	subscriptionId, resourceGroupName, workspaceName, keyName		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
keyName	string	The name of the workspace key
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

Gets a workspace key

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

list_by_workspace

Returns a list of keys in a workspace

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

INSERT examples

create_or_update

Creates or updates a workspace key

INSERT INTO azure.synapse.keys (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
keyName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ keyName }}'
RETURNING
properties
;

Manifest

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

DELETE examples

delete

Deletes a workspace key

DELETE FROM azure.synapse.keys
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND keyName = '{{ keyName }}' --required
;