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.recovery_services_data_replication.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	Gets or sets ETag.
provisioningState	string	Gets or sets the provisioning state of the private endpoint connection proxy. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
remotePrivateEndpoint	object	Represent remote private endpoint information for the private endpoint connection proxy.
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

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	Gets or sets ETag.
provisioningState	string	Gets or sets the provisioning state of the private endpoint connection proxy. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
remotePrivateEndpoint	object	Represent remote private endpoint information for the private endpoint connection proxy.
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, vault_name, private_endpoint_connection_proxy_name, subscription_id		Gets the private endpoint connection proxy details.
list	select	resource_group_name, vault_name, subscription_id		Gets the all private endpoint connections proxies.
create	insert	resource_group_name, vault_name, private_endpoint_connection_proxy_name, subscription_id		Create a new private endpoint connection proxy which includes both auto and manual approval types. Creating the proxy resource will also create a private endpoint connection resource.
delete	delete	resource_group_name, vault_name, private_endpoint_connection_proxy_name, subscription_id		Returns the operation to track the deletion of private endpoint connection proxy.
validate	exec	resource_group_name, vault_name, private_endpoint_connection_proxy_name, subscription_id		Returns remote private endpoint connection information after validation.

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
private_endpoint_connection_proxy_name	string	The private endpoint connection proxy name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vault_name	string	The vault name. Required.

SELECT examples

get

Gets the private endpoint connection proxy details.

SELECT
id,
name,
etag,
provisioningState,
remotePrivateEndpoint,
systemData,
type
FROM azure.recovery_services_data_replication.private_endpoint_connection_proxies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND private_endpoint_connection_proxy_name = '{{ private_endpoint_connection_proxy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the all private endpoint connections proxies.

SELECT
id,
name,
etag,
provisioningState,
remotePrivateEndpoint,
systemData,
type
FROM azure.recovery_services_data_replication.private_endpoint_connection_proxies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a new private endpoint connection proxy which includes both auto and manual approval types. Creating the proxy resource will also create a private endpoint connection resource.

INSERT INTO azure.recovery_services_data_replication.private_endpoint_connection_proxies (
properties,
etag,
resource_group_name,
vault_name,
private_endpoint_connection_proxy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ etag }}',
'{{ resource_group_name }}',
'{{ vault_name }}',
'{{ private_endpoint_connection_proxy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
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: vault_name
    value: "{{ vault_name }}"
    description: Required parameter for the private_endpoint_connection_proxies resource.
  - name: private_endpoint_connection_proxy_name
    value: "{{ private_endpoint_connection_proxy_name }}"
    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: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      remotePrivateEndpoint:
        id: "{{ id }}"
        privateLinkServiceConnections:
          - name: "{{ name }}"
            groupIds: "{{ groupIds }}"
            requestMessage: "{{ requestMessage }}"
        manualPrivateLinkServiceConnections:
          - 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: etag
    value: "{{ etag }}"
    description: |
      Gets or sets ETag.

DELETE examples

delete

Returns the operation to track the deletion of private endpoint connection proxy.

DELETE FROM azure.recovery_services_data_replication.private_endpoint_connection_proxies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND vault_name = '{{ vault_name }}' --required
AND private_endpoint_connection_proxy_name = '{{ private_endpoint_connection_proxy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

validate

Returns remote private endpoint connection information after validation.

EXEC azure.recovery_services_data_replication.private_endpoint_connection_proxies.validate 
@resource_group_name='{{ resource_group_name }}' --required, 
@vault_name='{{ vault_name }}' --required, 
@private_endpoint_connection_proxy_name='{{ private_endpoint_connection_proxy_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"etag": "{{ etag }}"
}'
;