Azure Application Gateway Application Gateway Private Endpoint Connections API

openapi: 3.2.0
info:
  title: WebApplicationFirewallManagement Application Gateway…
  version: '2026-03-01'
  description: APIs to manage Microsoft Azure network resources.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ApplicationGatewayPrivateEndpointConnections
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections
  : get:
      operationId: ApplicationGatewayPrivateEndpointConnections_List
      tags:
      - ApplicationGatewayPrivateEndpointConnections
      description: Lists all private endpoint connections on an application gateway.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: applicationGatewayName
        in: path
        description: The name of the application gateway.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationGatewayPrivateEndpointConnectionListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Application gateway private endpoint connections list
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections/{connectionName}
  : get:
      operationId: ApplicationGatewayPrivateEndpointConnections_Get
      tags:
      - ApplicationGatewayPrivateEndpointConnections
      description: Gets the specified private endpoint connection on application gateway.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: applicationGatewayName
        in: path
        description: The name of the application gateway.
        required: true
        schema:
          type: string
      - name: connectionName
        in: path
        description: Name of the private endpoint connection on an application gateway.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationGatewayPrivateEndpointConnection'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      summary: Application gateway private endpoint connections get
      x-summary-source: derived
    put:
      operationId: ApplicationGatewayPrivateEndpointConnections_Update
      tags:
      - ApplicationGatewayPrivateEndpointConnections
      description: Updates the specified private endpoint connection on application gateway.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: applicationGatewayName
        in: path
        description: The name of the application gateway.
        required: true
        schema:
          type: string
      - name: connectionName
        in: path
        description: Name of the private endpoint connection on an application gateway.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'ApplicationGatewayPrivateEndpointConnection' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationGatewayPrivateEndpointConnection'
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
        final-state-schema: '#/definitions/ApplicationGatewayPrivateEndpointConnection'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationGatewayPrivateEndpointConnection'
        description: Parameters supplied to update application gateway private endpoint connection operation.
        required: true
      summary: Application gateway private endpoint connections update
      x-summary-source: derived
    delete:
      operationId: ApplicationGatewayPrivateEndpointConnections_Delete
      tags:
      - ApplicationGatewayPrivateEndpointConnections
      description: Deletes the specified private endpoint connection on application gateway.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: applicationGatewayName
        in: path
        description: The name of the application gateway.
        required: true
        schema:
          type: string
      - name: connectionName
        in: path
        description: Name of the private endpoint connection on an application gateway.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Application gateway private endpoint connections delete
      x-summary-source: derived
components:
  schemas:
    Resource:
      type: object
      description: Common resource representation.
      properties:
        id:
          type: string
          description: Resource ID.
        name:
          type: string
          description: Resource name.
          readOnly: true
        type:
          type: string
          description: Resource type.
          readOnly: true
        location:
          type: string
          description: Resource location.
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
      x-ms-azure-resource: true
    ProvisioningState:
      type: string
      description: Provisioning states of a resource.
      enum:
      - Failed
      - Succeeded
      - Canceled
      - Creating
      - Updating
      - Deleting
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
        values:
        - name: Failed
          value: Failed
          description: Failed
        - name: Succeeded
          value: Succeeded
          description: Succeeded
        - name: Canceled
          value: Canceled
          description: Canceled
        - name: Creating
          value: Creating
          description: Creating
        - name: Updating
          value: Updating
          description: Updating
        - name: Deleting
          value: Deleting
          description: Deleting
    ExtendedLocation:
      type: object
      description: ExtendedLocation complex type.
      properties:
        name:
          type: string
          description: The name of the extended location.
        type:
          $ref: '#/components/schemas/ExtendedLocationTypes'
          description: The type of the extended location.
    PrivateEndpoint:
      type: object
      description: Private endpoint resource.
      properties:
        properties:
          $ref: '#/components/schemas/PrivateEndpointProperties'
          description: Properties of the private endpoint.
          x-ms-client-flatten: true
        extendedLocation:
          $ref: '#/components/schemas/ExtendedLocation'
          description: The extended location of the load balancer.
        etag:
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
          readOnly: true
      allOf:
      - $ref: '#/components/schemas/Resource'
    SubResourceModel:
      type: object
      description: Reference to another subresource.
      properties:
        name:
          type: string
          description: Name of the resource.
        type:
          type: string
          description: Resource type.
          readOnly: true
      allOf:
      - $ref: '#/components/schemas/SubResource'
      x-ms-azure-resource: true
    ApplicationGatewayPrivateEndpointConnectionProperties:
      type: object
      description: Properties of Private Link Resource of an application gateway.
      properties:
        privateEndpoint:
          $ref: '#/components/schemas/PrivateEndpoint'
          description: The resource of private end point.
          readOnly: true
        privateLinkServiceConnectionState:
          $ref: '#/components/schemas/PrivateLinkServiceConnectionState'
          description: A collection of information about the state of the connection between service consumer and provider.
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: The provisioning state of the application gateway private endpoint connection resource.
          readOnly: true
        linkIdentifier:
          type: string
          description: The consumer link id.
          readOnly: true
    PrivateLinkServiceConnectionState:
      type: object
      description: A collection of information about the state of the connection between service consumer and provider.
      properties:
        status:
          type: string
          description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
        description:
          type: string
          description: The reason for approval/rejection of the connection.
        actionsRequired:
          type: string
          description: A message indicating if changes on the service provider require any updates on the consumer.
    ApplicationGatewayPrivateEndpointConnection:
      type: object
      description: Private Endpoint connection on an application gateway.
      properties:
        properties:
          $ref: '#/components/schemas/ApplicationGatewayPrivateEndpointConnectionProperties'
          description: Properties of the application gateway private endpoint connection.
          x-ms-client-flatten: true
        etag:
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
          readOnly: true
      allOf:
      - $ref: '#/components/schemas/SubResourceModel'
    SubResource:
      type: object
      description: Reference to another subresource.
      properties:
        id:
          type: string
          description: Resource ID.
    CloudError:
      type: object
      description: An error response from the service.
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody'
          description: Cloud error body.
      x-ms-external: true
    ApplicationGatewayPrivateEndpointConnectionListResult:
      type: object
      description: The response of a ApplicationGatewayPrivateEndpointConnection list operation.
      properties:
        value:
          type: array
          description: The ApplicationGatewayPrivateEndpointConnection items on this page
          items:
            $ref: '#/components/schemas/ApplicationGatewayPrivateEndpointConnection'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
  parameters:
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
  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.