Microsoft Purview

Microsoft Purview Private Endpoint Connection API

The Private Endpoint Connection API from Microsoft Purview — 2 operation(s) for private endpoint connection.

GitHub OpenAPI

Operations 4

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections Gets private endpoint connections #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName} Gets private endpoint connection information #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName} Approves/Rejects private endpoint connection request #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName} Deletes private endpoint connection #

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
📖
Authentication
https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/how-to-purview-custom-lineage-api-user-guide
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/tutorial-metadata-policy-collections-apis
📖
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

⚙
OpenAPI
https://artifacts.apis.io/microsoft-purview/openapi/microsoft-purview-private-endpoint-connection-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/microsoft-purview/json-schema/microsoft-purview-private-endpoint-connection-schema.json

Other Resources

🔗
Pricing
https://azure.microsoft.com/en-us/pricing/details/purview/
🔗
Reference
https://learn.microsoft.com/en-us/purview/data-map-data-sources
🔗
Reference
https://learn.microsoft.com/en-us/purview/unified-catalog-data-quality
🔗
Reference
https://learn.microsoft.com/en-us/purview/sensitivity-labels
🔗
Reference
https://learn.microsoft.com/en-us/purview/developer/
🔗
Reference
https://learn.microsoft.com/en-us/graph/compliance-concept-overview

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-connection-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

microsoft-purview-private-endpoint-connection-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '2021-12-01'
  title: PurviewManagementClient Private Endpoint Connection API
  description: Creates a Microsoft.Purview management client.
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Private Endpoint Connection
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections
  : get:
      tags:
      - Private Endpoint Connection
      summary: Gets private endpoint connections
      description: Get private endpoint connections for account
      operationId: PrivateEndpointConnections_ListByAccount
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/accountName'
      - $ref: '#/components/parameters/api-version'
      - name: $skipToken
        in: query
        description: The skip token.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointConnectionList'
        default:
          description: An error response received from the provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
  : get:
      tags:
      - Private Endpoint Connection
      summary: Gets private endpoint connection information
      description: Get a private endpoint connection
      operationId: PrivateEndpointConnections_Get
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/accountName'
      - name: privateEndpointConnectionName
        in: path
        description: Name of the private endpoint connection.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointConnection'
        default:
          description: An error response received from the provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
    put:
      tags:
      - Private Endpoint Connection
      summary: Approves/Rejects private endpoint connection request
      description: Create or update a private endpoint connection
      operationId: PrivateEndpointConnections_CreateOrUpdate
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/accountName'
      - name: privateEndpointConnectionName
        in: path
        description: Name of the private endpoint connection.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointConnection'
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointConnection'
        default:
          description: An error response received from the provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrivateEndpointConnection'
        description: The request.
        required: true
    delete:
      tags:
      - Private Endpoint Connection
      summary: Deletes private endpoint connection
      description: Delete a private endpoint connection
      operationId: PrivateEndpointConnections_Delete
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/accountName'
      - name: privateEndpointConnectionName
        in: path
        description: Name of the private endpoint connection.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
        '202':
          description: Accepted
        '204':
          description: Success
        default:
          description: An error response received from the provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
      x-ms-long-running-operation: true
components:
  parameters:
    resourceGroupName:
      name: resourceGroupName
      in: path
      description: The resource group name.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    api-version:
      name: api-version
      in: query
      description: The api version to use.
      required: true
      schema:
        type: string
    accountName:
      name: accountName
      in: path
      description: The name of the account.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 63
        minLength: 3
        pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
    subscriptionId:
      name: subscriptionId
      in: path
      description: The subscription identifier
      required: true
      schema:
        type: string
  schemas:
    ErrorModel:
      description: Default error model
      type: object
      properties:
        code:
          description: Gets or sets the code.
          type: string
          readOnly: true
        details:
          description: Gets or sets the details.
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/ErrorModel'
          x-ms-identifiers:
          - code
          readOnly: true
        message:
          description: Gets or sets the messages.
          type: string
          readOnly: true
        target:
          description: Gets or sets the target.
          type: string
          readOnly: true
    PrivateEndpoint:
      description: A private endpoint class.
      type: object
      properties:
        id:
          description: The private endpoint identifier.
          type: string
    PrivateEndpointConnectionProperties:
      description: A private endpoint connection properties class.
      type: object
      properties:
        privateEndpoint:
          $ref: '#/components/schemas/PrivateEndpoint'
          description: The private endpoint information.
        privateLinkServiceConnectionState:
          $ref: '#/components/schemas/PrivateLinkServiceConnectionState'
          description: The private link service connection state.
        provisioningState:
          description: The provisioning state.
          type: string
          readOnly: true
    PrivateEndpointConnectionList:
      description: Paged list of private endpoint connections
      required:
      - value
      type: object
      properties:
        nextLink:
          description: The Url of next result page.
          type: string
        value:
          description: Collection of items of type results.
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/PrivateEndpointConnection'
          x-ms-identifiers:
          - name
    PrivateEndpointConnection:
      description: A private endpoint connection class.
      type: object
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
      properties:
        properties:
          $ref: '#/components/schemas/PrivateEndpointConnectionProperties'
          description: The connection identifier.
          x-ms-client-flatten: true
    SystemData:
      description: Metadata pertaining to creation and last modification of the resource.
      type: object
      properties:
        createdAt:
          format: date-time
          description: The timestamp of resource creation (UTC).
          type: string
          readOnly: true
        createdBy:
          description: The identity that created the resource.
          type: string
          readOnly: true
        createdByType:
          description: The type of identity that created the resource.
          enum:
          - User
          - Application
          - ManagedIdentity
          - Key
          type: string
          readOnly: true
          x-ms-enum:
            name: createdByType
            modelAsString: true
        lastModifiedAt:
          format: date-time
          description: The timestamp of the last modification the resource (UTC).
          type: string
          readOnly: true
        lastModifiedBy:
          description: The identity that last modified the resource.
          type: string
          readOnly: true
        lastModifiedByType:
          description: The type of identity that last modified the resource.
          enum:
          - User
          - Application
          - ManagedIdentity
          - Key
          type: string
          readOnly: true
          x-ms-enum:
            name: lastModifiedByType
            modelAsString: true
    ErrorResponseModel:
      description: Default error response model
      type: object
      properties:
        error:
          description: Gets or sets the error.
          allOf:
          - $ref: '#/components/schemas/ErrorModel'
          readOnly: true
    PrivateLinkServiceConnectionState:
      description: The private link service connection state.
      type: object
      properties:
        actionsRequired:
          description: The required actions.
          type: string
        description:
          description: The description.
          type: string
        status:
          description: The status.
          enum:
          - Unknown
          - Pending
          - Approved
          - Rejected
          - Disconnected
          type: string
          x-ms-enum:
            name: status
            modelAsString: true
    ProxyResource:
      description: Proxy Azure Resource
      type: object
      properties:
        id:
          description: Gets or sets the identifier.
          type: string
          readOnly: true
        name:
          description: Gets or sets the name.
          type: string
          readOnly: true
        systemData:
          description: Metadata pertaining to creation and last modification of the resource.
          allOf:
          - $ref: '#/components/schemas/SystemData'
          readOnly: true
        type:
          description: Gets or sets the type.
          type: string
          readOnly: true
      x-ms-azure-resource: true
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.