Microsoft.DeviceUpdate accounts/privateEndpointConnectionProxies

Bicep resource definition

The accounts/privateEndpointConnectionProxies resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies@2023-07-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {}
  remotePrivateEndpoint: {
    connectionDetails: [
      {}
    ]
    id: 'string'
    immutableResourceId: 'string'
    immutableSubscriptionId: 'string'
    location: 'string'
    manualPrivateLinkServiceConnections: [
      {
        groupIds: [
          'string'
        ]
        name: 'string'
        requestMessage: 'string'
      }
    ]
    privateLinkServiceConnections: [
      {
        groupIds: [
          'string'
        ]
        name: 'string'
        requestMessage: 'string'
      }
    ]
    privateLinkServiceProxies: [
      {
        groupConnectivityInformation: [
          {
            customerVisibleFqdns: [
              'string'
            ]
            privateLinkServiceArmRegion: 'string'
            redirectMapId: 'string'
          }
        ]
        id: 'string'
        remotePrivateEndpointConnection: {}
        remotePrivateLinkServiceConnectionState: {
          actionsRequired: 'string'
          description: 'string'
          status: 'string'
        }
      }
    ]
    vnetTrafficTag: 'string'
  }
  status: 'string'
}

Property Values

Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: accounts
properties Private endpoint connection proxy object property bag. PrivateEndpointConnectionProxyProperties
remotePrivateEndpoint Remote private endpoint details. RemotePrivateEndpoint
status Operation status. string

ConnectionDetails

Name Description Value

GroupConnectivityInformation

Name Description Value
customerVisibleFqdns List of customer visible FQDNs. string[]
privateLinkServiceArmRegion PrivateLinkService ARM region. string
redirectMapId Redirect map ID. string

PrivateEndpointConnectionProxyProperties

Name Description Value

PrivateLinkServiceConnection

Name Description Value
groupIds List of group IDs. string[]
name Private link service connection name. string
requestMessage Request message. string

PrivateLinkServiceConnectionState

Name Description Value
actionsRequired A message indicating if changes on the service provider require any updates on the consumer. string
description The reason for approval/rejection of the connection. string
status Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. 'Approved'
'Pending'
'Rejected'

PrivateLinkServiceProxy

Name Description Value
groupConnectivityInformation Group connectivity information. GroupConnectivityInformation[]
id NRP resource ID. string
remotePrivateEndpointConnection Remote private endpoint connection details. PrivateLinkServiceProxyRemotePrivateEndpointConnection
remotePrivateLinkServiceConnectionState Remote private link service connection state PrivateLinkServiceConnectionState

PrivateLinkServiceProxyRemotePrivateEndpointConnection

Name Description Value

RemotePrivateEndpoint

Name Description Value
connectionDetails List of connection details. ConnectionDetails[]
id Remote endpoint resource ID. string
immutableResourceId Original resource ID needed by Microsoft.Network. string
immutableSubscriptionId Original subscription ID needed by Microsoft.Network. string
location ARM location of the remote private endpoint. string
manualPrivateLinkServiceConnections List of private link service connections that need manual approval. PrivateLinkServiceConnection[]
privateLinkServiceConnections List of automatically approved private link service connections. PrivateLinkServiceConnection[]
privateLinkServiceProxies List of private link service proxies. PrivateLinkServiceProxy[]
vnetTrafficTag Virtual network traffic tag. string

ARM template resource definition

The accounts/privateEndpointConnectionProxies resource type can be deployed with operations that target:

Usage Examples

Resource format

To create a Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies resource, add the following JSON to your template.

{
  "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies",
  "apiVersion": "2023-07-01",
  "name": "string",
  "properties": {
  },
  "remotePrivateEndpoint": {
    "connectionDetails": [
      {
      }
    ],
    "id": "string",
    "immutableResourceId": "string",
    "immutableSubscriptionId": "string",
    "location": "string",
    "manualPrivateLinkServiceConnections": [
      {
        "groupIds": [ "string" ],
        "name": "string",
        "requestMessage": "string"
      }
    ],
    "privateLinkServiceConnections": [
      {
        "groupIds": [ "string" ],
        "name": "string",
        "requestMessage": "string"
      }
    ],
    "privateLinkServiceProxies": [
      {
        "groupConnectivityInformation": [
          {
            "customerVisibleFqdns": [ "string" ],
            "privateLinkServiceArmRegion": "string",
            "redirectMapId": "string"
          }
        ],
        "id": "string",
        "remotePrivateEndpointConnection": {
        },
        "remotePrivateLinkServiceConnectionState": {
          "actionsRequired": "string",
          "description": "string",
          "status": "string"
        }
      }
    ],
    "vnetTrafficTag": "string"
  },
  "status": "string"
}

Property Values

Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies

Name Description Value
apiVersion The api version '2023-07-01'
name The resource name string (required)
properties Private endpoint connection proxy object property bag. PrivateEndpointConnectionProxyProperties
remotePrivateEndpoint Remote private endpoint details. RemotePrivateEndpoint
status Operation status. string
type The resource type 'Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies'

ConnectionDetails

Name Description Value

GroupConnectivityInformation

Name Description Value
customerVisibleFqdns List of customer visible FQDNs. string[]
privateLinkServiceArmRegion PrivateLinkService ARM region. string
redirectMapId Redirect map ID. string

PrivateEndpointConnectionProxyProperties

Name Description Value

PrivateLinkServiceConnection

Name Description Value
groupIds List of group IDs. string[]
name Private link service connection name. string
requestMessage Request message. string

PrivateLinkServiceConnectionState

Name Description Value
actionsRequired A message indicating if changes on the service provider require any updates on the consumer. string
description The reason for approval/rejection of the connection. string
status Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. 'Approved'
'Pending'
'Rejected'

PrivateLinkServiceProxy

Name Description Value
groupConnectivityInformation Group connectivity information. GroupConnectivityInformation[]
id NRP resource ID. string
remotePrivateEndpointConnection Remote private endpoint connection details. PrivateLinkServiceProxyRemotePrivateEndpointConnection
remotePrivateLinkServiceConnectionState Remote private link service connection state PrivateLinkServiceConnectionState

PrivateLinkServiceProxyRemotePrivateEndpointConnection

Name Description Value

RemotePrivateEndpoint

Name Description Value
connectionDetails List of connection details. ConnectionDetails[]
id Remote endpoint resource ID. string
immutableResourceId Original resource ID needed by Microsoft.Network. string
immutableSubscriptionId Original subscription ID needed by Microsoft.Network. string
location ARM location of the remote private endpoint. string
manualPrivateLinkServiceConnections List of private link service connections that need manual approval. PrivateLinkServiceConnection[]
privateLinkServiceConnections List of automatically approved private link service connections. PrivateLinkServiceConnection[]
privateLinkServiceProxies List of private link service proxies. PrivateLinkServiceProxy[]
vnetTrafficTag Virtual network traffic tag. string

Terraform (AzAPI provider) resource definition

The accounts/privateEndpointConnectionProxies resource type can be deployed with operations that target:

  • Resource groups For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies@2023-07-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
    }
    remotePrivateEndpoint = {
      connectionDetails = [
        {
        }
      ]
      id = "string"
      immutableResourceId = "string"
      immutableSubscriptionId = "string"
      location = "string"
      manualPrivateLinkServiceConnections = [
        {
          groupIds = [
            "string"
          ]
          name = "string"
          requestMessage = "string"
        }
      ]
      privateLinkServiceConnections = [
        {
          groupIds = [
            "string"
          ]
          name = "string"
          requestMessage = "string"
        }
      ]
      privateLinkServiceProxies = [
        {
          groupConnectivityInformation = [
            {
              customerVisibleFqdns = [
                "string"
              ]
              privateLinkServiceArmRegion = "string"
              redirectMapId = "string"
            }
          ]
          id = "string"
          remotePrivateEndpointConnection = {
          }
          remotePrivateLinkServiceConnectionState = {
            actionsRequired = "string"
            description = "string"
            status = "string"
          }
        }
      ]
      vnetTrafficTag = "string"
    }
    status = "string"
  }
}

Property Values

Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: accounts
properties Private endpoint connection proxy object property bag. PrivateEndpointConnectionProxyProperties
remotePrivateEndpoint Remote private endpoint details. RemotePrivateEndpoint
status Operation status. string
type The resource type "Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies@2023-07-01"

ConnectionDetails

Name Description Value

GroupConnectivityInformation

Name Description Value
customerVisibleFqdns List of customer visible FQDNs. string[]
privateLinkServiceArmRegion PrivateLinkService ARM region. string
redirectMapId Redirect map ID. string

PrivateEndpointConnectionProxyProperties

Name Description Value

PrivateLinkServiceConnection

Name Description Value
groupIds List of group IDs. string[]
name Private link service connection name. string
requestMessage Request message. string

PrivateLinkServiceConnectionState

Name Description Value
actionsRequired A message indicating if changes on the service provider require any updates on the consumer. string
description The reason for approval/rejection of the connection. string
status Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. 'Approved'
'Pending'
'Rejected'

PrivateLinkServiceProxy

Name Description Value
groupConnectivityInformation Group connectivity information. GroupConnectivityInformation[]
id NRP resource ID. string
remotePrivateEndpointConnection Remote private endpoint connection details. PrivateLinkServiceProxyRemotePrivateEndpointConnection
remotePrivateLinkServiceConnectionState Remote private link service connection state PrivateLinkServiceConnectionState

PrivateLinkServiceProxyRemotePrivateEndpointConnection

Name Description Value

RemotePrivateEndpoint

Name Description Value
connectionDetails List of connection details. ConnectionDetails[]
id Remote endpoint resource ID. string
immutableResourceId Original resource ID needed by Microsoft.Network. string
immutableSubscriptionId Original subscription ID needed by Microsoft.Network. string
location ARM location of the remote private endpoint. string
manualPrivateLinkServiceConnections List of private link service connections that need manual approval. PrivateLinkServiceConnection[]
privateLinkServiceConnections List of automatically approved private link service connections. PrivateLinkServiceConnection[]
privateLinkServiceProxies List of private link service proxies. PrivateLinkServiceProxy[]
vnetTrafficTag Virtual network traffic tag. string