integration_runtime_credentials
Creates, updates, deletes, gets or lists an integration_runtime_credentials resource.
Overview​
| Name | integration_runtime_credentials |
| Type | Resource |
| Id | azure.synapse.integration_runtime_credentials |
Fields​
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
sync | exec | resource_group_name, workspace_name, integration_runtime_name, subscription_id | Sync integration runtime credentials. Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly. |
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. |
Lifecycle Methods​
- sync
Sync integration runtime credentials. Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.
EXEC azure.synapse.integration_runtime_credentials.sync
@resource_group_name='{{ resource_group_name }}' --required,
@workspace_name='{{ workspace_name }}' --required,
@integration_runtime_name='{{ integration_runtime_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
;