resource_guard_proxies

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

Overview

Name	resource_guard_proxies
Type	Resource
Id	azure.recovery_services_backup.resource_guard_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
properties	object	ResourceGuardProxyBaseResource 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, resourceGuardProxyName	api-version	Returns ResourceGuardProxy under vault and with the name referenced in request
put	replace	vaultName, resourceGroupName, subscriptionId, resourceGuardProxyName	api-version	Add or Update ResourceGuardProxy under vault Secures vault critical operations
delete	delete	vaultName, resourceGroupName, subscriptionId, resourceGuardProxyName	api-version	Delete ResourceGuardProxy under vault
unlock_delete	exec	vaultName, resourceGroupName, subscriptionId, resourceGuardProxyName	api-version	Secures delete ResourceGuardProxy operations.

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
resourceGroupName	string	The name of the resource group where the recovery services vault is present.
resourceGuardProxyName	string
subscriptionId	string	The subscription Id.
vaultName	string	The name of the recovery services vault.
api-version	string	Client Api Version.

SELECT examples

get

Returns ResourceGuardProxy under vault and with the name referenced in request

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

REPLACE examples

put

Add or Update ResourceGuardProxy under vault
Secures vault critical operations

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

DELETE examples

delete

Delete ResourceGuardProxy under vault

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

Lifecycle Methods

unlock_delete

Secures delete ResourceGuardProxy operations.

EXEC azure.recovery_services_backup.resource_guard_proxies.unlock_delete 
@vaultName='{{ vaultName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGuardProxyName='{{ resourceGuardProxyName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"resourceGuardOperationRequests": "{{ resourceGuardOperationRequests }}", 
"resourceToBeDeleted": "{{ resourceToBeDeleted }}"
}'
;