Azure Data Factory · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DataFactoryManagementClient Activityruns API

2 actions 2 updates phrasing extends openapi/microsoft-azure-data-factory-activityruns-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Azure Data Factory's API. It is a proposal applied on top of the contract, not a document Azure Data Factory publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DataFactoryManagementClient Activityruns API
  version: 1.0.0
extends: openapi/microsoft-azure-data-factory-activityruns-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: 1
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns'].post
  update:
    x-apievangelist-phrasing:
      intent: Query activity runs within a pipeline run
      effect: read
      questions:
      - Which activities ran inside a particular Data Factory pipeline run, and did any fail?
      - Can I filter the activity runs of one pipeline run to a time window of last updates?
      - What does each step of my pipeline run report when I look at its activity runs?
      instructions:
      - text: Show the activity runs for pipeline run {run} in factory {factory} updated between {after} and {before}.
        slots:
          factory: path.factoryName
          run: path.runId
          after: requestBody.lastUpdatedAfter
          before: requestBody.lastUpdatedBefore
      - text: List the failed activities inside run {run} of factory {factory}, filtered by {filters}.
        slots:
          factory: path.factoryName
          run: path.runId
          filters: requestBody.filters
      - text: Fetch the next page of activity runs for run {run} using continuation token {token}.
        slots:
          run: path.runId
          token: requestBody.continuationToken
      method: generated
      generated: '2026-09-26'