resource_guard_proxy

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

Overview

Name	resource_guard_proxy
Type	Resource
Id	azure.recovery_services_backup.resource_guard_proxy

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.
description	string	:vartype description: str
eTag	string	Optional ETag.
lastUpdatedTime	string	:vartype last_updated_time: str
location	string	The geo-location where the resource lives.
resourceGuardOperationDetails	array	:vartype resource_guard_operation_details: list[~azure.mgmt.recoveryservicesbackup.models.ResourceGuardOperationDetail]
resourceGuardResourceId	string	Required.
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, resource_guard_proxy_name, subscription_id		Returns ResourceGuardProxy under vault and with the name referenced in request.
delete	delete	vault_name, resource_group_name, resource_guard_proxy_name, subscription_id		Delete ResourceGuardProxy under vault.
put	exec	vault_name, resource_group_name, resource_guard_proxy_name, subscription_id		Add or Update ResourceGuardProxy under vault Secures vault critical operations.
unlock_delete	exec	vault_name, resource_group_name, resource_guard_proxy_name, subscription_id		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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_guard_proxy_name	string	Required.
subscription_id	string
vault_name	string	The name of the VaultResource. Required.

SELECT examples

get

Returns ResourceGuardProxy under vault and with the name referenced in request.

SELECT
id,
name,
description,
eTag,
lastUpdatedTime,
location,
resourceGuardOperationDetails,
resourceGuardResourceId,
systemData,
tags,
type
FROM azure.recovery_services_backup.resource_guard_proxy
WHERE vault_name = '{{ vault_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND resource_guard_proxy_name = '{{ resource_guard_proxy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

delete

Delete ResourceGuardProxy under vault.

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

Lifecycle Methods

put

Add or Update ResourceGuardProxy under vault Secures vault critical operations.

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

unlock_delete

Secures delete ResourceGuardProxy operations.

EXEC azure.recovery_services_backup.resource_guard_proxy.unlock_delete 
@vault_name='{{ vault_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_guard_proxy_name='{{ resource_guard_proxy_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"resourceGuardOperationRequests": "{{ resourceGuardOperationRequests }}", 
"resourceToBeDeleted": "{{ resourceToBeDeleted }}"
}'
;