Azure Data Factory · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DataFactoryManagementClient Pipelineruns API

4 actions 4 updates phrasing extends openapi/microsoft-azure-data-factory-pipelineruns-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 4

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

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DataFactoryManagementClient Pipelineruns API
  version: 1.0.0
extends: openapi/microsoft-azure-data-factory-pipelineruns-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: 3
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline run by its run ID
      effect: read
      questions:
      - How do I check whether a specific pipeline run succeeded or failed?
      - What status and duration did a particular pipeline run report?
      instructions:
      - text: Get pipeline run {run} in factory {factory}.
        slots:
          factory: path.factoryName
          run: path.runId
      - text: Check the status of run {run} in {factory}.
        slots:
          factory: path.factoryName
          run: path.runId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pipeline run
      effect: destructive
      questions:
      - How do I cancel a pipeline run that is stuck or taking too long?
      - Can I also cancel the child pipelines a run started?
      instructions:
      - text: Cancel pipeline run {run} in factory {factory}.
        slots:
          factory: path.factoryName
          run: path.runId
      - text: Cancel run {run} in {factory} with recursive set to {recursive}.
        slots:
          factory: path.factoryName
          run: path.runId
          recursive: query.isRecursive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns'].post
  update:
    x-apievangelist-phrasing:
      intent: Search pipeline runs in a factory
      effect: read
      questions:
      - Which pipeline runs happened in my factory during a given time window?
      - Can I filter pipeline runs by status or pipeline name and sort them?
      - What pipelines failed in my data factory yesterday?
      instructions:
      - text: Query pipeline runs in factory {factory} updated between {after} and {before}.
        slots:
          factory: path.factoryName
          after: requestBody.lastUpdatedAfter
          before: requestBody.lastUpdatedBefore
      - text: Find pipeline runs in {factory} matching {filters} ordered by {order}.
        slots:
          factory: path.factoryName
          filters: requestBody.filters
          order: requestBody.orderBy
      - text: Get the next page of pipeline runs in {factory} using token {token}.
        slots:
          factory: path.factoryName
          token: requestBody.continuationToken
      method: generated
      generated: '2026-09-26'