Microsoft Purview Private Endpoint Connections API

Operations for managing private endpoint connections

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections List a Purview account's private endpoints · Microsoft Purview List private endpoint connections #
Ask an LLM
“Which private endpoint connections are attached to my Purview account?”
“Are any private endpoints still pending approval on the account?”
Tell an agent
List private endpoint connections on Purview account {account} in {rg} of subscription {sub}.
Show all private endpoints for {account}.
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName} Get one private endpoint connection · Microsoft Purview Get a private endpoint connection #
Ask an LLM
“What is the approval state of a specific private endpoint connection?”
“Can I inspect one named private endpoint on a Purview account?”
Tell an agent
Get private endpoint connection {conn} on Purview account {account} in {rg} of subscription {sub}.
Show the status of private endpoint {conn} on {account}.

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/
📖
Authentication
https://learn.microsoft.com/en-us/purview/tutorial-using-rest-apis
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/data-gov-api-create-assets
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/scanning
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/account
📖
Authentication
https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/datamap
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/how-to-purview-custom-lineage-api-user-guide
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/metadatapolicies
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/tutorial-metadata-policy-collections-apis
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/workflow
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/unified-catalog-api-overview
📖
Authentication
https://learn.microsoft.com/en-us/purview/data-gov-api-rest-data-plane
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/unified-catalog-data-quality
📖
Documentation
https://learn.microsoft.com/en-us/graph/api/resources/security-ediscovery-apioverview?view=graph-rest-1.0
📖
Authentication
https://learn.microsoft.com/en-us/graph/security-ediscovery-appauthsetup
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/edisc-ref-api-guide
📖
Documentation
https://learn.microsoft.com/en-us/graph/security-information-protection-overview
📖
Documentation
https://learn.microsoft.com/en-us/graph/security-datasecurityandgovernance-overview
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/developer/use-the-api
📖
Documentation
https://learn.microsoft.com/en-us/graph/api/resources/security-recordsmanagement-overview?view=graph-rest-1.0

Specifications

Other Resources

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API
curl "https://apis.io/api/v1/apis/microsoft-purview:microsoft-purview-private-endpoint-connections-api"
All apis
curl "https://apis.io/api/v1/apis?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.

OpenAPI Specification

microsoft-purview-private-endpoint-connections-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Microsoft Purview Account Private Endpoint Connections API
  description: APIs for managing Purview accounts, configurations, and administrative settings through Azure Resource Manager. Provides resource management operations for creating, updating, and deleting Purview accounts.
  version: 2021-12-01
  contact:
    name: Microsoft Purview Support
    url: https://learn.microsoft.com/en-us/purview/
  license:
    name: Microsoft API License
    url: https://azure.microsoft.com/en-us/support/legal/
servers:
- url: https://management.azure.com
  description: Azure Resource Manager endpoint
security:
- oauth2: []
tags:
- name: Private Endpoint Connections
  description: Operations for managing private endpoint connections
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections
  : get:
      operationId: listPrivateEndpointConnections
      summary: Microsoft Purview List private endpoint connections
      description: Gets private endpoint connections for the Purview account.
      tags:
      - Private Endpoint Connections
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/AccountName'
      - $ref: '#/components/parameters/ApiVersion'
      responses:
        '200':
          description: Private endpoint connections listed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointConnectionList'
        '401':
          description: Unauthorized
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
  : get:
      operationId: getPrivateEndpointConnection
      summary: Microsoft Purview Get a private endpoint connection
      description: Gets a private endpoint connection for the Purview account.
      tags:
      - Private Endpoint Connections
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/AccountName'
      - name: privateEndpointConnectionName
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersion'
      responses:
        '200':
          description: Private endpoint connection retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointConnection'
        '401':
          description: Unauthorized
        '404':
          description: Not found
components:
  parameters:
    ResourceGroupName:
      name: resourceGroupName
      in: path
      required: true
      description: The resource group name
      schema:
        type: string
    AccountName:
      name: accountName
      in: path
      required: true
      description: The name of the Purview account
      schema:
        type: string
    SubscriptionId:
      name: subscriptionId
      in: path
      required: true
      description: The Azure subscription ID
      schema:
        type: string
        format: uuid
    ApiVersion:
      name: api-version
      in: query
      required: true
      description: The API version
      schema:
        type: string
        default: '2021-12-01'
  schemas:
    PrivateEndpointConnectionList:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/PrivateEndpointConnection'
        nextLink:
          type: string
        count:
          type: integer
          format: int64
    PrivateEndpointConnection:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        properties:
          type: object
          properties:
            privateEndpoint:
              type: object
              properties:
                id:
                  type: string
            privateLinkServiceConnectionState:
              type: object
              properties:
                actionsRequired:
                  type: string
                description:
                  type: string
                status:
                  type: string
                  enum:
                  - Unknown
                  - Pending
                  - Approved
                  - Rejected
                  - Disconnected
            provisioningState:
              type: string
              readOnly: true
        type:
          type: string
          readOnly: true
  securitySchemes:
    oauth2:
      type: oauth2
      description: Azure Active Directory OAuth2 authentication
      flows:
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
          scopes:
            https://management.azure.com/.default: Access Azure Resource Manager