Integration Runtimes - Get Status

Gets detailed status information for an integration runtime.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getStatus?api-version=2018-06-01

URI Parameters

Name In Required Type Description
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]+)*$

resourceGroupName
path True
  • string

The resource group name.

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

subscriptionId
path True
  • string

The subscription identifier.

api-version
query True
  • string

The API version.

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

IntegrationRuntimes_GetStatus

Sample Request

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleIntegrationRuntime/getStatus?api-version=2018-06-01

Sample Response

Date: Thu, 14 Jun 2018 14:53:22 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14997
x-ms-request-id: 19efe790-074f-4241-ae94-0422935d0f46
x-ms-correlation-request-id: 19efe790-074f-4241-ae94-0422935d0f46
{
  "name": "exampleIntegrationRuntime",
  "properties": {
    "state": "Online",
    "type": "SelfHosted",
    "typeProperties": {
      "autoUpdate": "Off",
      "taskQueueId": "1a6296ab-423c-4346-9bcc-85a78c2c0582",
      "version": "3.8.6730.2",
      "nodes": [
        {
          "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-14T14:52:59.8933313Z",
          "lastStartTime": "2018-06-14T14:52:59.8933313Z",
          "lastUpdateResult": "None",
          "isActiveDispatcher": true,
          "maxConcurrentJobs": 56
        }
      ],
      "updateDelayOffset": "PT3H",
      "localTimeZoneOffset": "PT8H",
      "serviceUrls": [
        "wu.frontend.int.clouddatahub-int.net",
        "*.servicebus.windows.net"
      ],
      "versionStatus": "UpToDate",
      "capabilities": {
        "serviceBusConnected": "True",
        "httpsPortEnabled": "True",
        "credentialInSync": "True",
        "connectedToResourceManager": "True",
        "nodeEnabled": "True"
      },
      "latestVersion": "3.7.6711.1",
      "createTime": "2018-06-14T09:17:45.1839685Z"
    }
  }
}

Definitions

CloudError

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

IntegrationRuntimeAutoUpdate

The state of integration runtime auto update.

IntegrationRuntimeInternalChannelEncryptionMode

It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist).

IntegrationRuntimeState

The state of integration runtime.

IntegrationRuntimeStatusResponse

Integration runtime status response.

IntegrationRuntimeType

The type of integration runtime.

IntegrationRuntimeUpdateResult

The result of the last integration runtime node update.

LinkedIntegrationRuntime

The linked integration runtime information.

ManagedIntegrationRuntimeError

Error definition for managed integration runtime.

ManagedIntegrationRuntimeNode

Properties of integration runtime node.

ManagedIntegrationRuntimeNodeStatus

The managed integration runtime node status.

ManagedIntegrationRuntimeOperationResult

Properties of managed integration runtime operation result.

ManagedIntegrationRuntimeStatus

Managed integration runtime status.

SelfHostedIntegrationRuntimeNode

Properties of Self-hosted integration runtime node.

SelfHostedIntegrationRuntimeNodeStatus

Status of the integration runtime node.

SelfHostedIntegrationRuntimeStatus

Self-hosted integration runtime status.

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.

IntegrationRuntimeAutoUpdate

The state of integration runtime auto update.

Name Type Description
Off
  • string
On
  • string

IntegrationRuntimeInternalChannelEncryptionMode

It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist).

Name Type Description
NotEncrypted
  • string
NotSet
  • string
SslEncrypted
  • string

IntegrationRuntimeState

The state of integration runtime.

Name Type Description
AccessDenied
  • string
Initial
  • string
Limited
  • string
NeedRegistration
  • string
Offline
  • string
Online
  • string
Started
  • string
Starting
  • string
Stopped
  • string
Stopping
  • string

IntegrationRuntimeStatusResponse

Integration runtime status response.

Name Type Description
name
  • string

The integration runtime name.

properties IntegrationRuntimeStatus:

Integration runtime properties.

IntegrationRuntimeType

The type of integration runtime.

Name Type Description
Managed
  • string
SelfHosted
  • string

IntegrationRuntimeUpdateResult

The result of the last integration runtime node update.

Name Type Description
Fail
  • string
None
  • string
Succeed
  • string

LinkedIntegrationRuntime

The linked integration runtime information.

Name Type Description
createTime
  • string

The creating time of the linked integration runtime.

dataFactoryLocation
  • string

The location of the data factory for which the linked integration runtime belong to.

dataFactoryName
  • string

The name of the data factory for which the linked integration runtime belong to.

name
  • string

The name of the linked integration runtime.

subscriptionId
  • string

The subscription ID for which the linked integration runtime belong to.

ManagedIntegrationRuntimeError

Error definition for managed integration runtime.

Name Type Description
code
  • string

Error code.

message
  • string

Error message.

parameters
  • string[]

Managed integration runtime error parameters.

time
  • string

The time when the error occurred.

ManagedIntegrationRuntimeNode

Properties of integration runtime node.

Name Type Description
errors

The errors that occurred on this integration runtime node.

nodeId
  • string

The managed integration runtime node id.

status

The managed integration runtime node status.

ManagedIntegrationRuntimeNodeStatus

The managed integration runtime node status.

Name Type Description
Available
  • string
Recycling
  • string
Starting
  • string
Unavailable
  • string

ManagedIntegrationRuntimeOperationResult

Properties of managed integration runtime operation result.

Name Type Description
activityId
  • string

The activity id for the operation request.

errorCode
  • string

The error code.

parameters
  • string[]

Managed integration runtime error parameters.

result
  • string

The operation result.

startTime
  • string

The start time of the operation.

type
  • string

The operation type. Could be start or stop.

ManagedIntegrationRuntimeStatus

Managed integration runtime status.

Name Type Description
dataFactoryName
  • string

The data factory name which the integration runtime belong to.

state

The state of integration runtime.

type string:
  • Managed

Type of integration runtime.

typeProperties.createTime
  • string

The time at which the integration runtime was created, in ISO8601 format.

typeProperties.lastOperation

The last operation result that occurred on this integration runtime.

typeProperties.nodes

The list of nodes for managed integration runtime.

typeProperties.otherErrors

The errors that occurred on this integration runtime.

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

SelfHostedIntegrationRuntimeStatus

Self-hosted integration runtime status.

Name Type Description
dataFactoryName
  • string

The data factory name which the integration runtime belong to.

state

The state of integration runtime.

type string:
  • SelfHosted

Type of integration runtime.

typeProperties.autoUpdate

Whether Self-hosted integration runtime auto update has been turned on.

typeProperties.autoUpdateETA
  • string

The estimated time when the self-hosted integration runtime will be updated.

typeProperties.capabilities
  • object

Object with additional information about integration runtime capabilities.

typeProperties.createTime
  • string

The time at which the integration runtime was created, in ISO8601 format.

typeProperties.internalChannelEncryption

It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist).

typeProperties.latestVersion
  • string

The latest version on download center.

typeProperties.links

The list of linked integration runtimes that are created to share with this integration runtime.

typeProperties.localTimeZoneOffset
  • string

The local time zone offset in hours.

typeProperties.nodes

The list of nodes for this integration runtime.

typeProperties.pushedVersion
  • string

The version that the integration runtime is going to update to.

typeProperties.scheduledUpdateDate
  • string

The date at which the integration runtime will be scheduled to update, in ISO8601 format.

typeProperties.serviceUrls
  • string[]

The URLs for the services used in integration runtime backend service.

typeProperties.taskQueueId
  • string

The task queue id of the integration runtime.

typeProperties.updateDelayOffset
  • string

The time in the date scheduled by service to update the integration runtime, e.g., PT03H is 3 hours

typeProperties.version
  • string

Version of the integration runtime.

typeProperties.versionStatus
  • string

Status of the integration runtime version.