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=2017-09-01-preview

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription identifier.

resourceGroupName
path True
  • string

The resource group name.

Regex pattern: ^[-\w\._\(\)]+$

factoryName
path True
  • string

The factory name.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

integrationRuntimeName
path True
  • string

The integration runtime name.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

nodeName
path True
  • string

The integration runtime node name.

Regex pattern: ^[a-z0-9A-Z][a-z0-9A-Z_-]{0,149}$

api-version
query True
  • string

The API version.

Request Body

default

Name Required 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.

Examples

IntegrationRuntimeNodes_Update

Sample Request

PATCH https://management.azure.com/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleIntegrationRuntime/nodes/Node_1?api-version=2017-09-01-preview
{
  "concurrentJobsLimit": 2
}

Sample Response

Date: Tue, 28 Nov 2017 06:51:38 GMT
x-ms-request-id: eee2dbec-ee3b-4c5c-a040-d39c88f0f82b
X-Content-Type-Options: nosniff
{
  "body": {
    "nodeName": "Node_1",
    "machineName": "YANZHANG-02",
    "hostServiceUri": "https://yanzhang-02.redmond.corp.microsoft.com:8050/HostServiceRemote.svc/",
    "status": "Online",
    "capabilities": {
      "serviceBusConnected": "True",
      "httpsPortEnabled": "True",
      "credentialInSync": "True",
      "connectedToResourceManager": "True",
      "nodeEnabled": "True"
    },
    "versionStatus": "UpToDate",
    "version": "3.2.6519.3",
    "registerTime": "2017-11-28T06:50:38.0809958Z",
    "lastConnectTime": "2017-11-28T06:51:20.7868013Z",
    "lastStartTime": "2017-11-28T06:51:20.7868013Z",
    "lastUpdateResult": "None",
    "isActiveDispatcher": true,
    "concurrentJobsLimit": 2,
    "maxConcurrentJobs": 48
  },
  "request": {
    "version": {
      "major": 1,
      "minor": 1,
      "build": -1,
      "revision": -1,
      "majorRevision": -1,
      "minorRevision": -1
    },
    "content": {
      "headers": [
        {
          "key": "Content-Type",
          "value": [
            "application/json; charset=utf-8"
          ]
        },
        {
          "key": "Content-Length",
          "value": [
            "32"
          ]
        }
      ]
    },
    "method": {
      "method": "PATCH"
    },
    "requestUri": "https://wu.frontend.int.clouddatahub-int.net/subscriptions/12345678-1234-1234-12345678abc/datafactories/exampleFactoryName/IntegrationRuntimes/exampleIntegrationRuntime/nodes/Node_1?api-version=1.0",
    "headers": [
      {
        "key": "x-ms-client-request-id",
        "value": [
          "eee2dbec-ee3b-4c5c-a040-d39c88f0f82b"
        ]
      },
      {
        "key": "accept-language",
        "value": [
          "en-US"
        ]
      },
      {
        "key": "User-Agent",
        "value": [
          "Microsoft.DataTransfer.IntegrationRuntimeService.Client.IntegrationRuntimeServiceClient/0.9.0.0"
        ]
      }
    ],
    "properties": {}
  },
  "response": {
    "version": {
      "major": 1,
      "minor": 1,
      "build": -1,
      "revision": -1,
      "majorRevision": -1,
      "minorRevision": -1
    },
    "content": {
      "headers": [
        {
          "key": "Content-Length",
          "value": [
            "607"
          ]
        },
        {
          "key": "Content-Type",
          "value": [
            "application/json; charset=utf-8"
          ]
        },
        {
          "key": "Expires",
          "value": [
            "-1"
          ]
        }
      ]
    },
    "statusCode": 200,
    "reasonPhrase": "OK",
    "headers": [
      {
        "key": "Pragma",
        "value": [
          "no-cache"
        ]
      },
      {
        "key": "X-Content-Type-Options",
        "value": [
          "nosniff"
        ]
      },
      {
        "key": "Cache-Control",
        "value": [
          "no-cache"
        ]
      },
      {
        "key": "Date",
        "value": [
          "Tue, 28 Nov 2017 06:51:37 GMT"
        ]
      },
      {
        "key": "Server",
        "value": [
          "Microsoft-IIS/8.5"
        ]
      },
      {
        "key": "X-AspNet-Version",
        "value": [
          "4.0.30319"
        ]
      }
    ],
    "requestMessage": {
      "version": {
        "major": 1,
        "minor": 1,
        "build": -1,
        "revision": -1,
        "majorRevision": -1,
        "minorRevision": -1
      },
      "content": {
        "headers": [
          {
            "key": "Content-Type",
            "value": [
              "application/json; charset=utf-8"
            ]
          },
          {
            "key": "Content-Length",
            "value": [
              "32"
            ]
          }
        ]
      },
      "method": {
        "method": "PATCH"
      },
      "requestUri": "https://wu.frontend.int.clouddatahub-int.net/subscriptions/12345678-1234-1234-12345678abc/datafactories/exampleFactoryName/IntegrationRuntimes/exampleIntegrationRuntime/nodes/Node_1?api-version=1.0",
      "headers": [
        {
          "key": "x-ms-client-request-id",
          "value": [
            "eee2dbec-ee3b-4c5c-a040-d39c88f0f82b"
          ]
        },
        {
          "key": "accept-language",
          "value": [
            "en-US"
          ]
        },
        {
          "key": "User-Agent",
          "value": [
            "Microsoft.DataTransfer.IntegrationRuntimeService.Client.IntegrationRuntimeServiceClient/0.9.0.0"
          ]
        }
      ],
      "properties": {}
    },
    "isSuccessStatusCode": true
  }
}

Definitions

ErrorResponse

The object that defines the structure of an Azure Data Factory response.

IntegrationRuntimeUpdateResult

The result of the last integration runtime node update.

SelfHostedIntegrationRuntimeNode

Properties of Self-hosted integration runtime node.

SelfHostedIntegrationRuntimeNodeStatus

Status of the integration runtime node.

UpdateIntegrationRuntimeNodeRequest

Update integration runtime node request.

ErrorResponse

The object that defines the structure of an Azure Data Factory response.

Name Type Description
code
  • string

Error code.

details

Array with additional error details.

message
  • string

Error message.

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
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.