Integration Runtime Nodes - Update
Updates a self-hosted integration runtime node.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}?api-version=2018-06-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
factory
|
path | True |
string |
The factory name. Regex pattern: |
integration
|
path | True |
string |
The integration runtime name. Regex pattern: |
node
|
path | True |
string |
The integration runtime node name. Regex pattern: |
resource
|
path | True |
string |
The resource group name. Regex pattern: |
subscription
|
path | True |
string |
The subscription identifier. |
api-version
|
query | True |
string |
The API version. |
Request Body
Name | Type | Description |
---|---|---|
concurrentJobsLimit |
integer |
The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive) are allowed. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
An error response received from the Azure Data Factory service. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
IntegrationRuntimeNodes_Update
Sample Request
PATCH https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleIntegrationRuntime/nodes/Node_1?api-version=2018-06-01
{
"concurrentJobsLimit": 2
}
Sample Response
Date: Thu, 14 Jun 2018 15:01:00 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1199
x-ms-request-id: cf0d05fa-afbe-4fac-aa10-227885658c83
x-ms-correlation-request-id: cf0d05fa-afbe-4fac-aa10-227885658c83
{
"nodeName": "Node_1",
"machineName": "YANZHANG-DT",
"hostServiceUri": "https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/",
"status": "Online",
"capabilities": {
"serviceBusConnected": "True",
"httpsPortEnabled": "True",
"credentialInSync": "True",
"connectedToResourceManager": "True",
"nodeEnabled": "True"
},
"versionStatus": "UpToDate",
"version": "3.8.6730.2",
"registerTime": "2018-06-14T14:51:44.9237069Z",
"lastConnectTime": "2018-06-14T15:00:35.7544322Z",
"lastStartTime": "2018-06-14T14:52:59.8933313Z",
"lastUpdateResult": "None",
"isActiveDispatcher": true,
"concurrentJobsLimit": 2,
"maxConcurrentJobs": 56
}
Definitions
Name | Description |
---|---|
Cloud |
The object that defines the structure of an Azure Data Factory error response. |
Integration |
The result of the last integration runtime node update. |
Self |
Properties of Self-hosted integration runtime node. |
Self |
Status of the integration runtime node. |
Update |
Update integration runtime node request. |
CloudError
The object that defines the structure of an Azure Data Factory error response.
Name | Type | Description |
---|---|---|
error.code |
string |
Error code. |
error.details |
Array with additional error details. |
|
error.message |
string |
Error message. |
error.target |
string |
Property name/path in request associated with error. |
IntegrationRuntimeUpdateResult
The result of the last integration runtime node update.
Name | Type | Description |
---|---|---|
Fail |
string |
|
None |
string |
|
Succeed |
string |
SelfHostedIntegrationRuntimeNode
Properties of Self-hosted integration runtime node.
Name | Type | Description |
---|---|---|
capabilities |
object |
The integration runtime capabilities dictionary |
concurrentJobsLimit |
integer |
Maximum concurrent jobs on the integration runtime node. |
expiryTime |
string |
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 |
The most recent time at which the integration runtime was connected in ISO8601 format. |
lastEndUpdateTime |
string |
The last time for the integration runtime node update end. |
lastStartTime |
string |
The time the node last started up. |
lastStartUpdateTime |
string |
The last time for the integration runtime node update start. |
lastStopTime |
string |
The integration runtime node last stop time. |
lastUpdateResult |
The result of the last integration runtime node update. |
|
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 |
The time at which the integration runtime node was registered in ISO8601 format. |
status |
Status of the integration runtime node. |
|
version |
string |
Version of the integration runtime node. |
versionStatus |
string |
Status of the integration runtime node version. |
SelfHostedIntegrationRuntimeNodeStatus
Status of the integration runtime node.
Name | Type | Description |
---|---|---|
InitializeFailed |
string |
|
Initializing |
string |
|
Limited |
string |
|
NeedRegistration |
string |
|
Offline |
string |
|
Online |
string |
|
Upgrading |
string |
UpdateIntegrationRuntimeNodeRequest
Update integration runtime node request.
Name | Type | Description |
---|---|---|
concurrentJobsLimit |
integer |
The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive) are allowed. |