Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Private Endpoint Connection API

12 actions 12 updates phrasing extends openapi/microsoft-azure-private-endpoint-connection-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Azure's API. It is a proposal applied on top of the contract, not a document Microsoft Azure publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 12

$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}'].patch
$.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
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/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 Microsoft Azure Private Endpoint Connection API
  version: 1.0.0
extends: openapi/microsoft-azure-private-endpoint-connection-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: 11
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections'].get
  update:
    x-apievangelist-phrasing:
      intent: List private endpoint connections on a Batch account
      effect: read
      questions:
      - Which private endpoint connections are attached to my Batch account?
      - Can I cap how many Batch private endpoint connections come back?
      instructions:
      - text: List private endpoint connections on Batch account {accountName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          accountName: path.accountName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show up to {maxresults} private endpoint connections for Batch account {accountName}.
        slots:
          maxresults: query.maxresults
          accountName: path.accountName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Batch account private endpoint connection
      effect: read
      questions:
      - How do I check the approval state of a private endpoint connection on a Batch account?
      - What does a single Batch private endpoint connection record show?
      instructions:
      - text: Show private endpoint connection {privateEndpointConnectionName} on Batch account {accountName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          accountName: path.accountName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Get Batch private endpoint connection {privateEndpointConnectionName} for account {accountName}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          accountName: path.accountName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Batch account private endpoint connection
      effect: destructive
      questions:
      - Can I remove a private endpoint connection from a Batch account?
      - What happens to private access when I delete a Batch private endpoint connection?
      instructions:
      - text: Delete private endpoint connection {privateEndpointConnectionName} from Batch account {accountName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          accountName: path.accountName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove Batch private endpoint connection {privateEndpointConnectionName} on account {accountName}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          accountName: path.accountName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Batch private endpoint connection
      effect: write
      questions:
      - How do I approve or reject a pending private endpoint connection on a Batch account?
      - Can I use an ETag so my Batch connection update doesn't overwrite someone else's?
      instructions:
      - text: Update private endpoint connection {privateEndpointConnectionName} on Batch account {accountName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          accountName: path.accountName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Approve Batch private endpoint connection {privateEndpointConnectionName} on account {accountName} only if ETag is {ifMatch}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          accountName: path.accountName
          ifMatch: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections'].get
  update:
    x-apievangelist-phrasing:
      intent: List private endpoint connections on a Purview account
      effect: read
      questions:
      - Which private endpoint connections exist on my Purview account?
      - How do I page through Purview private endpoint connections with a skip token?
      instructions:
      - text: List private endpoint connections for Purview account {accountName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          accountName: path.accountName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the Purview account {accountName} private endpoint connections.
        slots:
          accountName: 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 a Purview private endpoint connection
      effect: read
      questions:
      - How can I see whether a Purview private endpoint connection was approved?
      - What does one Purview private endpoint connection look like?
      instructions:
      - text: Show private endpoint connection {privateEndpointConnectionName} on Purview account {accountName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          accountName: path.accountName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Get Purview private endpoint connection {privateEndpointConnectionName} for account {accountName}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          accountName: path.accountName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve or reject a Purview private endpoint request
      effect: write
      questions:
      - How do I approve a private endpoint request against my Purview account?
      - Can I reject a Purview private endpoint connection request?
      instructions:
      - text: Approve private endpoint connection {privateEndpointConnectionName} on Purview account {accountName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          accountName: path.accountName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Reject the Purview private endpoint request {privateEndpointConnectionName} on account {accountName}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          accountName: path.accountName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Purview private endpoint connection
      effect: destructive
      questions:
      - Can I delete a private endpoint connection from a Purview account?
      - Is removing a Purview private endpoint connection permanent?
      instructions:
      - text: Delete private endpoint connection {privateEndpointConnectionName} from Purview account {accountName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          accountName: path.accountName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove the Purview private endpoint connection {privateEndpointConnectionName} on account {accountName}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          accountName: path.accountName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Recovery Services vault private endpoint
      effect: read
      questions:
      - How does a backup admin check a private endpoint connection on a Recovery Services vault?
      - What state is a vault's private endpoint connection in?
      instructions:
      - text: Show private endpoint connection {privateEndpointConnectionName} on Recovery Services vault {vaultName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          vaultName: path.vaultName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Get the vault {vaultName} private endpoint connection {privateEndpointConnectionName}.
        slots:
          vaultName: path.vaultName
          privateEndpointConnectionName: path.privateEndpointConnectionName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve or reject a vault private endpoint request
      effect: write
      questions:
      - How do I approve a private endpoint request on a Recovery Services vault?
      - Can a backup admin reject a private endpoint request to a vault?
      instructions:
      - text: Approve private endpoint request {privateEndpointConnectionName} on Recovery Services vault {vaultName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          vaultName: path.vaultName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Reject private endpoint request {privateEndpointConnectionName} on backup vault {vaultName}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          vaultName: path.vaultName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a vault private endpoint request
      effect: destructive
      questions:
      - Can I delete a private endpoint request from a Recovery Services vault?
      - Who is expected to remove private endpoint connections from a backup vault?
      instructions:
      - text: Delete private endpoint request {privateEndpointConnectionName} on Recovery Services vault {vaultName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          vaultName: path.vaultName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove the vault {vaultName} private endpoint connection {privateEndpointConnectionName}.
        slots:
          vaultName: path.vaultName
          privateEndpointConnectionName: path.privateEndpointConnectionName
      method: generated
      generated: '2026-10-01'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/microsoft-azure-private-endpoint-connection-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.