resource_guards

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

Overview

Name	resource_guards
Type	Resource
Id	azure.data_protection.resource_guards

Fields

The following fields are returned by SELECT queries:

get_default_delete_resource_guard_proxy_requests_object

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.
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".

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.
allowAutoApprovals	boolean	This flag indicates whether auto approval is allowed or not.
description	string	Description about the pre-req steps to perform all the critical operations.
eTag	string	Optional ETag.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the BackupVault resource. Known values are: "Failed", "Provisioning", "Succeeded", "Unknown", and "Updating". (Failed, Provisioning, Succeeded, Unknown, Updating)
resourceGuardOperations	array	{readonly} List of operation details those are protected by the ResourceGuard resource.
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".
vaultCriticalOperationExclusionList	array	List of critical operations which are not protected by this resourceGuard.

get_resources_in_resource_group

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.
allowAutoApprovals	boolean	This flag indicates whether auto approval is allowed or not.
description	string	Description about the pre-req steps to perform all the critical operations.
eTag	string	Optional ETag.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the BackupVault resource. Known values are: "Failed", "Provisioning", "Succeeded", "Unknown", and "Updating". (Failed, Provisioning, Succeeded, Unknown, Updating)
resourceGuardOperations	array	{readonly} List of operation details those are protected by the ResourceGuard resource.
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".
vaultCriticalOperationExclusionList	array	List of critical operations which are not protected by this resourceGuard.

get_resources_in_subscription

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.
allowAutoApprovals	boolean	This flag indicates whether auto approval is allowed or not.
description	string	Description about the pre-req steps to perform all the critical operations.
eTag	string	Optional ETag.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the BackupVault resource. Known values are: "Failed", "Provisioning", "Succeeded", "Unknown", and "Updating". (Failed, Provisioning, Succeeded, Unknown, Updating)
resourceGuardOperations	array	{readonly} List of operation details those are protected by the ResourceGuard resource.
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".
vaultCriticalOperationExclusionList	array	List of critical operations which are not protected by this resourceGuard.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_default_delete_resource_guard_proxy_requests_object	select	resource_group_name, resource_guards_name, request_name, subscription_id		Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
get	select	resource_group_name, resource_guards_name, subscription_id		Returns a ResourceGuard belonging to a resource group.
get_resources_in_resource_group	select	resource_group_name, subscription_id		Returns ResourceGuards collection belonging to a ResourceGroup.
get_resources_in_subscription	select	subscription_id		Returns ResourceGuards collection belonging to a subscription.
delete	delete	resource_group_name, resource_guards_name, subscription_id		Deletes a ResourceGuard resource from the resource group.
put	exec	resource_group_name, resource_guards_name, subscription_id, location		Creates or updates a ResourceGuard resource belonging to a resource group.
patch	exec	resource_group_name, resource_guards_name, subscription_id		Updates a ResourceGuard resource belonging to a resource group. For example, updating tags for a resource.
get_delete_resource_guard_proxy_requests_objects	exec	resource_group_name, resource_guards_name, subscription_id		Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
get_default_disable_soft_delete_requests_object	exec	resource_group_name, resource_guards_name, request_name, subscription_id		Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
get_disable_soft_delete_requests_objects	exec	resource_group_name, resource_guards_name, subscription_id		Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
get_default_update_protected_item_requests_object	exec	resource_group_name, resource_guards_name, request_name, subscription_id		Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
get_update_protected_item_requests_objects	exec	resource_group_name, resource_guards_name, subscription_id		Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
get_default_update_protection_policy_requests_object	exec	resource_group_name, resource_guards_name, request_name, subscription_id		Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
get_update_protection_policy_requests_objects	exec	resource_group_name, resource_guards_name, subscription_id		Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
get_default_delete_protected_item_requests_object	exec	resource_group_name, resource_guards_name, request_name, subscription_id		Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
get_delete_protected_item_requests_objects	exec	resource_group_name, resource_guards_name, subscription_id		Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
get_default_backup_security_pin_requests_object	exec	resource_group_name, resource_guards_name, request_name, subscription_id		Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
get_backup_security_pin_requests_objects	exec	resource_group_name, resource_guards_name, subscription_id		Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

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
request_name	string	The name of the DppBaseResource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_guards_name	string	The name of the ResourceGuardResource. Required.
subscription_id	string

SELECT examples

get_default_delete_resource_guard_proxy_requests_object

Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

SELECT
id,
name,
systemData,
type
FROM azure.data_protection.resource_guards
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_guards_name = '{{ resource_guards_name }}' -- required
AND request_name = '{{ request_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Returns a ResourceGuard belonging to a resource group.

SELECT
id,
name,
allowAutoApprovals,
description,
eTag,
location,
provisioningState,
resourceGuardOperations,
systemData,
tags,
type,
vaultCriticalOperationExclusionList
FROM azure.data_protection.resource_guards
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_guards_name = '{{ resource_guards_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_resources_in_resource_group

Returns ResourceGuards collection belonging to a ResourceGroup.

SELECT
id,
name,
allowAutoApprovals,
description,
eTag,
location,
provisioningState,
resourceGuardOperations,
systemData,
tags,
type,
vaultCriticalOperationExclusionList
FROM azure.data_protection.resource_guards
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_resources_in_subscription

Returns ResourceGuards collection belonging to a subscription.

SELECT
id,
name,
allowAutoApprovals,
description,
eTag,
location,
provisioningState,
resourceGuardOperations,
systemData,
tags,
type,
vaultCriticalOperationExclusionList
FROM azure.data_protection.resource_guards
WHERE subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

delete

Deletes a ResourceGuard resource from the resource group.

DELETE FROM azure.data_protection.resource_guards
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_guards_name = '{{ resource_guards_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

put

Creates or updates a ResourceGuard resource belonging to a resource group.

EXEC azure.data_protection.resource_guards.put 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_guards_name='{{ resource_guards_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"tags": "{{ tags }}", 
"location": "{{ location }}", 
"properties": "{{ properties }}", 
"eTag": "{{ eTag }}"
}'
;

patch

Updates a ResourceGuard resource belonging to a resource group. For example, updating tags for a resource.

EXEC azure.data_protection.resource_guards.patch 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_guards_name='{{ resource_guards_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;

get_delete_resource_guard_proxy_requests_objects

Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

EXEC azure.data_protection.resource_guards.get_delete_resource_guard_proxy_requests_objects 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_guards_name='{{ resource_guards_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_default_disable_soft_delete_requests_object

Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

EXEC azure.data_protection.resource_guards.get_default_disable_soft_delete_requests_object 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_guards_name='{{ resource_guards_name }}' --required, 
@request_name='{{ request_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_disable_soft_delete_requests_objects

Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

EXEC azure.data_protection.resource_guards.get_disable_soft_delete_requests_objects 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_guards_name='{{ resource_guards_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_default_update_protected_item_requests_object

Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

EXEC azure.data_protection.resource_guards.get_default_update_protected_item_requests_object 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_guards_name='{{ resource_guards_name }}' --required, 
@request_name='{{ request_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_update_protected_item_requests_objects

Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

EXEC azure.data_protection.resource_guards.get_update_protected_item_requests_objects 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_guards_name='{{ resource_guards_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_default_update_protection_policy_requests_object

Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

EXEC azure.data_protection.resource_guards.get_default_update_protection_policy_requests_object 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_guards_name='{{ resource_guards_name }}' --required, 
@request_name='{{ request_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_update_protection_policy_requests_objects

Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

EXEC azure.data_protection.resource_guards.get_update_protection_policy_requests_objects 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_guards_name='{{ resource_guards_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_default_delete_protected_item_requests_object

Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

EXEC azure.data_protection.resource_guards.get_default_delete_protected_item_requests_object 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_guards_name='{{ resource_guards_name }}' --required, 
@request_name='{{ request_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_delete_protected_item_requests_objects

Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

EXEC azure.data_protection.resource_guards.get_delete_protected_item_requests_objects 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_guards_name='{{ resource_guards_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_default_backup_security_pin_requests_object

Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

EXEC azure.data_protection.resource_guards.get_default_backup_security_pin_requests_object 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_guards_name='{{ resource_guards_name }}' --required, 
@request_name='{{ request_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_backup_security_pin_requests_objects

Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

EXEC azure.data_protection.resource_guards.get_backup_security_pin_requests_objects 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_guards_name='{{ resource_guards_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;