private_endpoint_connection_proxies

Creates, updates, deletes, gets or lists a private_endpoint_connection_proxies resource.

Overview

Name	private_endpoint_connection_proxies
Type	Resource
Id	azure.device_update.private_endpoint_connection_proxies

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
eTag	string	ETag from NRP.
properties	object	Private endpoint connection proxy object property bag.
remotePrivateEndpoint	object	Remote private endpoint details.
status	string	Operation status.

list_by_account

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
eTag	string	ETag from NRP.
properties	object	Private endpoint connection proxy object property bag.
remotePrivateEndpoint	object	Remote private endpoint details.
status	string	Operation status.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, privateEndpointConnectionProxyId		(INTERNAL - DO NOT USE) Get the specified private endpoint connection proxy associated with the device update account.
list_by_account	select	subscriptionId, resourceGroupName, accountName		(INTERNAL - DO NOT USE) List all private endpoint connection proxies in a device update account.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, privateEndpointConnectionProxyId		(INTERNAL - DO NOT USE) Creates or updates the specified private endpoint connection proxy resource associated with the device update account.
delete	delete	subscriptionId, resourceGroupName, accountName, privateEndpointConnectionProxyId		(INTERNAL - DO NOT USE) Deletes the specified private endpoint connection proxy associated with the device update account.
validate	exec	subscriptionId, resourceGroupName, accountName, privateEndpointConnectionProxyId		(INTERNAL - DO NOT USE) Validates a private endpoint connection proxy object.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accountName	string	Account name.
privateEndpointConnectionProxyId	string	The ID of the private endpoint connection proxy object.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

(INTERNAL - DO NOT USE) Get the specified private endpoint connection proxy associated with the device update account.

SELECT
eTag,
properties,
remotePrivateEndpoint,
status
FROM azure.device_update.private_endpoint_connection_proxies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND privateEndpointConnectionProxyId = '{{ privateEndpointConnectionProxyId }}' -- required
;

list_by_account

(INTERNAL - DO NOT USE) List all private endpoint connection proxies in a device update account.

SELECT
eTag,
properties,
remotePrivateEndpoint,
status
FROM azure.device_update.private_endpoint_connection_proxies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;

INSERT examples

create_or_update

(INTERNAL - DO NOT USE) Creates or updates the specified private endpoint connection proxy resource associated with the device update account.

INSERT INTO azure.device_update.private_endpoint_connection_proxies (
data__remotePrivateEndpoint,
data__status,
data__properties,
subscriptionId,
resourceGroupName,
accountName,
privateEndpointConnectionProxyId
)
SELECT 
'{{ remotePrivateEndpoint }}',
'{{ status }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ privateEndpointConnectionProxyId }}'
RETURNING
eTag,
properties,
remotePrivateEndpoint,
status
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connection_proxies
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the private_endpoint_connection_proxies resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_endpoint_connection_proxies resource.
    - name: accountName
      value: string
      description: Required parameter for the private_endpoint_connection_proxies resource.
    - name: privateEndpointConnectionProxyId
      value: string
      description: Required parameter for the private_endpoint_connection_proxies resource.
    - name: remotePrivateEndpoint
      value: object
      description: |
        Remote private endpoint details.
    - name: status
      value: string
      description: |
        Operation status.
    - name: properties
      value: object
      description: |
        Private endpoint connection proxy object property bag.

DELETE examples

delete

(INTERNAL - DO NOT USE) Deletes the specified private endpoint connection proxy associated with the device update account.

DELETE FROM azure.device_update.private_endpoint_connection_proxies
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND privateEndpointConnectionProxyId = '{{ privateEndpointConnectionProxyId }}' --required
;

Lifecycle Methods

validate

(INTERNAL - DO NOT USE) Validates a private endpoint connection proxy object.

EXEC azure.device_update.private_endpoint_connection_proxies.validate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@privateEndpointConnectionProxyId='{{ privateEndpointConnectionProxyId }}' --required 
@@json=
'{
"remotePrivateEndpoint": "{{ remotePrivateEndpoint }}", 
"status": "{{ status }}", 
"properties": "{{ properties }}"
}'
;