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

Name	Datatype	Description
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.
eTag	string	ETag from NRP.
provisioningState	string	The provisioning state of the private endpoint connection proxy resource. Known values are: "Succeeded", "Creating", "Deleting", and "Failed".
remotePrivateEndpoint	object	Remote private endpoint details.
status	string	Operation status.
systemData	object	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".

list_by_account

Name	Datatype	Description
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.
eTag	string	ETag from NRP.
provisioningState	string	The provisioning state of the private endpoint connection proxy resource. Known values are: "Succeeded", "Creating", "Deleting", and "Failed".
remotePrivateEndpoint	object	Remote private endpoint details.
status	string	Operation status.
systemData	object	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, private_endpoint_connection_proxy_id, subscription_id		(INTERNAL - DO NOT USE) Get the specified private endpoint connection proxy associated with the device update account.
list_by_account	select	resource_group_name, account_name, subscription_id		(INTERNAL - DO NOT USE) List all private endpoint connection proxies in a device update account.
create_or_update	insert	resource_group_name, account_name, private_endpoint_connection_proxy_id, subscription_id		(INTERNAL - DO NOT USE) Creates or updates the specified private endpoint connection proxy resource associated with the device update account.
create_or_update	replace	resource_group_name, account_name, private_endpoint_connection_proxy_id, subscription_id		(INTERNAL - DO NOT USE) Creates or updates the specified private endpoint connection proxy resource associated with the device update account.
delete	delete	resource_group_name, account_name, private_endpoint_connection_proxy_id, subscription_id		(INTERNAL - DO NOT USE) Deletes the specified private endpoint connection proxy associated with the device update account.
validate	exec	resource_group_name, account_name, private_endpoint_connection_proxy_id, subscription_id		(INTERNAL - DO NOT USE) Validates a private endpoint connection proxy object.
update_private_endpoint_properties	exec	resource_group_name, account_name, private_endpoint_connection_proxy_id, subscription_id		(INTERNAL - DO NOT USE) Updates a private endpoint inside the 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
account_name	string	Account name. Required.
private_endpoint_connection_proxy_id	string	The ID of the private endpoint connection proxy object. Required.
resource_group_name	string	The resource group name. Required.
subscription_id	string

SELECT examples

get

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

SELECT
id,
name,
eTag,
provisioningState,
remotePrivateEndpoint,
status,
systemData,
type
FROM azure.device_update.private_endpoint_connection_proxies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND private_endpoint_connection_proxy_id = '{{ private_endpoint_connection_proxy_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_account

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

SELECT
id,
name,
eTag,
provisioningState,
remotePrivateEndpoint,
status,
systemData,
type
FROM azure.device_update.private_endpoint_connection_proxies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
remotePrivateEndpoint,
status,
resource_group_name,
account_name,
private_endpoint_connection_proxy_id,
subscription_id
)
SELECT 
'{{ remotePrivateEndpoint }}',
'{{ status }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ private_endpoint_connection_proxy_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
properties,
remotePrivateEndpoint,
status,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connection_proxies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_endpoint_connection_proxies resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the private_endpoint_connection_proxies resource.
  - name: private_endpoint_connection_proxy_id
    value: "{{ private_endpoint_connection_proxy_id }}"
    description: Required parameter for the private_endpoint_connection_proxies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_endpoint_connection_proxies resource.
  - name: remotePrivateEndpoint
    description: |
      Remote private endpoint details.
    value:
      id: "{{ id }}"
      location: "{{ location }}"
      immutableSubscriptionId: "{{ immutableSubscriptionId }}"
      immutableResourceId: "{{ immutableResourceId }}"
      vnetTrafficTag: "{{ vnetTrafficTag }}"
      manualPrivateLinkServiceConnections:
        - name: "{{ name }}"
          groupIds: "{{ groupIds }}"
          requestMessage: "{{ requestMessage }}"
      privateLinkServiceConnections:
        - name: "{{ name }}"
          groupIds: "{{ groupIds }}"
          requestMessage: "{{ requestMessage }}"
      privateLinkServiceProxies:
        - id: "{{ id }}"
          remotePrivateLinkServiceConnectionState:
            status: "{{ status }}"
            description: "{{ description }}"
            actionsRequired: "{{ actionsRequired }}"
          remotePrivateEndpointConnection:
            id: "{{ id }}"
          groupConnectivityInformation: "{{ groupConnectivityInformation }}"
      connectionDetails:
        - id: "{{ id }}"
          privateIpAddress: "{{ privateIpAddress }}"
          linkIdentifier: "{{ linkIdentifier }}"
          groupId: "{{ groupId }}"
          memberName: "{{ memberName }}"
  - name: status
    value: "{{ status }}"
    description: |
      Operation status.

REPLACE examples

create_or_update

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

REPLACE azure.device_update.private_endpoint_connection_proxies
SET 
remotePrivateEndpoint = '{{ remotePrivateEndpoint }}',
status = '{{ status }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND private_endpoint_connection_proxy_id = '{{ private_endpoint_connection_proxy_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
properties,
remotePrivateEndpoint,
status,
systemData,
type;

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 resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND private_endpoint_connection_proxy_id = '{{ private_endpoint_connection_proxy_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

validate

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

EXEC azure.device_update.private_endpoint_connection_proxies.validate 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@private_endpoint_connection_proxy_id='{{ private_endpoint_connection_proxy_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"remotePrivateEndpoint": "{{ remotePrivateEndpoint }}", 
"status": "{{ status }}"
}'
;

update_private_endpoint_properties

(INTERNAL - DO NOT USE) Updates a private endpoint inside the private endpoint connection proxy object.

EXEC azure.device_update.private_endpoint_connection_proxies.update_private_endpoint_properties 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@private_endpoint_connection_proxy_id='{{ private_endpoint_connection_proxy_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"id": "{{ id }}", 
"location": "{{ location }}", 
"immutableSubscriptionId": "{{ immutableSubscriptionId }}", 
"immutableResourceId": "{{ immutableResourceId }}", 
"vnetTrafficTag": "{{ vnetTrafficTag }}"
}'
;