Azure Data Factory · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Data Factory Factories API

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

$.info
$.paths['/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/factories'].get
$.paths['/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/configureFactoryRepo'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}'].patch
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getDataPlaneAccess'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getGitHubAccessToken'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{name}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{name}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{name}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{name}'].patch

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 Microsoft Azure Data Factory Factories API
  version: 1.0.0
extends: openapi/microsoft-azure-data-factory-factories-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: 13
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/factories'].get
  update:
    x-apievangelist-phrasing:
      intent: List every data factory in my subscription
      effect: read
      questions:
      - Which data factories exist across my whole Azure subscription?
      - Can I list factories subscription-wide instead of one resource group at a time?
      instructions:
      - text: List all data factories in my subscription.
      - text: Show every Data Factory across the subscription, regardless of resource group.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/configureFactoryRepo'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a factory's git repository configuration
      effect: write
      questions:
      - How do I connect my data factory to a git repo for source control?
      - Can I change which repository and branch a factory is linked to?
      instructions:
      - text: Configure the git repo for factory {factoryId} in location {location} with {repo}.
        slots:
          factoryId: requestBody.factoryResourceId
          location: path.locationId
          repo: requestBody.repoConfiguration
      - text: Link factory resource {factoryId} to repository settings {repo}.
        slots:
          factoryId: requestBody.factoryResourceId
          repo: requestBody.repoConfiguration
      - text: Update factory repo information through location {location}.
        slots:
          location: path.locationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories'].get
  update:
    x-apievangelist-phrasing:
      intent: List data factories in a resource group
      effect: read
      questions:
      - Which data factories live in my current resource group?
      - What factories are deployed in this one resource group?
      instructions:
      - text: List the data factories in this resource group.
      - text: Show me the factories scoped to my resource group only.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data factory
      effect: read
      questions:
      - How do I look up the details of one data factory, like its identity and repo settings?
      - Can I skip re-downloading a factory's details if its ETag hasn't changed?
      instructions:
      - text: Get data factory {factory}.
        slots:
          factory: path.factoryName
      - text: Fetch factory {factory} unless it still matches ETag {etag}.
        slots:
          factory: path.factoryName
          etag: header.if-none-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a data factory
      effect: write
      questions:
      - How do I create a new Azure Data Factory instance through the API?
      - Can I set a managed identity and tags when I create a factory?
      instructions:
      - text: Create data factory {factory} in {location}.
        slots:
          factory: path.factoryName
          location: requestBody.location
      - text: Create or replace factory {factory} in {location} with identity {identity} and tags {tags}.
        slots:
          factory: path.factoryName
          location: requestBody.location
          identity: requestBody.identity
          tags: requestBody.tags
      - text: Overwrite factory {factory} with properties {properties} only if its ETag is {etag}.
        slots:
          factory: path.factoryName
          properties: requestBody.properties
          etag: header.if-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data factory
      effect: destructive
      questions:
      - Can I delete an entire data factory, including everything in it?
      - What is the call to tear down a data factory I no longer use?
      instructions:
      - text: Delete data factory {factory}.
        slots:
          factory: path.factoryName
      - text: Tear down the {factory} factory for good.
        slots:
          factory: path.factoryName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a factory's tags or identity
      effect: write
      questions:
      - Can I change just the tags on a data factory without resending its full definition?
      - How do I patch a factory's managed identity in place?
      instructions:
      - text: Update the tags on factory {factory} to {tags}.
        slots:
          factory: path.factoryName
          tags: requestBody.tags
      - text: Patch the identity of factory {factory} to {identity}.
        slots:
          factory: path.factoryName
          identity: requestBody.identity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getDataPlaneAccess'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a data plane access token for a factory
      effect: read
      questions:
      - How do I get a time-limited data plane access token for my data factory?
      - Can I request data plane access with specific permissions and an expiry time?
      instructions:
      - text: Get data plane access for factory {factory} with permissions {permissions}.
        slots:
          factory: path.factoryName
          permissions: requestBody.permissions
      - text: Request data plane access to {path} on {factory} from {start} until {expire}.
        slots:
          factory: path.factoryName
          path: requestBody.accessResourcePath
          start: requestBody.startTime
          expire: requestBody.expireTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getGitHubAccessToken'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange a GitHub code for an access token
      effect: write
      questions:
      - How do I get a GitHub access token so my data factory can use a GitHub repo?
      - Can I trade a GitHub OAuth access code for a token through the factory?
      instructions:
      - text: Get a GitHub access token for factory {factory} using code {code} at {baseUrl}.
        slots:
          factory: path.factoryName
          code: requestBody.gitHubAccessCode
          baseUrl: requestBody.gitHubAccessTokenBaseUrl
      - text: Exchange GitHub access code {code} with client ID {client} via token URL {baseUrl}.
        slots:
          code: requestBody.gitHubAccessCode
          client: requestBody.gitHubClientId
          baseUrl: requestBody.gitHubAccessTokenBaseUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a factory by resource group and name
      effect: read
      questions:
      - Can I fetch a data factory resource by naming both its resource group and its name?
      - What does the generic resource read return for a factory in a named resource group?
      instructions:
      - text: Get the factories resource {name} in resource group {group} of subscription {sub}.
        slots:
          sub: path.subscriptionId
          name: path.name
          group: path.resourceGroupName
      - text: Read factory resource {name} from resource group {group} using the generic resource call.
        slots:
          name: path.name
          group: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a factory in a named resource group
      effect: write
      questions:
      - Can I create a factory resource by passing its resource group and name explicitly?
      - Which fields go into the generic create-or-update call for a factories resource?
      instructions:
      - text: Create factories resource {name} in group {group}, subscription {sub}, in {location}.
        slots:
          sub: path.subscriptionId
          name: path.name
          group: path.resourceGroupName
          location: requestBody.location
      - text: Put factories resource {name} in group {group} with properties {properties} and tags {tags}.
        slots:
          name: path.name
          group: path.resourceGroupName
          properties: requestBody.properties
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a factory in a named resource group
      effect: destructive
      questions:
      - Can I delete a factory resource by giving its resource group and name?
      - What does the generic delete call remove for a factories resource?
      instructions:
      - text: Delete factories resource {name} in resource group {group} of subscription {sub}.
        slots:
          sub: path.subscriptionId
          name: path.name
          group: path.resourceGroupName
      - text: Remove the {name} factories resource from group {group} via the generic resource call.
        slots:
          name: path.name
          group: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a factory in a named resource group
      effect: write
      questions:
      - Can I patch a factories resource addressed by resource group and name?
      - Is there a generic PATCH for a factory resource in a given resource group?
      instructions:
      - text: Update factories resource {name} in resource group {group} of subscription {sub}.
        slots:
          sub: path.subscriptionId
          name: path.name
          group: path.resourceGroupName
      - text: Patch the {name} factories resource in group {group} using the generic update call.
        slots:
          name: path.name
          group: path.resourceGroupName
      method: generated
      generated: '2026-09-26'