Microsoft Azure Health Data Services PrivateLinkResources API

swagger: '2.0'
info:
  title: Azure Health Data Services de-identification service Collection PrivateLinkResources 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: PrivateLinkResources
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources
  : get:
      tags:
      - PrivateLinkResources
      operationId: PrivateLinkResources_ListByService
      description: Gets the private link resources that need to be created 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/PrivateLinkResourceListResultDescription'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      x-ms-examples:
        PrivateLinkResources_ListGroupIds:
          $ref: ./examples/legacy/PrivateLinkResourcesListByService.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources/{groupName}
  : get:
      tags:
      - PrivateLinkResources
      operationId: PrivateLinkResources_Get
      description: Gets a private link resource that need to be created 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
      - name: groupName
        in: path
        description: The name of the private link resource group.
        required: true
        type: string
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/PrivateLinkResourceDescription'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      x-ms-examples:
        PrivateLinkResources_Get:
          $ref: ./examples/legacy/PrivateLinkResourceGet.json
definitions:
  ErrorDetails:
    description: Error details.
    type: object
    properties:
      error:
        description: Error details
        $ref: '#/definitions/ErrorDetailsInternal'
  PrivateLinkResourceListResultDescription:
    type: object
    properties:
      value:
        type: array
        description: Array of private link resources
        items:
          $ref: '#/definitions/PrivateLinkResourceDescription'
    description: A list of private link resources
  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
  PrivateLinkResourceDescription:
    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/PrivateLinkResource
    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