Web Apps - Get Private Link Resources

Service:: App Service

API Version:: 2025-05-01

Description for Gets the private link resources

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

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the app.
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	PrivateLinkResourcesWrapper	Azure operation completed successfully.
Other Status Codes	DefaultErrorResponse	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

Get private link resources of a site

Sample request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateLinkResources?api-version=2025-05-01


/**
 * Samples for WebApps GetPrivateLinkResources.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/GetSitePrivateLinkResources_WebApps.json
     */
    /**
     * Sample code: Get private link resources of a site.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void getPrivateLinkResourcesOfASite(com.azure.resourcemanager.appservice.AppServiceManager manager) {
        manager.serviceClient().getWebApps().getPrivateLinkResourcesWithResponse("rg", "testSite",
            com.azure.core.util.Context.NONE);
    }
}

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

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v6"
)

// Generated from example definition: 2025-05-01/GetSitePrivateLinkResources_WebApps.json
func ExampleWebAppsClient_GetPrivateLinkResources() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebAppsClient().GetPrivateLinkResources(ctx, "rg", "testSite", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armappservice.WebAppsClientGetPrivateLinkResourcesResponse{
	// 	PrivateLinkResourcesWrapper: &armappservice.PrivateLinkResourcesWrapper{
	// 		Value: []*armappservice.PrivateLinkResource{
	// 			{
	// 				Name: to.Ptr("site"),
	// 				Type: to.Ptr("Microsoft.Web/sites/privateLinkResources"),
	// 				ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateLinkResources/site"),
	// 				Properties: &armappservice.PrivateLinkResourceProperties{
	// 					GroupID: to.Ptr("sites"),
	// 					RequiredMembers: []*string{
	// 						to.Ptr("sites"),
	// 					},
	// 					RequiredZoneNames: []*string{
	// 						to.Ptr("privatelink.testsite.azurewebsites.net"),
	// 					},
	// 				},
	// 			},
	// 		},
	// 	},
	// }
}

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": "site",
      "type": "Microsoft.Web/sites/privateLinkResources",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateLinkResources/site",
      "properties": {
        "groupId": "sites",
        "requiredMembers": [
          "sites"
        ],
        "requiredZoneNames": [
          "privatelink.testsite.azurewebsites.net"
        ]
      }
    }
  ]
}

Definitions

Name	Description
DefaultErrorResponse	App Service error response.
DefaultErrorResponseError	Error model.
DefaultErrorResponseErrorDetailsItem	Detailed errors.
PrivateLinkResource	A private link resource
PrivateLinkResourceProperties	Properties of a private link resource
PrivateLinkResourcesWrapper	Wrapper for a collection of private link resources

DefaultErrorResponse

Object

App Service error response.

Name	Type	Description
error	DefaultErrorResponseError	Error model.

DefaultErrorResponseError

Object

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	DefaultErrorResponseErrorDetailsItem[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

DefaultErrorResponseErrorDetailsItem

Object

Detailed errors.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

PrivateLinkResource

Object

A private link resource

Name	Type	Description
id	string
name	string	Name of a private link resource
properties	PrivateLinkResourceProperties	Properties of a private link resource
type	string

PrivateLinkResourceProperties

Object

Properties of a private link resource

Name	Type	Description
groupId	string	GroupId of a private link resource
requiredMembers	string[]	RequiredMembers of a private link resource
requiredZoneNames	string[]	RequiredZoneNames of a private link resource

PrivateLinkResourcesWrapper

Object

Wrapper for a collection of private link resources

Name	Type	Description
value	PrivateLinkResource[]	A private link resource

Share via

Web Apps - Get Private Link Resources

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get private link resources of a site

Sample request

Sample response

Definitions

DefaultErrorResponse

DefaultErrorResponseError

DefaultErrorResponseErrorDetailsItem

PrivateLinkResource

PrivateLinkResourceProperties

PrivateLinkResourcesWrapper