Azure Application Gateway Application Gateway Private Link Resources 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: ApplicationGatewayPrivateLinkResources
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateLinkResources
  : get:
      operationId: ApplicationGatewayPrivateLinkResources_List
      tags:
      - ApplicationGatewayPrivateLinkResources
      description: Lists all private link resources 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/ApplicationGatewayPrivateLinkResourceListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Application gateway private link resources list
      x-summary-source: derived
components:
  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
  schemas:
    ApplicationGatewayPrivateLinkResource:
      type: object
      description: PrivateLink Resource of an application gateway.
      properties:
        properties:
          $ref: '#/components/schemas/ApplicationGatewayPrivateLinkResourceProperties'
          description: Properties of the application gateway private link resource.
          x-ms-client-flatten: true
        name:
          type: string
          description: Name of the private link resource that is unique within an Application Gateway.
        etag:
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
          readOnly: true
        type:
          type: string
          description: Type of the resource.
          readOnly: true
      allOf:
      - $ref: '#/components/schemas/SubResource'
    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
    ApplicationGatewayPrivateLinkResourceListResult:
      type: object
      description: The response of a ApplicationGatewayPrivateLinkResource list operation.
      properties:
        value:
          type: array
          description: The ApplicationGatewayPrivateLinkResource items on this page
          items:
            $ref: '#/components/schemas/ApplicationGatewayPrivateLinkResource'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ApplicationGatewayPrivateLinkResourceProperties:
      type: object
      description: Properties of a private link resource.
      properties:
        groupId:
          type: string
          description: Group identifier of private link resource.
          readOnly: true
        requiredMembers:
          type: array
          description: Required member names of private link resource.
          items:
            type: string
          readOnly: true
        requiredZoneNames:
          type: array
          description: Required DNS zone names of the the private link resource.
          items:
            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.