Private Endpoint Connection Proxies - Create Or Update
(INTERNAL - DO NOT USE) Creates or updates the specified private endpoint connection proxy resource associated with the device update account.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnectionProxies/{privateEndpointConnectionProxyId}?api-version=2023-07-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
path | True |
string minLength: 3maxLength: 24 pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ |
Account name. |
private
|
path | True |
string |
The ID of the private endpoint connection proxy object. |
resource
|
path | True |
string |
The resource group name. |
subscription
|
path | True |
string |
The Azure subscription ID. |
api-version
|
query | True |
string |
ADU schema API version. |
Request Body
Name | Type | Description |
---|---|---|
remotePrivateEndpoint |
Remote private endpoint details. |
|
status |
string |
Operation status. |
Responses
Name | Type | Description |
---|---|---|
201 Created |
The request was successful; the operation will complete asynchronously. |
|
Other Status Codes |
Error response describing the reason for operation failure. |
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
PrivateEndpointConnectionProxyCreateOrUpdate
Sample request
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnectionProxies/peexample01?api-version=2023-07-01
{
"remotePrivateEndpoint": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{peName}",
"location": "westus2",
"immutableSubscriptionId": "00000000-0000-0000-0000-000000000000",
"immutableResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{peName}",
"manualPrivateLinkServiceConnections": [
{
"name": "{privateEndpointConnectionProxyId}",
"groupIds": [
"DeviceUpdate"
],
"requestMessage": "Please approve my connection, thanks."
}
],
"privateLinkServiceProxies": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{privateEndpointConnectionProxyId}/privateLinkServiceProxies/{privateEndpointConnectionProxyId}",
"groupConnectivityInformation": []
}
]
}
}
Sample response
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnectionProxies/peexample01",
"name": "peexample01",
"type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies",
"remotePrivateEndpoint": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{peName}",
"location": "westus2",
"immutableSubscriptionId": "00000000-0000-0000-0000-000000000000",
"immutableResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{peName}",
"manualPrivateLinkServiceConnections": [
{
"name": "{plsConnectionName}",
"groupIds": [
"DeviceUpdate"
],
"requestMessage": "Please approve my connection, thanks."
}
],
"privateLinkServiceProxies": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{privateEndpointConnectionProxyId}/privateLinkServiceProxies/{privateEndpointConnectionProxyId}",
"groupConnectivityInformation": [
{
"groupId": "DeviceUpdate",
"memberName": "adu"
}
]
}
]
}
}
Definitions
Name | Description |
---|---|
Connection |
Private endpoint connection proxy object properties. |
created |
The type of identity that created the resource. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Group |
Group connectivity details. |
Private |
Private endpoint connection proxy details. |
Private |
The current provisioning state. |
Private |
The private endpoint connection status. |
Private |
Private link service connection details. |
Private |
A collection of information about the state of the connection between service consumer and provider. |
Private |
Private link service proxy details. |
Remote |
Remote private endpoint details. |
Remote |
Remote private endpoint connection details. |
system |
Metadata pertaining to creation and last modification of the resource. |
ConnectionDetails
Private endpoint connection proxy object properties.
Name | Type | Description |
---|---|---|
groupId |
string |
Group ID. |
id |
string |
Connection details ID. |
linkIdentifier |
string |
Link ID. |
memberName |
string |
Member name. |
privateIpAddress |
string |
Private IP address. |
createdByType
The type of identity that created the resource.
Value | Description |
---|---|
User | |
Application | |
ManagedIdentity | |
Key |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
GroupConnectivityInformation
Group connectivity details.
Name | Type | Description |
---|---|---|
customerVisibleFqdns |
string[] |
List of customer visible FQDNs. |
groupId |
string |
Group ID. |
internalFqdn |
string |
Internal FQDN. |
memberName |
string |
Member name. |
privateLinkServiceArmRegion |
string |
PrivateLinkService ARM region. |
redirectMapId |
string |
Redirect map ID. |
PrivateEndpointConnectionProxy
Private endpoint connection proxy details.
Name | Type | Description |
---|---|---|
eTag |
string |
ETag from NRP. |
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties.provisioningState |
The provisioning state of the private endpoint connection proxy resource. |
|
remotePrivateEndpoint |
Remote private endpoint details. |
|
status |
string |
Operation status. |
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" |
PrivateEndpointConnectionProxyProvisioningState
The current provisioning state.
Value | Description |
---|---|
Succeeded | |
Creating | |
Deleting | |
Failed |
PrivateEndpointServiceConnectionStatus
The private endpoint connection status.
Value | Description |
---|---|
Pending | |
Approved | |
Rejected |
PrivateLinkServiceConnection
Private link service connection details.
Name | Type | Description |
---|---|---|
groupIds |
string[] |
List of group IDs. |
name |
string |
Private link service connection name. |
requestMessage |
string |
Request message. |
PrivateLinkServiceConnectionState
A collection of information about the state of the connection between service consumer and provider.
Name | Type | Description |
---|---|---|
actionsRequired |
string |
A message indicating if changes on the service provider require any updates on the consumer. |
description |
string |
The reason for approval/rejection of the connection. |
status |
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. |
PrivateLinkServiceProxy
Private link service proxy details.
Name | Type | Description |
---|---|---|
groupConnectivityInformation |
Group connectivity information. |
|
id |
string |
NRP resource ID. |
remotePrivateEndpointConnection |
Remote private endpoint connection details. |
|
remotePrivateLinkServiceConnectionState |
Remote private link service connection state |
RemotePrivateEndpoint
Remote private endpoint details.
Name | Type | Description |
---|---|---|
connectionDetails |
List of connection details. |
|
id |
string |
Remote endpoint resource ID. |
immutableResourceId |
string |
Original resource ID needed by Microsoft.Network. |
immutableSubscriptionId |
string |
Original subscription ID needed by Microsoft.Network. |
location |
string |
ARM location of the remote private endpoint. |
manualPrivateLinkServiceConnections |
List of private link service connections that need manual approval. |
|
privateLinkServiceConnections |
List of automatically approved private link service connections. |
|
privateLinkServiceProxies |
List of private link service proxies. |
|
vnetTrafficTag |
string |
Virtual network traffic tag. |
RemotePrivateEndpointConnection
Remote private endpoint connection details.
Name | Type | Description |
---|---|---|
id |
string |
Remote private endpoint connection ID. |
systemData
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 |
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 |
The type of identity that last modified the resource. |