Azure Data Factory · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DataFactoryManagementClient Datasets API

5 actions 5 updates phrasing extends openapi/microsoft-azure-data-factory-datasets-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}/datasets'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}'].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 Datasets API
  version: 1.0.0
extends: openapi/microsoft-azure-data-factory-datasets-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}/datasets'].get
  update:
    x-apievangelist-phrasing:
      intent: List datasets in a factory
      effect: read
      questions:
      - Which datasets are defined in my data factory?
      - Can I get every dataset a factory's pipelines can use?
      instructions:
      - text: List the datasets in factory {factory}.
        slots:
          factory: path.factoryName
      - text: Show all datasets defined in {factory}.
        slots:
          factory: path.factoryName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dataset
      effect: read
      questions:
      - How do I read the definition of one dataset?
      - Can I fetch a dataset only when it changed since my ETag?
      instructions:
      - text: Get dataset {dataset} from factory {factory}.
        slots:
          factory: path.factoryName
          dataset: path.datasetName
      - text: Fetch dataset {dataset} in {factory} unless it matches ETag {etag}.
        slots:
          factory: path.factoryName
          dataset: path.datasetName
          etag: header.if-none-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a dataset
      effect: write
      questions:
      - How do I define a new dataset pointing at my source or sink data?
      - Can I change a dataset's definition with an ETag concurrency check?
      instructions:
      - text: Create dataset {dataset} in factory {factory} with properties {properties}.
        slots:
          factory: path.factoryName
          dataset: path.datasetName
          properties: requestBody.properties
      - text: Update dataset {dataset} in {factory} to {properties} if its ETag is {etag}.
        slots:
          factory: path.factoryName
          dataset: path.datasetName
          properties: requestBody.properties
          etag: header.if-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dataset
      effect: destructive
      questions:
      - Can I delete a dataset from a data factory?
      - What removes a dataset definition I no longer use?
      instructions:
      - text: Delete dataset {dataset} from factory {factory}.
        slots:
          factory: path.factoryName
          dataset: path.datasetName
      - text: Remove the {dataset} dataset in {factory}.
        slots:
          factory: path.factoryName
          dataset: path.datasetName
      method: generated
      generated: '2026-09-26'