Azure Data Factory · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DataFactoryManagementClient Managed Private Endpoints API

5 actions 5 updates phrasing extends openapi/microsoft-azure-data-factory-managedprivateendpoints-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}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DataFactoryManagementClient Managed Private Endpoints API
  version: 1.0.0
extends: openapi/microsoft-azure-data-factory-managedprivateendpoints-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}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List managed private endpoints in a virtual network
      effect: read
      questions:
      - Which managed private endpoints exist in my factory's managed virtual network?
      - Can I see all private endpoints a managed VNet has?
      instructions:
      - text: List managed private endpoints in virtual network {vnet} of factory {factory}.
        slots:
          factory: path.factoryName
          vnet: path.managedVirtualNetworkName
      - text: Show every private endpoint in managed VNet {vnet} for {factory}.
        slots:
          factory: path.factoryName
          vnet: path.managedVirtualNetworkName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a managed private endpoint
      effect: read
      questions:
      - How do I check the details and approval state of one managed private endpoint?
      - Can I fetch a managed private endpoint only if its ETag changed?
      instructions:
      - text: Get managed private endpoint {endpoint} in virtual network {vnet} of factory {factory}.
        slots:
          factory: path.factoryName
          endpoint: path.managedPrivateEndpointName
          vnet: path.managedVirtualNetworkName
      - text: Fetch private endpoint {endpoint} in VNet {vnet} unless it matches ETag {etag}.
        slots:
          endpoint: path.managedPrivateEndpointName
          vnet: path.managedVirtualNetworkName
          etag: header.if-none-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a managed private endpoint
      effect: write
      questions:
      - How do I create a managed private endpoint so my factory reaches a data store privately?
      - Can I change a managed private endpoint's target resource?
      instructions:
      - text: Create managed private endpoint {endpoint} in VNet {vnet} of factory {factory} with {properties}.
        slots:
          factory: path.factoryName
          endpoint: path.managedPrivateEndpointName
          vnet: path.managedVirtualNetworkName
          properties: requestBody.properties
      - text: Update private endpoint {endpoint} in VNet {vnet} to {properties} if its ETag is {etag}.
        slots:
          endpoint: path.managedPrivateEndpointName
          vnet: path.managedVirtualNetworkName
          properties: requestBody.properties
          etag: header.if-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a managed private endpoint
      effect: destructive
      questions:
      - Can I delete a managed private endpoint my factory no longer uses?
      - What removes a private endpoint from a managed virtual network?
      instructions:
      - text: Delete managed private endpoint {endpoint} in VNet {vnet} of factory {factory}.
        slots:
          factory: path.factoryName
          endpoint: path.managedPrivateEndpointName
          vnet: path.managedVirtualNetworkName
      - text: Remove private endpoint {endpoint} from managed VNet {vnet}.
        slots:
          endpoint: path.managedPrivateEndpointName
          vnet: path.managedVirtualNetworkName
      method: generated
      generated: '2026-09-26'