swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PrivateEndpointConnectionProxies API
schemes:
- https
tags:
- name: PrivateEndpointConnectionProxies
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnectionProxies
  : get:
      tags:
      - PrivateEndpointConnectionProxies
      description: (INTERNAL - DO NOT USE) List all private endpoint connection proxies in a device update account.
      operationId: microsoftAzurePrivateendpointconnectionproxiesListbyaccount
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/PrivateEndpointConnectionProxyListResult'
        default:
          description: Error response describing the reason for operation failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        PrivateEndpointConnectionProxyList:
          $ref: ./examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_ListByAccount.json
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Privateendpointconnectionproxies
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnectionProxies/{privateEndpointConnectionProxyId}
  : put:
      tags:
      - PrivateEndpointConnectionProxies
      description: (INTERNAL - DO NOT USE) Creates or updates the specified private endpoint connection proxy resource associated with the device update account.
      operationId: microsoftAzurePrivateendpointconnectionproxiesCreateorupdate
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/PrivateEndpointConnectionProxyIdParameter'
      - name: privateEndpointConnectionProxy
        in: body
        description: The parameters for creating a private endpoint connection proxy.
        required: true
        schema:
          $ref: '#/definitions/PrivateEndpointConnectionProxy'
      responses:
        '201':
          description: The request was successful; the operation will complete asynchronously.
          schema:
            $ref: '#/definitions/PrivateEndpointConnectionProxy'
        default:
          description: Error response describing the reason for operation failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        PrivateEndpointConnectionProxyCreateOrUpdate:
          $ref: ./examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_CreateOrUpdate.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Privateendpointconnectionproxies Privateendpointconnectionproxyid
    delete:
      tags:
      - PrivateEndpointConnectionProxies
      description: (INTERNAL - DO NOT USE) Deletes the specified private endpoint connection proxy associated with the device update account.
      operationId: microsoftAzurePrivateendpointconnectionproxiesDelete
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/PrivateEndpointConnectionProxyIdParameter'
      responses:
        '200':
          description: The request was successful; the operation completed synchronously.
        '202':
          description: The request was successful; the operation will complete asynchronously.
        '204':
          description: The private endpoint connection does not exist in the subscription.
        default:
          description: Error response describing the reason for operation failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        PrivateEndpointConnectionProxyDelete:
          $ref: ./examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_Delete.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Privateendpointconnectionproxies Privateendpointconnectionproxyid
definitions:
  PrivateLinkServiceProxy:
    description: Private link service proxy details.
    type: object
    properties:
      id:
        description: NRP resource ID.
        type: string
      remotePrivateLinkServiceConnectionState:
        description: Remote private link service connection state
        $ref: ./privatelinks.json#/definitions/PrivateLinkServiceConnectionState
      remotePrivateEndpointConnection:
        description: Remote private endpoint connection details.
        allOf:
        - $ref: '#/definitions/RemotePrivateEndpointConnection'
      groupConnectivityInformation:
        description: Group connectivity information.
        type: array
        items:
          $ref: '#/definitions/GroupConnectivityInformation'
  RemotePrivateEndpointConnection:
    description: Remote private endpoint connection details.
    type: object
    properties:
      id:
        description: Remote private endpoint connection ID.
        type: string
        readOnly: true
  PrivateEndpointConnectionProxy:
    description: Private endpoint connection proxy details.
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
    - $ref: '#/definitions/PrivateEndpointConnectionProxyProperties'
    properties:
      properties:
        description: Private endpoint connection proxy object property bag.
        type: object
        x-ms-client-flatten: true
        properties:
          provisioningState:
            $ref: '#/definitions/PrivateEndpointConnectionProxyProvisioningState'
            description: The provisioning state of the private endpoint connection proxy resource.
  GroupConnectivityInformation:
    description: Group connectivity details.
    type: object
    properties:
      groupId:
        description: Group ID.
        type: string
        readOnly: true
      memberName:
        description: Member name.
        type: string
        readOnly: true
      customerVisibleFqdns:
        description: List of customer visible FQDNs.
        type: array
        items:
          type: string
      internalFqdn:
        description: Internal FQDN.
        type: string
        readOnly: true
      redirectMapId:
        description: Redirect map ID.
        type: string
      privateLinkServiceArmRegion:
        description: PrivateLinkService ARM region.
        type: string
  PrivateEndpointConnectionProxyProperties:
    description: Private endpoint connection proxy object properties.
    type: object
    x-ms-client-flatten: true
    properties:
      eTag:
        description: ETag from NRP.
        type: string
        readOnly: true
      remotePrivateEndpoint:
        description: Remote private endpoint details.
        $ref: '#/definitions/RemotePrivateEndpoint'
      status:
        description: Operation status.
        type: string
  PrivateEndpointConnectionProxyListResult:
    description: The available private endpoint connection proxies for an Account (not to be used by anyone, here because of ARM requirements)
    type: object
    properties:
      value:
        description: The list of available private endpoint connection proxies for an Account
        type: array
        items:
          $ref: '#/definitions/PrivateEndpointConnectionProxy'
      nextLink:
        description: The URI that can be used to request the next list of private endpoint connection proxies.
        type: string
  RemotePrivateEndpoint:
    description: Remote private endpoint details.
    type: object
    properties:
      id:
        description: Remote endpoint resource ID.
        type: string
      location:
        description: ARM location of the remote private endpoint.
        type: string
      immutableSubscriptionId:
        description: Original subscription ID needed by Microsoft.Network.
        type: string
      immutableResourceId:
        description: Original resource ID needed by Microsoft.Network.
        type: string
      vnetTrafficTag:
        description: Virtual network traffic tag.
        type: string
      manualPrivateLinkServiceConnections:
        description: List of private link service connections that need manual approval.
        type: array
        items:
          $ref: '#/definitions/PrivateLinkServiceConnection'
      privateLinkServiceConnections:
        description: List of automatically approved private link service connections.
        type: array
        items:
          $ref: '#/definitions/PrivateLinkServiceConnection'
      privateLinkServiceProxies:
        description: List of private link service proxies.
        type: array
        items:
          $ref: '#/definitions/PrivateLinkServiceProxy'
      connectionDetails:
        description: List of connection details.
        type: array
        items:
          $ref: '#/definitions/ConnectionDetails'
  PrivateEndpointConnectionProxyProvisioningState:
    type: string
    readOnly: true
    description: The current provisioning state.
    enum:
    - Succeeded
    - Creating
    - Deleting
    - Failed
    x-ms-enum:
      name: PrivateEndpointConnectionProxyProvisioningState
      modelAsString: true
  PrivateLinkServiceConnection:
    description: Private link service connection details.
    type: object
    properties:
      name:
        description: Private link service connection name.
        type: string
      groupIds:
        description: List of group IDs.
        type: array
        items:
          type: string
      requestMessage:
        description: Request message.
        type: string
  ConnectionDetails:
    description: Private endpoint connection proxy object properties.
    type: object
    properties:
      id:
        description: Connection details ID.
        type: string
        readOnly: true
      privateIpAddress:
        description: Private IP address.
        type: string
        readOnly: true
      linkIdentifier:
        description: Link ID.
        type: string
        readOnly: true
      groupId:
        description: Group ID.
        type: string
        readOnly: true
      memberName:
        description: Member name.
        type: string
        readOnly: true
parameters:
  PrivateEndpointConnectionProxyIdParameter:
    name: privateEndpointConnectionProxyId
    in: path
    required: true
    type: string
    description: The ID of the private endpoint connection proxy object.
    x-ms-parameter-location: method
  AccountNameParameter:
    name: accountName
    in: path
    required: true
    type: string
    description: Account name.
    x-ms-parameter-location: method
    pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
    minLength: 3
    maxLength: 24
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: ADU schema API version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: The Azure subscription ID.
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    description: The resource group name.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'