Application Gateway Private Link Resources - List

Service:

Application Gateway

API Version:

2025-05-01

Lists all private link resources on an application gateway.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateLinkResources?api-version=2025-05-01

URI Parameters

Name	In	Required	Type	Description
applicationGatewayName	path	True	string	The name of the application gateway.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ApplicationGatewayPrivateLinkResourceListResult	Azure operation completed successfully.
Other Status Codes	Common.CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Lists all private link resources on application gateway

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkResources?api-version=2025-05-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python application_gateway_private_link_resource_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.application_gateway_private_link_resources.list(
        resource_group_name="rg1",
        application_gateway_name="appgw",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-05-01/ApplicationGatewayPrivateLinkResourceList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Lists all private link resources on an application gateway.
 *
 * @summary Lists all private link resources on an application gateway.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/ApplicationGatewayPrivateLinkResourceList.json
 */
async function listsAllPrivateLinkResourcesOnApplicationGateway() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const applicationGatewayName = "appgw";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.applicationGatewayPrivateLinkResources.list(
    resourceGroupName,
    applicationGatewayName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "name": "privateLink1",
      "type": "Microsoft.Network/applicationGateways/privateLinkResources",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkResources/privateLink1",
      "properties": {
        "groupId": "privateLink1",
        "requiredMembers": [
          "privateLink1"
        ],
        "requiredZoneNames": []
      }
    }
  ]
}

Definitions

Name	Description
ApplicationGatewayPrivateLinkResource	PrivateLink Resource of an application gateway.
ApplicationGatewayPrivateLinkResourceListResult	The response of a ApplicationGatewayPrivateLinkResource list operation.
Common.CloudError	An error response from the service.
Common.CloudErrorBody	An error response from the service.

ApplicationGatewayPrivateLinkResource

Object

PrivateLink Resource of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the private link resource that is unique within an Application Gateway.
properties.groupId	string	Group identifier of private link resource.
properties.requiredMembers	string[]	Required member names of private link resource.
properties.requiredZoneNames	string[]	Required DNS zone names of the the private link resource.
type	string	Type of the resource.

ApplicationGatewayPrivateLinkResourceListResult

Object

The response of a ApplicationGatewayPrivateLinkResource list operation.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	ApplicationGatewayPrivateLinkResource[]	The ApplicationGatewayPrivateLinkResource items on this page

Common.CloudError

Object

An error response from the service.

Name	Type	Description
error	Common.CloudErrorBody	Cloud error body.

Common.CloudErrorBody

Object

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	Common.CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.