Azure Stream Analytics Private Endpoints API

openapi: 3.2.0
info:
  title: StreamAnalyticsManagementClient Private Endpoints API
  version: '2020-03-01'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Private Endpoints
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters/{clusterName}/privateEndpoints/{privateEndpointName}
  : put:
      tags:
      - Private Endpoints
      description: Creates a Stream Analytics Private Endpoint or replaces an already existing Private Endpoint.
      operationId: PrivateEndpoints_CreateOrUpdate
      x-ms-examples:
        Create a private endpoint:
          $ref: ./examples/PrivateEndpoint_Create.json
      parameters:
      - $ref: ./common/v1/definitions.json#/parameters/SubscriptionIdParameter
      - $ref: ./common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ./clusters.json#/parameters/ClusterNameParameter
      - $ref: '#/components/parameters/PrivateEndpointNameParameter'
      - $ref: ./common/v1/definitions.json#/parameters/ApiVersionParameter
      - $ref: ./common/v1/definitions.json#/parameters/IfMatchHeader
      - $ref: ./common/v1/definitions.json#/parameters/IfNoneMatchHeader
      responses:
        '200':
          description: The private endpoint was successfully created or replaced.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpoint'
        '201':
          description: The private endpoint was successfully created or replaced.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpoint'
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: ./common/v1/definitions.json#/definitions/Error
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrivateEndpoint'
        description: The definition of the private endpoint that will be used to create a new cluster or replace the existing one.
        required: true
      summary: Private endpoints create or update
      x-summary-source: derived
    get:
      tags:
      - Private Endpoints
      description: Gets information about the specified Private Endpoint.
      operationId: PrivateEndpoints_Get
      x-ms-examples:
        Get a private endpoint:
          $ref: ./examples/PrivateEndpoint_Get.json
      parameters:
      - $ref: ./common/v1/definitions.json#/parameters/SubscriptionIdParameter
      - $ref: ./common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ./clusters.json#/parameters/ClusterNameParameter
      - $ref: '#/components/parameters/PrivateEndpointNameParameter'
      - $ref: ./common/v1/definitions.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Successfully retrieved the specified private endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpoint'
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: ./common/v1/definitions.json#/definitions/Error
      summary: Private endpoints get
      x-summary-source: derived
    delete:
      tags:
      - Private Endpoints
      description: Delete the specified private endpoint.
      operationId: PrivateEndpoints_Delete
      x-ms-examples:
        Delete a private endpoint:
          $ref: ./examples/PrivateEndpoint_Delete.json
      parameters:
      - $ref: ./common/v1/definitions.json#/parameters/SubscriptionIdParameter
      - $ref: ./common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ./clusters.json#/parameters/ClusterNameParameter
      - $ref: '#/components/parameters/PrivateEndpointNameParameter'
      - $ref: ./common/v1/definitions.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The private endpoint was successfully deleted.
        '202':
          description: The delete request was successfully initiated.
        '204':
          description: The private endpoint does not exist.
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: ./common/v1/definitions.json#/definitions/Error
      x-ms-long-running-operation: true
      summary: Private endpoints delete
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters/{clusterName}/privateEndpoints
  : get:
      tags:
      - Private Endpoints
      description: Lists the private endpoints in the cluster.
      operationId: PrivateEndpoints_ListByCluster
      x-ms-examples:
        Get the private endpoints in a cluster:
          $ref: ./examples/PrivateEndpoint_ListByCluster.json
      parameters:
      - $ref: ./common/v1/definitions.json#/parameters/SubscriptionIdParameter
      - $ref: ./common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ./clusters.json#/parameters/ClusterNameParameter
      - $ref: ./common/v1/definitions.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Successfully listed the private endpoints under the specified cluster.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointListResult'
        default:
          description: Error.
          content:
            application/json:
              schema:
                $ref: ./common/v1/definitions.json#/definitions/Error
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Private endpoints list by cluster
      x-summary-source: derived
components:
  schemas:
    PrivateEndpoint:
      type: object
      description: Complete information about the private endpoint.
      allOf:
      - $ref: ./common/v1/definitions.json#/definitions/ProxyResource
      properties:
        properties:
          x-ms-client-flatten: true
          description: The properties associated with a private endpoint.
          $ref: '#/components/schemas/PrivateEndpointProperties'
        etag:
          description: Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.
          type: string
          readOnly: true
    PrivateLinkServiceConnection:
      type: object
      description: A grouping of information about the connection to the remote resource.
      properties:
        properties:
          x-ms-client-flatten: true
          description: Bag of properties defining a privatelinkServiceConnection.
          $ref: '#/components/schemas/PrivateLinkServiceConnectionProperties'
    PrivateLinkServiceConnectionProperties:
      type: object
      description: Bag of properties defining a privatelinkServiceConnection.
      properties:
        privateLinkServiceId:
          description: The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.
          type: string
        groupIds:
          description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
          type: array
          items:
            type: string
        requestMessage:
          description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
          type: string
          readOnly: true
        privateLinkServiceConnectionState:
          description: A collection of read-only information about the state of the connection to the private remote resource.
          $ref: '#/components/schemas/PrivateLinkConnectionState'
    PrivateLinkConnectionState:
      type: object
      description: A collection of read-only information about the state of the connection to the private remote resource.
      properties:
        status:
          description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service.
          type: string
          readOnly: true
        description:
          description: The reason for approval/rejection of the connection.
          type: string
          readOnly: true
        actionsRequired:
          description: A message indicating if changes on the service provider require any updates on the consumer.
          type: string
          readOnly: true
    PrivateEndpointProperties:
      type: object
      description: The properties associated with a private endpoint.
      properties:
        createdDate:
          description: The date when this private endpoint was created.
          type: string
          readOnly: true
        manualPrivateLinkServiceConnections:
          description: A list of connections to the remote resource. Immutable after it is set.
          type: array
          items:
            $ref: '#/components/schemas/PrivateLinkServiceConnection'
          x-ms-identifiers:
          - /properties/privateLinkServiceId
    PrivateEndpointListResult:
      type: object
      description: A list of private endpoints.
      properties:
        value:
          description: A list of private endpoints.
          type: array
          items:
            $ref: '#/components/schemas/PrivateEndpoint'
          readOnly: true
        nextLink:
          description: The URL to fetch the next set of private endpoints.
          type: string
          readOnly: true
  parameters:
    PrivateEndpointNameParameter:
      name: privateEndpointName
      in: path
      required: true
      description: The name of the private endpoint.
      x-ms-parameter-location: method
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow