dpp_resource_guard_proxy

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

Overview

Name	dpp_resource_guard_proxy
Type	Resource
Id	azure.data_protection.dpp_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
lastUpdatedTime	string	:vartype last_updated_time: str
resourceGuardOperationDetails	array	:vartype resource_guard_operation_details: list[~azure.mgmt.dataprotection.models.ResourceGuardOperationDetail]
resourceGuardResourceId	string	:vartype resource_guard_resource_id: str
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".

list

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
lastUpdatedTime	string	:vartype last_updated_time: str
resourceGuardOperationDetails	array	:vartype resource_guard_operation_details: list[~azure.mgmt.dataprotection.models.ResourceGuardOperationDetail]
resourceGuardResourceId	string	:vartype resource_guard_resource_id: str
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, vault_name, resource_guard_proxy_name, subscription_id		Returns the ResourceGuardProxy object associated with the vault, and that matches the name in the request.
list	select	resource_group_name, vault_name, subscription_id		Returns the list of ResourceGuardProxies associated with the vault.
create_or_update	insert	resource_group_name, vault_name, resource_guard_proxy_name, subscription_id		Creates or Updates a ResourceGuardProxy.
create_or_update	replace	resource_group_name, vault_name, resource_guard_proxy_name, subscription_id		Creates or Updates a ResourceGuardProxy.
delete	delete	resource_group_name, vault_name, resource_guard_proxy_name, subscription_id		Deletes the ResourceGuardProxy.
unlock_delete	exec	resource_group_name, vault_name, resource_guard_proxy_name, subscription_id	x-ms-authorization-auxiliary	UnlockDelete call for ResourceGuardProxy, executed before one can delete it.

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	name of the resource guard proxy. Required.
subscription_id	string
vault_name	string	The name of the backup vault. Required.
x-ms-authorization-auxiliary	string	Default value is None.

SELECT examples

get

Returns the ResourceGuardProxy object associated with the vault, and that matches the name in the request.

SELECT
id,
name,
description,
lastUpdatedTime,
resourceGuardOperationDetails,
resourceGuardResourceId,
systemData,
type
FROM azure.data_protection.dpp_resource_guard_proxy
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND resource_guard_proxy_name = '{{ resource_guard_proxy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns the list of ResourceGuardProxies associated with the vault.

SELECT
id,
name,
description,
lastUpdatedTime,
resourceGuardOperationDetails,
resourceGuardResourceId,
systemData,
type
FROM azure.data_protection.dpp_resource_guard_proxy
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or Updates a ResourceGuardProxy.

INSERT INTO azure.data_protection.dpp_resource_guard_proxy (
properties,
resource_group_name,
vault_name,
resource_guard_proxy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ vault_name }}',
'{{ resource_guard_proxy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: dpp_resource_guard_proxy
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dpp_resource_guard_proxy resource.
  - name: vault_name
    value: "{{ vault_name }}"
    description: Required parameter for the dpp_resource_guard_proxy resource.
  - name: resource_guard_proxy_name
    value: "{{ resource_guard_proxy_name }}"
    description: Required parameter for the dpp_resource_guard_proxy resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dpp_resource_guard_proxy resource.
  - name: properties
    description: |
      ResourceGuardProxyBaseResource properties.
    value:
      resourceGuardResourceId: "{{ resourceGuardResourceId }}"
      resourceGuardOperationDetails:
        - vaultCriticalOperation: "{{ vaultCriticalOperation }}"
          defaultResourceRequest: "{{ defaultResourceRequest }}"
      lastUpdatedTime: "{{ lastUpdatedTime }}"
      description: "{{ description }}"

REPLACE examples

create_or_update

Creates or Updates a ResourceGuardProxy.

REPLACE azure.data_protection.dpp_resource_guard_proxy
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vault_name = '{{ vault_name }}' --required
AND resource_guard_proxy_name = '{{ resource_guard_proxy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the ResourceGuardProxy.

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

Lifecycle Methods

unlock_delete

UnlockDelete call for ResourceGuardProxy, executed before one can delete it.

EXEC azure.data_protection.dpp_resource_guard_proxy.unlock_delete 
@resource_group_name='{{ resource_group_name }}' --required, 
@vault_name='{{ vault_name }}' --required, 
@resource_guard_proxy_name='{{ resource_guard_proxy_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@x-ms-authorization-auxiliary='{{ x-ms-authorization-auxiliary }}' 
@@json=
'{
"resourceGuardOperationRequests": "{{ resourceGuardOperationRequests }}", 
"resourceToBeDeleted": "{{ resourceToBeDeleted }}"
}'
;