Web Apps - Approve Or Reject Private Endpoint Connection Slot
Description for Approves or rejects a private endpoint connection
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-04-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
name
|
path | True |
string |
Name of the site. |
private
|
path | True |
string |
|
resource
|
path | True |
string |
Name of the resource group to which the resource belongs. Regex pattern: |
slot
|
path | True |
string |
|
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 |
Request Body
Name | Type | Description |
---|---|---|
kind |
string |
Kind of resource. |
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 |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. |
|
202 Accepted |
Asynchronous operation in progress. |
|
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 |
Examples
Approves or rejects a private endpoint connection for a site.
Sample request
PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/privateEndpointConnections/connection?api-version=2024-04-01
{
"properties": {
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by admin.",
"actionsRequired": ""
}
}
}
Sample response
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/privateEndpointConnections/connection",
"name": "connection",
"type": "Microsoft.Web/sites/privateEndpointConnections",
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by admin.",
"actionsRequired": ""
}
}
}
azure-asyncoperation: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/privateEndpointConnections/connection",
"name": "connection",
"type": "Microsoft.Web/sites/privateEndpointConnections",
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by admin.",
"actionsRequired": ""
}
}
}
Definitions
Name | Description |
---|---|
Arm |
A wrapper for an ARM resource id |
Default |
App Service error response. |
Details | |
Error |
Error model. |
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. |
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. |