private_endpoint_connection

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

Overview

Name	private_endpoint_connection
Type	Resource
Id	azure.recovery_services_backup.private_endpoint_connection

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	Optional ETag.
groupIds	array	Group Ids for the Private Endpoint.
location	string	The geo-location where the resource lives.
privateEndpoint	object	Gets or sets private endpoint associated with the private endpoint connection.
privateLinkServiceConnectionState	object	Gets or sets private link service connection state.
provisioningState	string	Gets or sets provisioning state of the private endpoint connection. Known values are: "Succeeded", "Deleting", "Failed", and "Pending". (Succeeded, Deleting, Failed, Pending)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	vault_name, resource_group_name, private_endpoint_connection_name, subscription_id		Get Private Endpoint Connection. This call is made by Backup Admin.
delete	delete	vault_name, resource_group_name, private_endpoint_connection_name, subscription_id		Delete Private Endpoint requests. This call is made by Backup Admin.
put	exec	vault_name, resource_group_name, private_endpoint_connection_name, subscription_id		Approve or Reject Private Endpoint requests. This call is made by Backup Admin.

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

SELECT examples

get

Get Private Endpoint Connection. This call is made by Backup Admin.

SELECT
id,
name,
eTag,
groupIds,
location,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
tags,
type
FROM azure.recovery_services_backup.private_endpoint_connection
WHERE vault_name = '{{ vault_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

delete

Delete Private Endpoint requests. This call is made by Backup Admin.

DELETE FROM azure.recovery_services_backup.private_endpoint_connection
WHERE vault_name = '{{ vault_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

put

Approve or Reject Private Endpoint requests. This call is made by Backup Admin.

EXEC azure.recovery_services_backup.private_endpoint_connection.put 
@vault_name='{{ vault_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_endpoint_connection_name='{{ private_endpoint_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"tags": "{{ tags }}", 
"location": "{{ location }}", 
"eTag": "{{ eTag }}"
}'
;