Microsoft Azure Health Data Services PrivateEndpointConnections API

swagger: '2.0'
info:
  title: Azure Health Data Services de-identification service Collection PrivateEndpointConnections API
  version: '2024-11-15'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- AadToken:
  - https://deid.azure.com/.default
tags:
- name: PrivateEndpointConnections
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections
  : get:
      tags:
      - PrivateEndpointConnections
      operationId: PrivateEndpointConnections_ListByService
      description: Lists all private endpoint connections for a service.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/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.
          schema:
            $ref: '#/definitions/PrivateEndpointConnectionListResultDescription'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      x-ms-examples:
        PrivateEndpointConnection_List:
          $ref: ./examples/legacy/ServiceListPrivateEndpointConnections.json
      x-ms-pageable:
        nextLinkName: null
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
  : get:
      tags:
      - PrivateEndpointConnections
      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: '#/parameters/resourceGroupName'
      - $ref: '#/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.
          schema:
            $ref: '#/definitions/PrivateEndpointConnectionDescription'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      x-ms-examples:
        PrivateEndpointConnection_GetConnection:
          $ref: ./examples/legacy/ServiceGetPrivateEndpointConnection.json
    put:
      tags:
      - PrivateEndpointConnections
      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: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName
      - name: properties
        in: body
        required: true
        schema:
          $ref: ../../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection
        description: The private endpoint connection properties.
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/PrivateEndpointConnectionDescription'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      x-ms-examples:
        PrivateEndpointConnection_CreateOrUpdate:
          $ref: ./examples/legacy/ServiceCreatePrivateEndpointConnection.json
      x-ms-long-running-operation: true
    delete:
      tags:
      - PrivateEndpointConnections
      description: Deletes a private endpoint connection.
      operationId: PrivateEndpointConnections_Delete
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/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
          schema:
            $ref: '#/definitions/ErrorDetails'
      x-ms-examples:
        PrivateEndpointConnections_Delete:
          $ref: ./examples/legacy/ServiceDeletePrivateEndpointConnection.json
      x-ms-long-running-operation: true
definitions:
  ErrorDetails:
    description: Error details.
    type: object
    properties:
      error:
        description: Error details
        $ref: '#/definitions/ErrorDetailsInternal'
  PrivateEndpointConnectionListResultDescription:
    type: object
    properties:
      value:
        type: array
        description: Array of private endpoint connections
        items:
          $ref: '#/definitions/PrivateEndpointConnectionDescription'
    description: List of private endpoint connection associated with the specified storage account
  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
  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.
parameters:
  resourceName:
    name: resourceName
    in: path
    description: The name of the service instance.
    required: true
    type: string
    x-ms-parameter-location: method
    minLength: 3
    maxLength: 24
  resourceGroupName:
    name: resourceGroupName
    in: path
    description: The name of the resource group that contains the service instance.
    required: true
    type: string
    x-ms-parameter-location: method
    pattern: ^[-\w\._\(\)]+$
    minLength: 1
    maxLength: 90
securityDefinitions:
  AadToken:
    type: oauth2
    description: The Azure Active Directory OAuth2 Flow
    flow: accessCode
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
    scopes:
      https://deid.azure.com/.default: ''
    tokenUrl: https://login.microsoftonline.com/common/oauth2/token
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    description: Url of your De-identification Service.
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true