Private Endpoint Connections - Create Or Update
Approve or reject a private endpoint connection with a given name.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2019-10-17-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
private
|
path | True |
string |
The name of the private endpoint connection. |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
scope
|
path | True |
string |
The name of the Azure Monitor PrivateLinkScope resource. |
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Request Body
Name | Type | Description |
---|---|---|
properties.privateEndpoint |
Private endpoint which the connection belongs to. |
|
properties.privateLinkServiceConnectionState |
Connection state of the private endpoint connection. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Successfully approved or rejected private endpoint connection. |
|
202 Accepted |
Accepted |
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
Approve or reject a private endpoint connection with a given name.
Sample Request
PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name?api-version=2019-10-17-preview
{
"properties": {
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by johndoe@contoso.com"
}
}
}
Sample Response
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name",
"name": "private-endpoint-connection-name",
"type": "Microsoft.Insights/privateLinkScopes/privateEndpointConnections",
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by johndoe@contoso.com",
"actionsRequired": "None"
}
}
}
Definitions
Name | Description |
---|---|
Private |
A private endpoint connection |
Private |
Private endpoint which the connection belongs to. |
Private |
State of the private endpoint connection. |
PrivateEndpointConnection
A private endpoint connection
Name | Type | Description |
---|---|---|
id |
string |
Azure resource Id |
name |
string |
Azure resource name |
properties.privateEndpoint |
Private endpoint which the connection belongs to. |
|
properties.privateLinkServiceConnectionState |
Connection state of the private endpoint connection. |
|
properties.provisioningState |
string |
State of the private endpoint connection. |
type |
string |
Azure resource type |
PrivateEndpointProperty
Private endpoint which the connection belongs to.
Name | Type | Description |
---|---|---|
id |
string |
Resource id of the private endpoint. |
PrivateLinkServiceConnectionStateProperty
State of the private endpoint connection.
Name | Type | Description |
---|---|---|
actionsRequired |
string |
The actions required for private link service connection. |
description |
string |
The private link service connection description. |
status |
string |
The private link service connection status. |