Azure Data Factory · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DataFactoryManagementClient Data Flow Debug Session API

6 actions 6 updates phrasing extends openapi/microsoft-azure-data-factory-dataflowdebugsession-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}/addDataFlowToDebugSession'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/createDataFlowDebugSession'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/deleteDataFlowDebugSession'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/executeDataFlowDebugCommand'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryDataFlowDebugSessions'].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 Data Flow Debug Session API
  version: 1.0.0
extends: openapi/microsoft-azure-data-factory-dataflowdebugsession-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}/addDataFlowToDebugSession'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a data flow to a debug session
      effect: write
      questions:
      - How do I load a data flow into a running debug session so I can test it?
      - Can I attach datasets and linked services along with the data flow I'm debugging?
      instructions:
      - text: Add data flow {dataflow} to debug session {session} in factory {factory}.
        slots:
          factory: path.factoryName
          dataflow: requestBody.dataFlow
          session: requestBody.sessionId
      - text: Load {dataflow} into debug session {session} with datasets {datasets} and linked services {linked}.
        slots:
          dataflow: requestBody.dataFlow
          session: requestBody.sessionId
          datasets: requestBody.datasets
          linked: requestBody.linkedServices
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/createDataFlowDebugSession'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a data flow debug session
      effect: write
      questions:
      - How do I spin up a debug cluster to test data flows interactively?
      - Can I choose the compute type and core count for a data flow debug session?
      - What sets how long an idle data flow debug session stays alive?
      instructions:
      - text: Create a data flow debug session in factory {factory}.
        slots:
          factory: path.factoryName
      - text: Start a {compute} debug session with {cores} cores and a {ttl} minute time to live in {factory}.
        slots:
          factory: path.factoryName
          compute: requestBody.computeType
          cores: requestBody.coreCount
          ttl: requestBody.timeToLive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/deleteDataFlowDebugSession'].post
  update:
    x-apievangelist-phrasing:
      intent: End a data flow debug session
      effect: destructive
      questions:
      - How do I shut down a data flow debug session when I'm done testing?
      - Can I tear down a debug session so it stops using compute?
      instructions:
      - text: Delete debug session {session} in factory {factory}.
        slots:
          factory: path.factoryName
          session: requestBody.sessionId
      - text: End data flow debug session {session} in {factory}.
        slots:
          factory: path.factoryName
          session: requestBody.sessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/executeDataFlowDebugCommand'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a command in a data flow debug session
      effect: write
      questions:
      - Can I preview data or run a debug command against a data flow in a live session?
      - What commands can I send to a data flow debug session?
      instructions:
      - text: Run debug command {command} in session {session} of factory {factory}.
        slots:
          factory: path.factoryName
          command: requestBody.command
          session: requestBody.sessionId
      - text: Execute {command} with payload {payload} in debug session {session}.
        slots:
          command: requestBody.command
          payload: requestBody.commandPayload
          session: requestBody.sessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryDataFlowDebugSessions'].post
  update:
    x-apievangelist-phrasing:
      intent: List active data flow debug sessions
      effect: read
      questions:
      - Which data flow debug sessions are active in my factory right now?
      - Is anyone still running a data flow debug session I should know about?
      instructions:
      - text: List the active data flow debug sessions in factory {factory}.
        slots:
          factory: path.factoryName
      - text: Show me who has debug sessions open in {factory}.
        slots:
          factory: path.factoryName
      method: generated
      generated: '2026-09-26'