Azure Data Factory · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DataFactoryManagementClient Credentials API

5 actions 5 updates phrasing extends openapi/microsoft-azure-data-factory-credentials-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}/credentials'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}'].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 Credentials API
  version: 1.0.0
extends: openapi/microsoft-azure-data-factory-credentials-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}/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List credentials in a factory
      effect: read
      questions:
      - Which credentials are stored in my Azure Data Factory?
      - Can I see all credential entries defined in a factory?
      instructions:
      - text: List the credentials in factory {factory}.
        slots:
          factory: path.factoryName
      - text: Show every credential configured in {factory}.
        slots:
          factory: path.factoryName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a credential
      effect: read
      questions:
      - How do I read the definition of one credential in a data factory?
      - Can I fetch a credential only when it changed since the ETag I have?
      instructions:
      - text: Get credential {credential} from factory {factory}.
        slots:
          factory: path.factoryName
          credential: path.credentialName
      - text: Fetch credential {credential} in {factory} unless it matches ETag {etag}.
        slots:
          factory: path.factoryName
          credential: path.credentialName
          etag: header.if-none-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a credential
      effect: write
      questions:
      - How do I add a new credential, like a managed identity, to a data factory?
      - Can I change an existing credential's properties with an ETag check?
      instructions:
      - text: Create credential {credential} in factory {factory} with properties {properties}.
        slots:
          factory: path.factoryName
          credential: path.credentialName
          properties: requestBody.properties
      - text: Update credential {credential} in {factory} to {properties} if its ETag is {etag}.
        slots:
          factory: path.factoryName
          credential: path.credentialName
          properties: requestBody.properties
          etag: header.if-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a credential
      effect: destructive
      questions:
      - Can I remove a credential that my factory no longer uses?
      - What is the call to delete a stored credential from a data factory?
      instructions:
      - text: Delete credential {credential} from factory {factory}.
        slots:
          factory: path.factoryName
          credential: path.credentialName
      - text: Remove the {credential} credential in {factory}.
        slots:
          factory: path.factoryName
          credential: path.credentialName
      method: generated
      generated: '2026-09-26'