Azure Data Factory · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DataFactoryManagementClient Private End Point Connections API

5 actions 5 updates phrasing extends openapi/microsoft-azure-data-factory-privateendpointconnections-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}/privateEndpointConnections'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}'].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 Private End Point Connections API
  version: 1.0.0
extends: openapi/microsoft-azure-data-factory-privateendpointconnections-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}/privateEndpointConnections'].get
  update:
    x-apievangelist-phrasing:
      intent: List private endpoint connections to a factory
      effect: read
      questions:
      - Which private endpoint connections have been requested to my data factory?
      - Can I see all private endpoint connections and their approval state?
      instructions:
      - text: List the private endpoint connections for factory {factory}.
        slots:
          factory: path.factoryName
      - text: Show every private endpoint connection to {factory}.
        slots:
          factory: path.factoryName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a private endpoint connection
      effect: read
      questions:
      - How do I check the status of one private endpoint connection to my factory?
      - Can I fetch a private endpoint connection only if its ETag changed?
      instructions:
      - text: Get private endpoint connection {connection} for factory {factory}.
        slots:
          factory: path.factoryName
          connection: path.privateEndpointConnectionName
      - text: Fetch connection {connection} on {factory} unless it matches ETag {etag}.
        slots:
          factory: path.factoryName
          connection: path.privateEndpointConnectionName
          etag: header.if-none-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve or reject a private endpoint connection
      effect: write
      questions:
      - How do I approve a pending private endpoint connection to my data factory?
      - Can I reject a private endpoint connection someone requested?
      instructions:
      - text: Approve private endpoint connection {connection} on factory {factory} with {properties}.
        slots:
          factory: path.factoryName
          connection: path.privateEndpointConnectionName
          properties: requestBody.properties
      - text: Set the state of connection {connection} on {factory} to {properties}.
        slots:
          factory: path.factoryName
          connection: path.privateEndpointConnectionName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a private endpoint connection
      effect: destructive
      questions:
      - Can I delete a private endpoint connection to my factory?
      - What removes a private endpoint connection entirely?
      instructions:
      - text: Delete private endpoint connection {connection} from factory {factory}.
        slots:
          factory: path.factoryName
          connection: path.privateEndpointConnectionName
      - text: Remove connection {connection} from {factory}.
        slots:
          factory: path.factoryName
          connection: path.privateEndpointConnectionName
      method: generated
      generated: '2026-09-26'