Azure Data Factory · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DataFactoryManagementClient Pipelines API

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

$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}/createRun'].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 Pipelines API
  version: 1.0.0
extends: openapi/microsoft-azure-data-factory-pipelines-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: 5
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines'].get
  update:
    x-apievangelist-phrasing:
      intent: List pipelines in a factory
      effect: read
      questions:
      - Which pipelines are defined in my data factory?
      - Can I get every pipeline in a factory in one call?
      instructions:
      - text: List the pipelines in factory {factory}.
        slots:
          factory: path.factoryName
      - text: Show all pipelines defined in {factory}.
        slots:
          factory: path.factoryName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline definition
      effect: read
      questions:
      - How do I read the activities and parameters of one pipeline?
      - Can I fetch a pipeline only if it changed since my ETag?
      instructions:
      - text: Get pipeline {pipeline} from factory {factory}.
        slots:
          factory: path.factoryName
          pipeline: path.pipelineName
      - text: Fetch pipeline {pipeline} in {factory} unless it matches ETag {etag}.
        slots:
          factory: path.factoryName
          pipeline: path.pipelineName
          etag: header.if-none-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a pipeline
      effect: write
      questions:
      - How do I create a new pipeline in a data factory through the API?
      - Can I overwrite a pipeline's definition only if no one else has edited it?
      instructions:
      - text: Create pipeline {pipeline} in factory {factory} with properties {properties}.
        slots:
          factory: path.factoryName
          pipeline: path.pipelineName
          properties: requestBody.properties
      - text: Update pipeline {pipeline} in {factory} to {properties} if its ETag is {etag}.
        slots:
          factory: path.factoryName
          pipeline: path.pipelineName
          properties: requestBody.properties
          etag: header.if-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pipeline
      effect: destructive
      questions:
      - Can I delete a pipeline from my data factory?
      - What removes a pipeline definition I no longer use?
      instructions:
      - text: Delete pipeline {pipeline} from factory {factory}.
        slots:
          factory: path.factoryName
          pipeline: path.pipelineName
      - text: Remove the {pipeline} pipeline in {factory}.
        slots:
          factory: path.factoryName
          pipeline: path.pipelineName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}/createRun'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a pipeline
      effect: write
      questions:
      - How do I trigger a pipeline run on demand?
      - Can I rerun a failed pipeline starting from the activity that failed?
      - Is it possible to start a run from a specific activity instead of the beginning?
      instructions:
      - text: Run pipeline {pipeline} in factory {factory}.
        slots:
          factory: path.factoryName
          pipeline: path.pipelineName
      - text: Rerun pipeline {pipeline} from failure, based on earlier run {ref}.
        slots:
          pipeline: path.pipelineName
          ref: query.referencePipelineRunId
      - text: Start a run of {pipeline} in {factory} beginning at activity {activity}.
        slots:
          factory: path.factoryName
          pipeline: path.pipelineName
          activity: query.startActivityName
      method: generated
      generated: '2026-09-26'