Microsoft Azure Health Data Services

Microsoft Azure Health Data Services Private Endpoint Connections API

The Private Endpoint Connections API from Microsoft Azure Health Data Services — 2 operation(s) for private endpoint connections.

GitHub OpenAPI

Operations 4

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections Private endpoint connections list by service #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} Private endpoint connections get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} Private endpoint connections create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} Private endpoint connections delete #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/overview
📖
Authentication
https://learn.microsoft.com/en-us/azure/healthcare-apis/authentication-authorization
📖
GettingStarted
https://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/get-started-with-fhir
📖
Documentation
https://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/overview
📖
GettingStarted
https://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/deploy-dicom-services-in-azure
📖
Documentation
https://learn.microsoft.com/en-us/azure/healthcare-apis/iot/iot-connector-overview
📖
GettingStarted
https://learn.microsoft.com/en-us/azure/healthcare-apis/iot/get-started-with-iot
📖
Documentation
https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/overview
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/healthcareapis/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/azure-health/refs/heads/main/openapi/azure-health-private-endpoint-connections-api-openapi.yml

Other Resources

🔗
REST API Reference
https://learn.microsoft.com/en-us/rest/api/healthcareapis/fhir-services
🔗
SMART on FHIR
https://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/smart-on-fhir
🔗
Search Reference
https://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/overview-of-search
🔗
ChangeLog
https://learn.microsoft.com/en-us/azure/healthcare-apis/release-notes-2024
🔗
Pricing
https://azure.microsoft.com/en-us/pricing/details/health-data-services/
🔗
REST API Reference
https://learn.microsoft.com/en-us/rest/api/healthcareapis/dicom-services
🔗
DICOMweb Standard APIs Guide
https://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/dicomweb-standard-apis-with-dicom-services
🔗
Conformance Statement
https://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/dicom-services-conformance-statement-v2
🔗
REST API Reference
https://learn.microsoft.com/en-us/rest/api/healthcareapis/iot-connector
🔗
Device Mapping Guide
https://learn.microsoft.com/en-us/azure/healthcare-apis/iot/how-to-use-device-mappings
🔗
REST API Reference
https://learn.microsoft.com/en-us/rest/api/health-dataplane/deidentify-text/deidentify-text
🔗
SDK Overview
https://learn.microsoft.com/dotnet/api/overview/azure/Health.Deidentification-readme
🔗
Service Limits
https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/overview#input-requirements-and-service-limits
🔗
REST API Reference
https://learn.microsoft.com/en-us/rest/api/healthcareapis/workspaces
🔗
Workspace Overview
https://learn.microsoft.com/en-us/azure/healthcare-apis/workspace-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/azure-health-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.

GitHub Google LinkedIn

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

OpenAPI Specification

azure-health-private-endpoint-connections-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '2024-03-31'
  title: HealthcareApisClient Private Endpoint Connections API
  description: Use this API to manage Microsoft HealthcareApis services in your Azure subscription.
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Private Endpoint Connections
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections
  : get:
      tags:
      - Private Endpoint Connections
      operationId: PrivateEndpointConnections_ListByService
      description: Lists all private endpoint connections for a service.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/resourceName'
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointConnectionListResultDescription'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      x-ms-examples:
        PrivateEndpointConnection_List:
          $ref: ./examples/legacy/ServiceListPrivateEndpointConnections.json
      x-ms-pageable:
        nextLinkName: null
      summary: Private endpoint connections list by service
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
  : get:
      tags:
      - Private Endpoint Connections
      operationId: PrivateEndpointConnections_Get
      description: Gets the specified private endpoint connection associated with the service.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/resourceName'
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointConnectionDescription'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      x-ms-examples:
        PrivateEndpointConnection_GetConnection:
          $ref: ./examples/legacy/ServiceGetPrivateEndpointConnection.json
      summary: Private endpoint connections get
      x-summary-source: derived
    put:
      tags:
      - Private Endpoint Connections
      operationId: PrivateEndpointConnections_CreateOrUpdate
      description: Update the state of the specified private endpoint connection associated with the service.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/resourceName'
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointConnectionDescription'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      x-ms-examples:
        PrivateEndpointConnection_CreateOrUpdate:
          $ref: ./examples/legacy/ServiceCreatePrivateEndpointConnection.json
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: ../../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection
        description: The private endpoint connection properties.
        required: true
      summary: Private endpoint connections create or update
      x-summary-source: derived
    delete:
      tags:
      - Private Endpoint Connections
      description: Deletes a private endpoint connection.
      operationId: PrivateEndpointConnections_Delete
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/resourceName'
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
        '202':
          description: The request was successful; the operation will complete asynchronously.
        '204':
          description: No Content - The private endpoint connection does not exist.
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      x-ms-examples:
        PrivateEndpointConnections_Delete:
          $ref: ./examples/legacy/ServiceDeletePrivateEndpointConnection.json
      x-ms-long-running-operation: true
      summary: Private endpoint connections delete
      x-summary-source: derived
components:
  schemas:
    PrivateEndpointConnectionListResultDescription:
      type: object
      properties:
        value:
          type: array
          description: Array of private endpoint connections
          items:
            $ref: '#/components/schemas/PrivateEndpointConnectionDescription'
      description: List of private endpoint connection associated with the specified storage account
    ErrorDetails:
      description: Error details.
      type: object
      properties:
        error:
          description: Error details
          $ref: '#/components/schemas/ErrorDetailsInternal'
    PrivateEndpointConnectionDescription:
      type: object
      properties:
        systemData:
          description: Metadata pertaining to creation and last modification of the resource.
          $ref: ../../../../../../common-types/resource-management/v1/types.json#/definitions/systemData
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection
      description: The Private Endpoint Connection resource.
    ErrorDetailsInternal:
      description: Error details.
      type: object
      properties:
        code:
          description: The error code.
          type: string
          readOnly: true
        message:
          description: The error message.
          type: string
          readOnly: true
        target:
          description: The target of the particular error.
          type: string
          readOnly: true
  parameters:
    resourceGroupName:
      name: resourceGroupName
      in: path
      description: The name of the resource group that contains the service instance.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
        pattern: ^[-\w\._\(\)]+$
    resourceName:
      name: resourceName
      in: path
      description: The name of the service instance.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 24
        minLength: 3
  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