dpp_resource_guard_proxies

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

Overview

Name	dpp_resource_guard_proxies
Type	Resource
Id	azure.data_protection.dpp_resource_guard_proxies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id represents the complete path to the resource.
name	string	Resource name associated with the resource.
properties	object	ResourceGuardProxyBaseResource properties
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

list

Name	Datatype	Description
id	string	Resource Id represents the complete path to the resource.
name	string	Resource name associated with the resource.
properties	object	ResourceGuardProxyBaseResource properties
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, vaultName, resourceGuardProxyName
list	select	subscriptionId, resourceGroupName, vaultName
create_or_update	insert	subscriptionId, resourceGroupName, vaultName, resourceGuardProxyName
delete	delete	subscriptionId, resourceGroupName, vaultName, resourceGuardProxyName
unlock_delete	exec	subscriptionId, resourceGroupName, vaultName, resourceGuardProxyName	x-ms-authorization-auxiliary

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. The name is case insensitive.
resourceGuardProxyName	string	name of the resource guard proxy
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
vaultName	string	The name of the backup vault.
x-ms-authorization-auxiliary	string

SELECT examples

get

OK

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_protection.dpp_resource_guard_proxies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
AND resourceGuardProxyName = '{{ resourceGuardProxyName }}' -- required
;

list

OK

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_protection.dpp_resource_guard_proxies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.data_protection.dpp_resource_guard_proxies (
data__properties,
subscriptionId,
resourceGroupName,
vaultName,
resourceGuardProxyName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vaultName }}',
'{{ resourceGuardProxyName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: dpp_resource_guard_proxies
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the dpp_resource_guard_proxies resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the dpp_resource_guard_proxies resource.
    - name: vaultName
      value: string
      description: Required parameter for the dpp_resource_guard_proxies resource.
    - name: resourceGuardProxyName
      value: string
      description: Required parameter for the dpp_resource_guard_proxies resource.
    - name: properties
      value: object
      description: |
        ResourceGuardProxyBaseResource properties

DELETE examples

delete

No description available.

DELETE FROM azure.data_protection.dpp_resource_guard_proxies
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vaultName = '{{ vaultName }}' --required
AND resourceGuardProxyName = '{{ resourceGuardProxyName }}' --required
;

Lifecycle Methods

unlock_delete

OK

EXEC azure.data_protection.dpp_resource_guard_proxies.unlock_delete 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@vaultName='{{ vaultName }}' --required, 
@resourceGuardProxyName='{{ resourceGuardProxyName }}' --required, 
@x-ms-authorization-auxiliary='{{ x-ms-authorization-auxiliary }}' 
@@json=
'{
"resourceGuardOperationRequests": "{{ resourceGuardOperationRequests }}", 
"resourceToBeDeleted": "{{ resourceToBeDeleted }}"
}'
;