swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector WorkspacePrivateEndpointConnections API
schemes:
- https
tags:
- name: WorkspacePrivateEndpointConnections
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections
  : get:
      tags:
      - WorkspacePrivateEndpointConnections
      summary: Microsoft Azure Called By End Users To Get All Pe Connections
      operationId: microsoftAzurePrivateendpointconnectionsList
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $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/PrivateEndpointConnectionListResult'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        StorageAccountListPrivateEndpointConnections:
          $ref: ./examples/PrivateEndpointConnection/list.json
      x-ms-pageable:
        nextLinkName: null
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
  : delete:
      tags:
      - WorkspacePrivateEndpointConnections
      summary: Microsoft Azure Called By End Users To Delete A Pe Connection
      operationId: microsoftAzurePrivateendpointconnectionsDelete
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/PrivateEndpointConnectionName'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
        '204':
          description: No Content
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        WorkspacePutPrivateEndpointConnection:
          $ref: ./examples/PrivateEndpointConnection/delete.json
      description: Needs a more full description created.
    get:
      tags:
      - WorkspacePrivateEndpointConnections
      summary: Microsoft Azure Called By End Users To Get A Pe Connection
      operationId: microsoftAzurePrivateendpointconnectionsGet
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/PrivateEndpointConnectionName'
      - $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/PrivateEndpointConnection'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        WorkspaceGetPrivateEndpointConnection:
          $ref: ./examples/PrivateEndpointConnection/get.json
      description: Needs a more full description created.
    put:
      tags:
      - WorkspacePrivateEndpointConnections
      summary: "Microsoft Azure Called By End Users To Approve Or Reject A Pe Connection \r\nthis Method Must Validate And Forward The Call To Nrp"
      operationId: microsoftAzurePrivateendpointconnectionsCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/PrivateEndpointConnectionName'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - in: body
        name: body
        description: PrivateEndpointConnection object
        required: true
        schema:
          $ref: '#/definitions/PrivateEndpointConnection'
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/PrivateEndpointConnection'
        default:
          description: Error
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        WorkspacePutPrivateEndpointConnection:
          $ref: ./examples/PrivateEndpointConnection/createOrUpdate.json
      description: Needs a more full description created.
definitions:
  PrivateLinkServiceConnectionState:
    description: A collection of information about the state of the connection between service consumer and provider.
    type: object
    properties:
      actionsRequired:
        description: Some RP chose "None". Other RPs use this for region expansion.
        type: string
      description:
        description: User-defined message that, per NRP doc, may be used for approval-related message.
        type: string
      status:
        $ref: '#/definitions/PrivateEndpointServiceConnectionStatus'
  PrivateEndpointConnectionProperties:
    description: Private endpoint connection properties.
    type: object
    properties:
      privateEndpoint:
        $ref: '#/definitions/WorkspacePrivateEndpointResource'
      privateLinkServiceConnectionState:
        description: The connection state.
        $ref: '#/definitions/PrivateLinkServiceConnectionState'
      provisioningState:
        $ref: '#/definitions/PrivateEndpointConnectionProvisioningState'
  WorkspacePrivateEndpointResource:
    description: The Private Endpoint resource.
    type: object
    properties:
      id:
        description: e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}
        type: string
        readOnly: true
        x-ms-mutability:
        - read
      subnetArmId:
        description: The subnetId that the private endpoint is connected to.
        type: string
        readOnly: true
        x-ms-mutability:
        - read
  PrivateEndpointConnectionListResult:
    description: List of private endpoint connection associated with the specified workspace
    type: object
    properties:
      value:
        description: Array of private endpoint connections
        type: array
        items:
          $ref: '#/definitions/PrivateEndpointConnection'
  PrivateEndpointConnection:
    description: The Private Endpoint Connection resource.
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/Resource
    properties:
      identity:
        $ref: ../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity
      location:
        description: Same as workspace location.
        type: string
      properties:
        description: Private endpoint connection properties.
        $ref: '#/definitions/PrivateEndpointConnectionProperties'
        x-ms-client-flatten: true
      sku:
        description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier
        $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/Sku
      tags:
        type: object
        additionalProperties:
          type: string
  PrivateEndpointServiceConnectionStatus:
    description: "Connection status of the service consumer with the service provider\r\nPossible state transitions\r\nPending -> Approved (Service provider approves the connection request)\r\nPending -> Rejected (Service provider rejects the connection request)\r\nPending -> Disconnected (Service provider deletes the connection)\r\nApproved -> Rejected (Service provider rejects the approved connection)\r\nApproved -> Disconnected (Service provider deletes the connection)\r\nRejected -> Pending (Service consumer re-initiates the connection request that was rejected)\r\nRejected -> Disconnected (Service provider deletes the connection)"
    enum:
    - Approved
    - Pending
    - Rejected
    - Disconnected
    - Timeout
    type: string
    x-ms-enum:
      name: EndpointServiceConnectionStatus
      modelAsString: true
  PrivateEndpointConnectionProvisioningState:
    description: The current provisioning state.
    enum:
    - Succeeded
    - Creating
    - Deleting
    - Failed
    type: string
    x-ms-enum:
      name: PrivateEndpointConnectionProvisioningState
      modelAsString: true
parameters:
  PrivateEndpointConnectionName:
    in: path
    name: privateEndpointConnectionName
    description: NRP Private Endpoint Connection Name
    required: true
    type: string
    x-ms-parameter-location: method
  WorkspaceNameParameter:
    in: path
    name: workspaceName
    description: Azure Machine Learning Workspace Name
    required: true
    type: string
    x-ms-parameter-location: method
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'