private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.recovery_services_backup.private_endpoint_connections

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
properties	object	PrivateEndpointConnectionResource properties
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	vaultName, resourceGroupName, subscriptionId, privateEndpointConnectionName	api-version	Get Private Endpoint Connection. This call is made by Backup Admin.
put	replace	vaultName, resourceGroupName, subscriptionId, privateEndpointConnectionName	api-version	Approve or Reject Private Endpoint requests. This call is made by Backup Admin.
delete	delete	vaultName, resourceGroupName, subscriptionId, privateEndpointConnectionName	api-version	Delete 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
privateEndpointConnectionName	string	The name of the private endpoint connection.
resourceGroupName	string	The name of the resource group where the recovery services vault is present.
subscriptionId	string	The subscription Id.
vaultName	string	The name of the recovery services vault.
api-version	string	Client Api Version.

SELECT examples

get

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

SELECT
id,
name,
properties,
type
FROM azure.recovery_services_backup.private_endpoint_connections
WHERE vaultName = '{{ vaultName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
AND api-version = '{{ api-version }}'
;

REPLACE examples

put

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

REPLACE azure.recovery_services_backup.private_endpoint_connections
SET 
data__properties = '{{ properties }}'
WHERE 
vaultName = '{{ vaultName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

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

DELETE FROM azure.recovery_services_backup.private_endpoint_connections
WHERE vaultName = '{{ vaultName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
AND api-version = '{{ api-version }}'
;