integration_runtime_nodes

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

Overview

Name	integration_runtime_nodes
Type	Resource
Id	azure.synapse.integration_runtime_nodes

Fields

The following fields are returned by SELECT queries:

get

OK.

Name	Datatype	Description
capabilities	object	The integration runtime capabilities dictionary
concurrentJobsLimit	integer (int32)	Maximum concurrent jobs on the integration runtime node.
expiryTime	string (date-time)	The time at which the integration runtime will expire in ISO8601 format.
hostServiceUri	string	URI for the host machine of the integration runtime.
isActiveDispatcher	boolean	Indicates whether this node is the active dispatcher for integration runtime requests.
lastConnectTime	string (date-time)	The most recent time at which the integration runtime was connected in ISO8601 format.
lastEndUpdateTime	string (date-time)	The last time for the integration runtime node update end.
lastStartTime	string (date-time)	The time the node last started up.
lastStartUpdateTime	string (date-time)	The last time for the integration runtime node update start.
lastStopTime	string (date-time)	The integration runtime node last stop time.
lastUpdateResult	string	The result of the last integration runtime node update.
machineName	string	Machine name of the integration runtime node.
maxConcurrentJobs	integer (int32)	The maximum concurrent jobs in this integration runtime.
nodeName	string	Name of the integration runtime node.
registerTime	string (date-time)	The time at which the integration runtime node was registered in ISO8601 format.
status	string	Status of the integration runtime node.
version	string	Version of the integration runtime node.
versionStatus	string	Status of the integration runtime node version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName, nodeName		Get an integration runtime node
update	update	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName, nodeName		Create an integration runtime node
delete	delete	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName, nodeName		Delete an integration runtime node

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
nodeName	string	Integration runtime node 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

get

Get an integration runtime node

SELECT
capabilities,
concurrentJobsLimit,
expiryTime,
hostServiceUri,
isActiveDispatcher,
lastConnectTime,
lastEndUpdateTime,
lastStartTime,
lastStartUpdateTime,
lastStopTime,
lastUpdateResult,
machineName,
maxConcurrentJobs,
nodeName,
registerTime,
status,
version,
versionStatus
FROM azure.synapse.integration_runtime_nodes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND integrationRuntimeName = '{{ integrationRuntimeName }}' -- required
AND nodeName = '{{ nodeName }}' -- required
;

UPDATE examples

update

Create an integration runtime node

UPDATE azure.synapse.integration_runtime_nodes
SET 
data__concurrentJobsLimit = {{ concurrentJobsLimit }}
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND integrationRuntimeName = '{{ integrationRuntimeName }}' --required
AND nodeName = '{{ nodeName }}' --required
RETURNING
capabilities,
concurrentJobsLimit,
expiryTime,
hostServiceUri,
isActiveDispatcher,
lastConnectTime,
lastEndUpdateTime,
lastStartTime,
lastStartUpdateTime,
lastStopTime,
lastUpdateResult,
machineName,
maxConcurrentJobs,
nodeName,
registerTime,
status,
version,
versionStatus;

DELETE examples

delete

Delete an integration runtime node

DELETE FROM azure.synapse.integration_runtime_nodes
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND integrationRuntimeName = '{{ integrationRuntimeName }}' --required
AND nodeName = '{{ nodeName }}' --required
;