Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview Account Private Endpoint Connections API

3 actions 3 updates phrasing extends openapi/microsoft-purview-private-endpoint-connections-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Microsoft Purview's API. It is a proposal applied on top of the contract, not a document Microsoft Purview publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}'].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 Microsoft Purview Account Private Endpoint Connections API
  version: 1.0.0
extends: openapi/microsoft-purview-private-endpoint-connections-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections'].get
  update:
    x-apievangelist-phrasing:
      intent: List a Purview account's private endpoints
      effect: read
      questions:
      - Which private endpoint connections are attached to my Purview account?
      - Are any private endpoints still pending approval on the account?
      instructions:
      - text: List private endpoint connections on Purview account {account} in {rg} of subscription {sub}.
        slots:
          account: path.accountName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show all private endpoints for {account}.
        slots:
          account: path.accountName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one private endpoint connection
      effect: read
      questions:
      - What is the approval state of a specific private endpoint connection?
      - Can I inspect one named private endpoint on a Purview account?
      instructions:
      - text: Get private endpoint connection {conn} on Purview account {account} in {rg} of subscription {sub}.
        slots:
          conn: path.privateEndpointConnectionName
          account: path.accountName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the status of private endpoint {conn} on {account}.
        slots:
          conn: path.privateEndpointConnectionName
          account: path.accountName
      method: generated
      generated: '2026-10-01'