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

OK.

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	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName		List authentication keys in an integration runtime
regenerate	exec	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName		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
integrationRuntimeName	string	Integration runtime name
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

list

List authentication keys in an integration runtime

SELECT
authKey1,
authKey2
FROM azure.synapse.integration_runtime_auth_keys
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND integrationRuntimeName = '{{ integrationRuntimeName }}' -- required
;

Lifecycle Methods

regenerate

Regenerate the authentication key for an integration runtime

EXEC azure.synapse.integration_runtime_auth_keys.regenerate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@integrationRuntimeName='{{ integrationRuntimeName }}' --required 
@@json=
'{
"keyName": "{{ keyName }}"
}'
;