# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DataFactoryManagementClient Integration Runtimes API
  version: 1.0.0
extends: openapi/microsoft-azure-data-factory-integrationruntimes-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 17
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration runtimes in a factory
      effect: read
      questions:
      - Which integration runtimes are set up in my data factory?
      - Can I list every self-hosted, Azure and SSIS runtime a factory has?
      instructions:
      - text: List the integration runtimes in factory {factory}.
        slots:
          factory: path.factoryName
      - text: Show all integration runtimes defined in {factory}.
        slots:
          factory: path.factoryName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration runtime definition
      effect: read
      questions:
      - How do I read the configuration of one integration runtime?
      - Can I fetch a runtime's definition only if it changed since my ETag?
      instructions:
      - text: Get integration runtime {ir} from factory {factory}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
      - text: Fetch the definition of runtime {ir} in {factory} unless it matches ETag {etag}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
          etag: header.if-none-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update an integration runtime
      effect: write
      questions:
      - How do I create a new self-hosted or Azure integration runtime?
      - Can I replace a runtime's full definition with an ETag check?
      instructions:
      - text: Create integration runtime {ir} in factory {factory} with properties {properties}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
          properties: requestBody.properties
      - text: Replace runtime {ir} in {factory} with {properties} only if its ETag is {etag}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
          properties: requestBody.properties
          etag: header.if-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration runtime
      effect: destructive
      questions:
      - Can I delete an integration runtime my pipelines no longer use?
      - What removes an integration runtime from a factory?
      instructions:
      - text: Delete integration runtime {ir} from factory {factory}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
      - text: Remove runtime {ir} from {factory}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change auto-update settings on a runtime
      effect: write
      questions:
      - 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?
      instructions:
      - text: Set auto-update to {autoUpdate} on integration runtime {ir} in factory {factory}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
          autoUpdate: requestBody.autoUpdate
      - text: Delay updates on runtime {ir} by offset {offset}.
        slots:
          ir: path.integrationRuntimeName
          offset: requestBody.updateDelayOffset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo'].post
  update:
    x-apievangelist-phrasing:
      intent: Get connection info for encrypting credentials
      effect: read
      questions:
      - 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?
      instructions:
      - text: Get the connection info for integration runtime {ir} in factory {factory}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
      - text: Fetch the credential-encryption connection details of on-premises runtime {ir}.
        slots:
          ir: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Get detailed status of an integration runtime
      effect: read
      questions:
      - Is my integration runtime online, and what state are its nodes in?
      - Can I see detailed status information for a runtime?
      instructions:
      - text: Get the status of integration runtime {ir} in factory {factory}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
      - text: Check whether runtime {ir} in {factory} is online.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/linkedIntegrationRuntime'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a self-hosted runtime with another factory
      effect: write
      questions:
      - 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?
      instructions:
      - text: Link runtime {ir} in factory {factory} to data factory {target}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
          target: requestBody.dataFactoryName
      - text: Create linked runtime {name} on shared runtime {ir} for factory {target} in {region}.
        slots:
          name: requestBody.name
          ir: path.integrationRuntimeName
          target: requestBody.dataFactoryName
          region: requestBody.dataFactoryLocation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the auth keys for a self-hosted runtime
      effect: read
      questions:
      - 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?
      instructions:
      - text: List the authentication keys for integration runtime {ir} in factory {factory}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
      - text: Give me the registration keys for runtime {ir}.
        slots:
          ir: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData'].post
  update:
    x-apievangelist-phrasing:
      intent: Get monitoring data for a runtime and its nodes
      effect: read
      questions:
      - 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?
      instructions:
      - text: Get monitoring data for integration runtime {ir} in factory {factory}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
      - text: Show per-node monitoring data for runtime {ir}.
        slots:
          ir: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List outbound network dependencies of a runtime
      effect: read
      questions:
      - 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?
      instructions:
      - text: List outbound network dependencies for Azure-SSIS runtime {ir} in factory {factory}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
      - text: Show the endpoints runtime {ir} must reach outbound.
        slots:
          ir: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate an auth key for a runtime
      effect: destructive
      questions:
      - How do I rotate the authentication key of a self-hosted integration runtime?
      - Can I regenerate just one of the two runtime auth keys?
      instructions:
      - text: Regenerate auth key {key} for integration runtime {ir} in factory {factory}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
          key: requestBody.keyName
      - text: Rotate the {key} authentication key on runtime {ir}.
        slots:
          key: requestBody.keyName
          ir: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/removeLinks'].post
  update:
    x-apievangelist-phrasing:
      intent: Unshare a self-hosted runtime from a factory
      effect: destructive
      questions:
      - How do I stop sharing my self-hosted integration runtime with another data factory?
      - Can I remove all linked runtimes a particular factory has on my shared runtime?
      instructions:
      - text: Remove the links from factory {linked} on shared runtime {ir} in factory {factory}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
          linked: requestBody.factoryName
      - text: Unshare runtime {ir} from data factory {linked}.
        slots:
          ir: path.integrationRuntimeName
          linked: requestBody.factoryName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a managed integration runtime
      effect: write
      questions:
      - How do I start an Azure-SSIS or other ManagedReserved integration runtime?
      - Can I power on a stopped managed runtime before my packages run?
      instructions:
      - text: Start integration runtime {ir} in factory {factory}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
      - text: Power on managed runtime {ir}.
        slots:
          ir: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a managed integration runtime
      effect: write
      questions:
      - 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?
      instructions:
      - text: Stop integration runtime {ir} in factory {factory}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
      - text: Shut down managed runtime {ir}.
        slots:
          ir: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync credentials across runtime nodes
      effect: write
      questions:
      - 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?
      instructions:
      - text: Sync credentials across the nodes of integration runtime {ir} in factory {factory}.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
      - text: Force runtime {ir} to overwrite worker node credentials with the current ones.
        slots:
          ir: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/upgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Upgrade a self-hosted runtime to the latest version
      effect: write
      questions:
      - 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?
      instructions:
      - text: Upgrade integration runtime {ir} in factory {factory} to the latest version.
        slots:
          factory: path.factoryName
          ir: path.integrationRuntimeName
      - text: Install the newest available version on self-hosted runtime {ir}.
        slots:
          ir: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'