Azure Data Factory · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DataFactoryManagementClient Change Data Capture API

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

$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/start'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/status'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/stop'].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 Change Data Capture API
  version: 1.0.0
extends: openapi/microsoft-azure-data-factory-changedatacapture-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: 7
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs'].get
  update:
    x-apievangelist-phrasing:
      intent: List change data capture resources in a factory
      effect: read
      questions:
      - Which change data capture resources are set up in my data factory?
      - Can I see every CDC resource a factory has configured?
      instructions:
      - text: List all change data capture resources in factory {factory}.
        slots:
          factory: path.factoryName
      - text: Show me the CDC resources defined in {factory}.
        slots:
          factory: path.factoryName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a change data capture resource
      effect: read
      questions:
      - How do I look up the definition of one change data capture resource?
      - Can I fetch a CDC resource's configuration only if it changed since my last ETag?
      instructions:
      - text: Get change data capture {cdc} from factory {factory}.
        slots:
          factory: path.factoryName
          cdc: path.changeDataCaptureName
      - text: Fetch CDC resource {cdc} in {factory} unless it still matches ETag {etag}.
        slots:
          factory: path.factoryName
          cdc: path.changeDataCaptureName
          etag: header.if-none-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a change data capture resource
      effect: write
      questions:
      - How do I define a new change data capture resource in a data factory?
      - Can I change an existing CDC resource's settings without clobbering someone else's edit?
      instructions:
      - text: Create change data capture {cdc} in factory {factory} with properties {properties}.
        slots:
          factory: path.factoryName
          cdc: path.changeDataCaptureName
          properties: requestBody.properties
      - text: Update CDC {cdc} in {factory} to {properties}, only if its ETag is still {etag}.
        slots:
          factory: path.factoryName
          cdc: path.changeDataCaptureName
          properties: requestBody.properties
          etag: header.if-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a change data capture resource
      effect: destructive
      questions:
      - Can I permanently remove a change data capture resource from a factory?
      - What happens to a CDC resource when I delete it?
      instructions:
      - text: Delete change data capture {cdc} from factory {factory}.
        slots:
          factory: path.factoryName
          cdc: path.changeDataCaptureName
      - text: Remove the CDC resource {cdc} in {factory}.
        slots:
          factory: path.factoryName
          cdc: path.changeDataCaptureName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a change data capture resource
      effect: write
      questions:
      - How do I start capturing changes with a CDC resource I already defined?
      - Can I kick off a stopped change data capture so it resumes processing?
      instructions:
      - text: Start change data capture {cdc} in factory {factory}.
        slots:
          factory: path.factoryName
          cdc: path.changeDataCaptureName
      - text: Turn on CDC {cdc} in {factory} so it begins capturing changes.
        slots:
          factory: path.factoryName
          cdc: path.changeDataCaptureName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a change data capture is running
      effect: read
      questions:
      - Is my change data capture resource currently running or stopped?
      - What is the current status of a CDC resource in my factory?
      instructions:
      - text: Check the status of change data capture {cdc} in factory {factory}.
        slots:
          factory: path.factoryName
          cdc: path.changeDataCaptureName
      - text: Tell me whether CDC {cdc} in {factory} is running right now.
        slots:
          factory: path.factoryName
          cdc: path.changeDataCaptureName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a change data capture resource
      effect: write
      questions:
      - How do I pause a change data capture resource that is currently running?
      - Can I stop a CDC resource from processing changes without deleting it?
      instructions:
      - text: Stop change data capture {cdc} in factory {factory}.
        slots:
          factory: path.factoryName
          cdc: path.changeDataCaptureName
      - text: Halt CDC {cdc} in {factory} but keep its definition.
        slots:
          factory: path.factoryName
          cdc: path.changeDataCaptureName
      method: generated
      generated: '2026-09-26'