Azure Data Factory · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DataFactoryManagementClient Data Flows API

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

$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}'].delete

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 Data Flows API
  version: 1.0.0
extends: openapi/microsoft-azure-data-factory-dataflows-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: 4
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List data flows in a factory
      effect: read
      questions:
      - Which data flows exist in my data factory?
      - Can I get every mapping data flow defined in a factory?
      instructions:
      - text: List the data flows in factory {factory}.
        slots:
          factory: path.factoryName
      - text: Show all data flows defined in {factory}.
        slots:
          factory: path.factoryName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data flow
      effect: read
      questions:
      - How do I read the definition of a single data flow?
      - Can I fetch a data flow only if it changed since my cached ETag?
      instructions:
      - text: Get data flow {dataflow} from factory {factory}.
        slots:
          factory: path.factoryName
          dataflow: path.dataFlowName
      - text: Fetch data flow {dataflow} in {factory} unless it matches ETag {etag}.
        slots:
          factory: path.factoryName
          dataflow: path.dataFlowName
          etag: header.if-none-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a data flow
      effect: write
      questions:
      - How do I create a new data flow in a factory through the API?
      - Can I overwrite a data flow's definition only if nobody else changed it?
      instructions:
      - text: Create data flow {dataflow} in factory {factory} with properties {properties}.
        slots:
          factory: path.factoryName
          dataflow: path.dataFlowName
          properties: requestBody.properties
      - text: Update data flow {dataflow} in {factory} to {properties} if its ETag is {etag}.
        slots:
          factory: path.factoryName
          dataflow: path.dataFlowName
          properties: requestBody.properties
          etag: header.if-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data flow
      effect: destructive
      questions:
      - Can I delete a data flow I no longer need?
      - What removes a data flow definition from a factory?
      instructions:
      - text: Delete data flow {dataflow} from factory {factory}.
        slots:
          factory: path.factoryName
          dataflow: path.dataFlowName
      - text: Remove the {dataflow} data flow in {factory}.
        slots:
          factory: path.factoryName
          dataflow: path.dataFlowName
      method: generated
      generated: '2026-09-26'