integration_runtime_auth_keys

Creates, updates, deletes, gets or lists an integration_runtime_auth_keys resource.

Overview

Name	integration_runtime_auth_keys
Type	Resource
Id	azure.synapse.integration_runtime_auth_keys

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
authKey1	string	The primary integration runtime authentication key.
authKey2	string	The secondary integration runtime authentication key.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resource_group_name, workspace_name, integration_runtime_name, subscription_id		List integration runtime authentication keys. List authentication keys in an integration runtime.
regenerate	exec	resource_group_name, workspace_name, integration_runtime_name, subscription_id		Regenerate integration runtime authentication key. Regenerate the authentication key for an integration runtime.

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
integration_runtime_name	string	Integration runtime name. 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

list

List integration runtime authentication keys. List authentication keys in an integration runtime.

SELECT
authKey1,
authKey2
FROM azure.synapse.integration_runtime_auth_keys
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND integration_runtime_name = '{{ integration_runtime_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

regenerate

Regenerate integration runtime authentication key. Regenerate the authentication key for an integration runtime.

EXEC azure.synapse.integration_runtime_auth_keys.regenerate 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyName": "{{ keyName }}"
}'
;