Web Apps - Get Private Endpoint Connection

Service:: App Service

API Version:: 2025-05-01

Description for Gets a private endpoint connection

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

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the site.
privateEndpointConnectionName	path	True	string	Name of the private endpoint connection.
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	RemotePrivateEndpointConnectionARMResource	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 a private endpoint connection for a site.

Sample request

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


/**
 * Samples for WebApps GetPrivateEndpointConnection.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/GetSitePrivateEndpointConnection.json
     */
    /**
     * Sample code: Get a private endpoint connection for a site.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void
        getAPrivateEndpointConnectionForASite(com.azure.resourcemanager.appservice.AppServiceManager manager) {
        manager.serviceClient().getWebApps().getPrivateEndpointConnectionWithResponse("rg", "testSite", "connection",
            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/GetSitePrivateEndpointConnection.json
func ExampleWebAppsClient_GetPrivateEndpointConnection() {
	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().GetPrivateEndpointConnection(ctx, "rg", "testSite", "connection", 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.WebAppsClientGetPrivateEndpointConnectionResponse{
	// 	RemotePrivateEndpointConnectionARMResource: &armappservice.RemotePrivateEndpointConnectionARMResource{
	// 		ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateEndpointConnections/connection"),
	// 		Properties: &armappservice.RemotePrivateEndpointConnectionARMResourceProperties{
	// 			PrivateEndpoint: &armappservice.ArmIDWrapper{
	// 				ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"),
	// 			},
	// 			PrivateLinkServiceConnectionState: &armappservice.PrivateLinkConnectionState{
	// 				Description: to.Ptr("Approved by admin."),
	// 				ActionsRequired: to.Ptr(""),
	// 				Status: to.Ptr("Approved"),
	// 			},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 		},
	// 	},
	// }
}

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

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateEndpointConnections/connection",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "description": "Approved by admin.",
      "actionsRequired": "",
      "status": "Approved"
    },
    "provisioningState": "Succeeded"
  }
}

Definitions

Name	Description
ArmIdWrapper	A wrapper for an ARM resource id
createdByType	The type of identity that created the resource.
DefaultErrorResponse	App Service error response.
DefaultErrorResponseError	Error model.
DefaultErrorResponseErrorDetailsItem	Detailed errors.
PrivateLinkConnectionState	The state of a private link connection
RemotePrivateEndpointConnectionARMResource	Remote Private Endpoint Connection ARM resource.
systemData	Metadata pertaining to creation and last modification of the resource.

ArmIdWrapper

Object

A wrapper for an ARM resource id

Name	Type	Description
id	string

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

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.

PrivateLinkConnectionState

Object

The state of a private link connection

Name	Type	Description
actionsRequired	string	ActionsRequired for a private link connection
description	string	Description of a private link connection
status	string	Status of a private link connection

RemotePrivateEndpointConnectionARMResource

Object

Remote Private Endpoint Connection ARM resource.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Kind of resource.
name	string	The name of the resource
properties.ipAddresses	string[]	Private IPAddresses mapped to the remote private endpoint
properties.privateEndpoint	ArmIdWrapper	PrivateEndpoint of a remote private endpoint connection
properties.privateLinkServiceConnectionState	PrivateLinkConnectionState	The state of a private link connection
properties.provisioningState	string
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Web Apps - Get Private Endpoint Connection

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get a private endpoint connection for a site.

Sample request

Sample response

Definitions

ArmIdWrapper

createdByType

DefaultErrorResponse

DefaultErrorResponseError

DefaultErrorResponseErrorDetailsItem

PrivateLinkConnectionState

RemotePrivateEndpointConnectionARMResource

systemData