swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PrivateEndpointConnectionProxyController API
schemes:
- https
tags:
- name: PrivateEndpointConnectionProxyController
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/privateEndpointConnectionProxies
  : get:
      tags:
      - PrivateEndpointConnectionProxyController
      summary: Microsoft Azure Get The Private Endpoint Connection Proxies
      description: Get all the private endpoint connections proxies under a migrate project.
      operationId: microsoftAzurePrivateendpointconnectionproxycontrollerListprivateendpointconnectionproxies
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/migrateProjectName'
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PrivateEndpointConnectionProxyCollection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      deprecated: false
      x-ms-examples:
        PrivateEndpointConnectionProxyController_ListPrivateEndpointConnectionProxies_MaximumSet_Gen:
          $ref: ./examples/PrivateEndpointConnectionProxyController_ListPrivateEndpointConnectionProxies_MaximumSet_Gen.json
        PrivateEndpointConnectionProxyController_ListPrivateEndpointConnectionProxies_MinimumSet_Gen:
          $ref: ./examples/PrivateEndpointConnectionProxyController_ListPrivateEndpointConnectionProxies_MinimumSet_Gen.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/privateEndpointConnectionProxies/{pecProxyName}
  : get:
      tags:
      - PrivateEndpointConnectionProxyController
      summary: Microsoft Azure Get The Private Link Proxy Resource
      description: Get the of private link proxy resources from a migrate project and private link proxy resource.
      operationId: microsoftAzurePrivateendpointconnectionproxycontrollerGet
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/migrateProjectName'
      - name: pecProxyName
        description: Private link proxy name.
        in: path
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PrivateEndpointConnectionProxy'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      deprecated: false
      x-ms-examples:
        PrivateEndpointConnectionProxyController_Get_MaximumSet_Gen:
          $ref: ./examples/PrivateEndpointConnectionProxyController_Get_MaximumSet_Gen.json
        PrivateEndpointConnectionProxyController_Get_MinimumSet_Gen:
          $ref: ./examples/PrivateEndpointConnectionProxyController_Get_MinimumSet_Gen.json
    put:
      tags:
      - PrivateEndpointConnectionProxyController
      summary: Microsoft Azure Create Or Update Private Endpoint Proxy
      description: Create or update a private endpoint proxy with specified name. If a private endpoint already exists, update it.
      operationId: microsoftAzurePrivateendpointconnectionproxycontrollerCreate
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/migrateProjectName'
      - name: pecProxyName
        description: Private endpoint proxy name.
        in: path
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - name: body
        description: Modify private endpoint proxy state body.
        in: body
        required: true
        schema:
          $ref: '#/definitions/PrivateEndpointConnectionProxy'
      responses:
        '200':
          description: ARM create or update operation completed successfully.
          schema:
            $ref: '#/definitions/PrivateEndpointConnectionProxy'
        '201':
          description: ARM create or update operation completed successfully.
          headers:
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              type: integer
              format: int32
          schema:
            $ref: '#/definitions/PrivateEndpointConnectionProxy'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      deprecated: false
      x-ms-examples:
        PrivateEndpointConnectionProxyController_Create_MaximumSet_Gen:
          $ref: ./examples/PrivateEndpointConnectionProxyController_Create_MaximumSet_Gen.json
        PrivateEndpointConnectionProxyController_Create_MinimumSet_Gen:
          $ref: ./examples/PrivateEndpointConnectionProxyController_Create_MinimumSet_Gen.json
    delete:
      tags:
      - PrivateEndpointConnectionProxyController
      summary: Microsoft Azure Delete The Private Endpoint Proxy
      description: Delete the private endpoint proxy. Deleting non-existent private endpoint proxy is a no-operation.
      operationId: microsoftAzurePrivateendpointconnectionproxycontrollerDelete
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/migrateProjectName'
      - name: pecProxyName
        description: Private endpoint proxy name.
        in: path
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Object'
        '204':
          description: No content. No private endpoint proxy with specified name was found.
          schema:
            $ref: '#/definitions/Object'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      deprecated: false
      x-ms-examples:
        PrivateEndpointConnectionProxyController_Delete_MaximumSet_Gen:
          $ref: ./examples/PrivateEndpointConnectionProxyController_Delete_MaximumSet_Gen.json
        PrivateEndpointConnectionProxyController_Delete_MinimumSet_Gen:
          $ref: ./examples/PrivateEndpointConnectionProxyController_Delete_MinimumSet_Gen.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/privateEndpointConnectionProxies/{pecProxyName}/validate
  : post:
      tags:
      - PrivateEndpointConnectionProxyController
      summary: Microsoft Azure Validates Private Endpoint Connection Proxy
      description: Validates private endpoint connection using a project and private endpoint connection proxy
      operationId: microsoftAzurePrivateendpointconnectionproxycontrollerValidate
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/migrateProjectName'
      - name: pecProxyName
        description: Private link proxy name.
        in: path
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - name: body
        description: Validate proxy connection state body.
        in: body
        required: true
        schema:
          $ref: '#/definitions/PrivateEndpointConnectionProxy'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PrivateEndpointConnectionProxy'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      deprecated: false
      x-ms-examples:
        PrivateEndpointConnectionProxyController_Validate_MaximumSet_Gen:
          $ref: ./examples/PrivateEndpointConnectionProxyController_Validate_MaximumSet_Gen.json
        PrivateEndpointConnectionProxyController_Validate_MinimumSet_Gen:
          $ref: ./examples/PrivateEndpointConnectionProxyController_Validate_MinimumSet_Gen.json
definitions:
  PrivateLinkServiceProxy:
    description: Defines Private link service proxy.
    type: object
    properties:
      id:
        type: string
      groupConnectivityInformation:
        type: array
        items:
          $ref: '#/definitions/GroupConnectivityInformation'
      remotePrivateEndpointConnection:
        $ref: '#/definitions/ResourceId'
      remotePrivateLinkServiceConnectionState:
        $ref: '#/definitions/PrivateLinkServiceConnectionState'
  PrivateEndpointConnectionProxyCollection:
    description: Collection of PrivateLink proxy resources.
    type: object
    properties:
      value:
        description: Gets the list of PrivateLink proxy resources.
        type: array
        items:
          $ref: '#/definitions/PrivateEndpointConnectionProxy'
        readOnly: true
      nextLink:
        description: Gets the value of next link.
        type: string
        readOnly: true
  PrivateEndpointConnectionProxy:
    description: Defines Private endpoint proxy resource.
    x-ms-azure-resource: true
    type: object
    properties:
      id:
        type: string
        readOnly: true
      name:
        type: string
        readOnly: true
      type:
        type: string
        readOnly: true
      eTag:
        type: string
      properties:
        $ref: '#/definitions/PrivateEndpointConnectionProxyProperties'
      systemData:
        $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/systemData
        readOnly: true
  ResourceId:
    description: Defines resource ID of a private endpoint connection.
    type: object
    properties:
      id:
        type: string
        readOnly: true
  PrivateEndpointConnectionProxyProperties:
    type: object
    description: Properties of a private endpoint connection proxy.
    properties:
      remotePrivateEndpoint:
        $ref: '#/definitions/PrivateEndpointDetails'
        readOnly: true
      status:
        enum:
        - Succeeded
        - Failed
        - Cancelled
        - Running
        x-ms-enum:
          name: PrivateEndpointConnectionProxyProperties_status
          modelAsString: true
        type: string
        readOnly: true
  PrivateLinkServiceConnection:
    description: Defines Private link service connection.
    type: object
    properties:
      id:
        type: string
      name:
        type: string
      groupIds:
        type: array
        items:
          type: string
      requestMessage:
        type: string
  Object:
    description: Defines generic object.
    type: object
    properties: {}
  IpConfiguration:
    description: Defines Private link IP configuration.
    type: object
    properties:
      id:
        type: string
      privateIpAddress:
        type: string
      linkIdentifier:
        type: string
      groupId:
        type: string
      memberName:
        type: string
  GroupConnectivityInformation:
    description: Defines Private link service group connectivity.
    type: object
    properties:
      id:
        type: string
      groupId:
        type: string
      memberName:
        type: string
      customerVisibleFqdns:
        type: array
        items:
          type: string
      internalFqdn:
        type: string
      redirectMapId:
        type: string
      privateLinkServiceArmRegion:
        type: string
  PrivateEndpointDetails:
    description: Defines Private endpoint additional details.
    type: object
    properties:
      id:
        type: string
      manualPrivateLinkServiceConnections:
        type: array
        items:
          $ref: '#/definitions/PrivateLinkServiceConnection'
      privateLinkServiceConnections:
        type: array
        items:
          $ref: '#/definitions/PrivateLinkServiceConnection'
      privateLinkServiceProxies:
        type: array
        items:
          $ref: '#/definitions/PrivateLinkServiceProxy'
      connectionDetails:
        type: array
        items:
          $ref: '#/definitions/IpConfiguration'
  PrivateLinkServiceConnectionState:
    type: object
    description: Private endpoint connection state.
    properties:
      status:
        enum:
        - Approved
        - Pending
        - Rejected
        - Disconnected
        type: string
        description: Private link connection state.
        x-ms-enum:
          name: PrivateLinkServiceConnectionState_status
          modelAsString: true
      description:
        type: string
        description: Description of the object.
      actionsRequired:
        type: string
        description: Action required.
parameters:
  migrateProjectName:
    name: migrateProjectName
    description: Name of the Azure Migrate project.
    type: string
    in: path
    x-ms-parameter-location: method
    required: true
    pattern: ^[a-zA-Z0-9-]{3,24}$
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'