Dpp Resource Guard Proxy - List

Service:

Data Protection

API Version:

2025-02-01

Returns the list of ResourceGuardProxies associated with the vault

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies?api-version=2025-02-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
vaultName	path	True	string	The name of the backup vault.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ResourceGuardProxyBaseResourceList	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account.

Examples

Get ResourceGuardProxies

Sample request

HTTP

GET https://management.azure.com/subscriptions/5e13b949-1218-4d18-8b99-7e12155ec4f7/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/sampleVault/backupResourceGuardProxies?api-version=2025-02-01

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/5e13b949-1218-4d18-8b99-7e12155ec4f7/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/sampleVault/backupResourceGuardProxies/swaggerExample",
      "name": "swaggerExample",
      "type": "Microsoft.DataProtection/vaults/backupResourceGuardProxies",
      "properties": {
        "resourceGuardResourceId": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource",
        "resourceGuardOperationDetails": [
          {
            "vaultCriticalOperation": "Microsoft.DataProtection/backupVaults/backupInstances/delete",
            "defaultResourceRequest": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteBackupInstanceRequests/default"
          },
          {
            "vaultCriticalOperation": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete",
            "defaultResourceRequest": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteResourceGuardProxyRequests/default"
          }
        ],
        "lastUpdatedTime": "2022-09-16T11:44:37.6130487Z",
        "description": "Please take JIT access before performing any of the critical operation"
      }
    }
  ]
}

Definitions

Name	Description
CloudError	CloudError
createdByType	The type of identity that created the resource.
Error	The resource management error response.
ErrorAdditionalInfo	The resource management error additional info.
ResourceGuardOperationDetail	VaultCritical Operation protected by a resource guard
ResourceGuardProxyBase	ResourceGuardProxyBase object, used in ResourceGuardProxyBaseResource
ResourceGuardProxyBaseResource	ResourceGuardProxyBaseResource object, used for response and request bodies for ResourceGuardProxy APIs
ResourceGuardProxyBaseResourceList	List of ResourceGuardProxyBase resources
systemData	Metadata pertaining to creation and last modification of the resource.

CloudError

Object

CloudError

Name	Type	Description
error	Error	The resource management error response.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
Application
Key
ManagedIdentity
User

Error

Object

The resource management error response.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	Error[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ResourceGuardOperationDetail

Object

VaultCritical Operation protected by a resource guard

Name	Type	Description
defaultResourceRequest	string
vaultCriticalOperation	string

ResourceGuardProxyBase

Object

ResourceGuardProxyBase object, used in ResourceGuardProxyBaseResource

Name	Type	Description
description	string
lastUpdatedTime	string
resourceGuardOperationDetails	ResourceGuardOperationDetail[]	VaultCritical Operation protected by a resource guard
resourceGuardResourceId	string

ResourceGuardProxyBaseResource

Object

ResourceGuardProxyBaseResource object, used for response and request bodies for ResourceGuardProxy APIs

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

ResourceGuardProxyBaseResourceList

Object

List of ResourceGuardProxyBase resources

Name	Type	Description
nextLink	string	The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value	ResourceGuardProxyBaseResource[]	List of resources.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.