integration_runtime_nodes

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

Overview

Name	integration_runtime_nodes
Type	Resource
Id	azure.data_factory.integration_runtime_nodes

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
capabilities	object	The integration runtime capabilities dictionary.
concurrentJobsLimit	integer	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. Known values are: "None", "Succeed", and "Fail". (None, Succeed, Fail)
machineName	string	Machine name of the integration runtime node.
maxConcurrentJobs	integer	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. Known values are: "NeedRegistration", "Online", "Limited", "Offline", "Upgrading", "Initializing", and "InitializeFailed". (NeedRegistration, Online, Limited, Offline, Upgrading, Initializing, InitializeFailed)
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	resource_group_name, factory_name, integration_runtime_name, node_name, subscription_id		Gets a self-hosted integration runtime node.
update	update	resource_group_name, factory_name, integration_runtime_name, node_name, subscription_id		Updates a self-hosted integration runtime node.
delete	delete	resource_group_name, factory_name, integration_runtime_name, node_name, subscription_id		Deletes a self-hosted integration runtime node.
get_ip_address	exec	resource_group_name, factory_name, integration_runtime_name, node_name, subscription_id		Get the IP address of self-hosted 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
factory_name	string	Required.
integration_runtime_name	string	Required.
node_name	string	The integration runtime node name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a self-hosted integration runtime node.

SELECT
capabilities,
concurrentJobsLimit,
expiryTime,
hostServiceUri,
isActiveDispatcher,
lastConnectTime,
lastEndUpdateTime,
lastStartTime,
lastStartUpdateTime,
lastStopTime,
lastUpdateResult,
machineName,
maxConcurrentJobs,
nodeName,
registerTime,
status,
version,
versionStatus
FROM azure.data_factory.integration_runtime_nodes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND integration_runtime_name = '{{ integration_runtime_name }}' -- required
AND node_name = '{{ node_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

UPDATE examples

update

Updates a self-hosted integration runtime node.

UPDATE azure.data_factory.integration_runtime_nodes
SET 
concurrentJobsLimit = {{ concurrentJobsLimit }}
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND integration_runtime_name = '{{ integration_runtime_name }}' --required
AND node_name = '{{ node_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
capabilities,
concurrentJobsLimit,
expiryTime,
hostServiceUri,
isActiveDispatcher,
lastConnectTime,
lastEndUpdateTime,
lastStartTime,
lastStartUpdateTime,
lastStopTime,
lastUpdateResult,
machineName,
maxConcurrentJobs,
nodeName,
registerTime,
status,
version,
versionStatus;

DELETE examples

delete

Deletes a self-hosted integration runtime node.

DELETE FROM azure.data_factory.integration_runtime_nodes
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND integration_runtime_name = '{{ integration_runtime_name }}' --required
AND node_name = '{{ node_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_ip_address

Get the IP address of self-hosted integration runtime node.

EXEC azure.data_factory.integration_runtime_nodes.get_ip_address 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@node_name='{{ node_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;