Web Apps - Get Private Endpoint Connection List
Description for Gets the list of private endpoint connections associated with a site
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections?api-version=2025-03-01URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
name
|
path | True |
string |
Name of the site. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$ |
Name of the resource group to which the resource belongs. |
|
subscription
|
path | True |
string |
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
|
api-version
|
query | True |
string |
API Version |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
App Service 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 |
Definitions
| Name | Description |
|---|---|
|
Arm |
A wrapper for an ARM resource id |
|
Default |
App Service error response. |
| Details | |
| Error |
Error model. |
|
Private |
|
|
Private |
The state of a private link connection |
|
Remote |
Remote Private Endpoint Connection ARM resource. |
ArmIdWrapper
A wrapper for an ARM resource id
| Name | Type | Description |
|---|---|---|
| id |
string |
DefaultErrorResponse
App Service error response.
| Name | Type | Description |
|---|---|---|
| error |
Error model. |
Details
| 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. |
Error
Error model.
| Name | Type | Description |
|---|---|---|
| code |
string |
Standardized string to programmatically identify the error. |
| details |
Details[] |
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. |
PrivateEndpointConnectionCollection
| Name | Type | Description |
|---|---|---|
| nextLink |
string |
Link to next page of resources. |
| value |
Collection of resources. |
PrivateLinkConnectionState
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
Remote Private Endpoint Connection ARM resource.
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id. |
| kind |
string |
Kind of resource. |
| name |
string |
Resource Name. |
| properties.ipAddresses |
string[] |
Private IPAddresses mapped to the remote private endpoint |
| properties.privateEndpoint |
PrivateEndpoint of a remote private endpoint connection |
|
| properties.privateLinkServiceConnectionState |
The state of a private link connection |
|
| properties.provisioningState |
string |
|
| type |
string |
Resource type. |