Azure Data Factory

Azure Data Factory Integration Runtimes API

The integrationRuntimes API from Azure Data Factory — 14 operation(s) for integrationruntimes.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 17

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes List integration runtimes in a factory · Integration runtimes list by factory #
Ask an LLM
“Which integration runtimes are set up in my data factory?”
“Can I list every self-hosted, Azure and SSIS runtime a factory has?”
Tell an agent
List the integration runtimes in factory {factory}.
Show all integration runtimes defined in {factory}.
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName} Get an integration runtime definition · Integration runtimes get #
Ask an LLM
“How do I read the configuration of one integration runtime?”
“Can I fetch a runtime's definition only if it changed since my ETag?”
Tell an agent
Get integration runtime {ir} from factory {factory}.
Fetch the definition of runtime {ir} in {factory} unless it matches ETag {etag}.
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName} Create or update an integration runtime · Integration runtimes create or update #
Ask an LLM
“How do I create a new self-hosted or Azure integration runtime?”
“Can I replace a runtime's full definition with an ETag check?”
Tell an agent
Create integration runtime {ir} in factory {factory} with properties {properties}.
Replace runtime {ir} in {factory} with {properties} only if its ETag is {etag}.
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName} Change auto-update settings on a runtime · Integration runtimes update #
Ask an LLM
“Can I turn auto-update on or off for a self-hosted integration runtime?”
“How do I set the time of day a self-hosted runtime applies updates?”
Tell an agent
Set auto-update to {autoUpdate} on integration runtime {ir} in factory {factory}.
Delay updates on runtime {ir} by offset {offset}.
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName} Delete an integration runtime · Integration runtimes delete #
Ask an LLM
“Can I delete an integration runtime my pipelines no longer use?”
“What removes an integration runtime from a factory?”
Tell an agent destructive · confirm first
Delete integration runtime {ir} from factory {factory}.
Remove runtime {ir} from {factory}.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo Get connection info for encrypting credentials · Integration runtimes get connection info #
Ask an LLM
“How do I get the connection info needed to encrypt on-premises data source credentials?”
“What public key and host details does my self-hosted runtime expose for credential encryption?”
Tell an agent
Get the connection info for integration runtime {ir} in factory {factory}.
Fetch the credential-encryption connection details of on-premises runtime {ir}.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getStatus Get detailed status of an integration runtime · Integration runtimes get status #
Ask an LLM
“Is my integration runtime online, and what state are its nodes in?”
“Can I see detailed status information for a runtime?”
Tell an agent
Get the status of integration runtime {ir} in factory {factory}.
Check whether runtime {ir} in {factory} is online.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/linkedIntegrationRuntime Share a self-hosted runtime with another factory · Integration runtimes create linked integration runtime #
Ask an LLM
“How do I share my self-hosted integration runtime with a different data factory?”
“Can I add a linked runtime entry pointing at another factory and its location?”
Tell an agent
Link runtime {ir} in factory {factory} to data factory {target}.
Create linked runtime {name} on shared runtime {ir} for factory {target} in {region}.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys Get the auth keys for a self-hosted runtime · Integration runtimes list auth keys #
Ask an LLM
“Where do I find the authentication keys to register a self-hosted runtime node?”
“Can I retrieve the current auth keys of an integration runtime?”
Tell an agent
List the authentication keys for integration runtime {ir} in factory {factory}.
Give me the registration keys for runtime {ir}.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData Get monitoring data for a runtime and its nodes · Integration runtimes get monitoring data #
Ask an LLM
“How busy are the nodes of my integration runtime right now?”
“Can I pull CPU, memory and job monitoring data for every node of a runtime?”
Tell an agent
Get monitoring data for integration runtime {ir} in factory {factory}.
Show per-node monitoring data for runtime {ir}.
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints List outbound network dependencies of a runtime · Integration runtimes list outbound network dependencies endpoints #
Ask an LLM
“Which outbound endpoints does my Azure-SSIS integration runtime need to reach?”
“What should I allow in my firewall for an Azure-SSIS runtime in a virtual network?”
Tell an agent
List outbound network dependencies for Azure-SSIS runtime {ir} in factory {factory}.
Show the endpoints runtime {ir} must reach outbound.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey Regenerate an auth key for a runtime · Integration runtimes regenerate auth key #
Ask an LLM
“How do I rotate the authentication key of a self-hosted integration runtime?”
“Can I regenerate just one of the two runtime auth keys?”
Tell an agent destructive · confirm first
Regenerate auth key {key} for integration runtime {ir} in factory {factory}.
Rotate the {key} authentication key on runtime {ir}.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/start Start a managed integration runtime · Integration runtimes start #
Ask an LLM
“How do I start an Azure-SSIS or other ManagedReserved integration runtime?”
“Can I power on a stopped managed runtime before my packages run?”
Tell an agent
Start integration runtime {ir} in factory {factory}.
Power on managed runtime {ir}.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/stop Stop a managed integration runtime · Integration runtimes stop #
Ask an LLM
“How do I stop a ManagedReserved integration runtime to stop paying for it?”
“Can I shut down an Azure-SSIS runtime when no packages are running?”
Tell an agent
Stop integration runtime {ir} in factory {factory}.
Shut down managed runtime {ir}.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials Sync credentials across runtime nodes · Integration runtimes sync credentials #
Ask an LLM
“How do I force every node of a self-hosted runtime to share the same credentials?”
“Can I push the dispatcher node's credentials to all worker nodes?”
Tell an agent
Sync credentials across the nodes of integration runtime {ir} in factory {factory}.
Force runtime {ir} to overwrite worker node credentials with the current ones.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/upgrade Upgrade a self-hosted runtime to the latest version · Integration runtimes upgrade #
Ask an LLM
“How do I upgrade my self-hosted integration runtime to the newest version?”
“Can I trigger a self-hosted runtime upgrade when one is available?”
Tell an agent
Upgrade integration runtime {ir} in factory {factory} to the latest version.
Install the newest available version on self-hosted runtime {ir}.

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/azure/data-factory/
📖
APIReference
https://learn.microsoft.com/en-us/rest/api/datafactory/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/microsoft-azure-data-factory/openapi/microsoft-azure-data-factory-integrationruntimes-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-data-factory/json-schema/microsoft-azure-data-factory-integration-runtime-connection-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-data-factory/json-schema/microsoft-azure-data-factory-integration-runtime-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-data-factory/json-schema/microsoft-azure-data-factory-create-linked-integration-runtime-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-data-factory/json-schema/microsoft-azure-data-factory-update-integration-runtime-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-data-factory/json-schema/microsoft-azure-data-factory-integration-runtime-list-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-data-factory/json-schema/microsoft-azure-data-factory-integration-runtime-outbound-network-dependencies-endpoints-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/microsoft-azure-data-factory:microsoft-azure-data-factory-integrationruntimes-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-data-factory-integrationruntimes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: DataFactoryManagementClient Integration Runtimes API
  version: '2018-06-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:


# --- truncated at 32 KB (48 KB total) ---
# Full source: https://artifacts.apis.io/microsoft-azure-data-factory/openapi/microsoft-azure-data-factory-integrationruntimes-api-openapi.yml