Share via

Protectable Containers - List

  • Reference
Service:
Recovery Services - Backup
API Version:
2024-10-01

Lists the containers that can be registered to Recovery Services Vault.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectableContainers?api-version=2024-10-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectableContainers?api-version=2024-10-01&$filter={$filter}

URI Parameters

Name In Required Type Description
fabricName
 path True

string

resourceGroupName
 path True

string

The name of the resource group where the recovery services vault is present.
subscriptionId
 path True

string

The subscription Id.
vaultName
 path True

string

The name of the recovery services vault.
api-version
 query True

string

Client Api Version.
$filter
 query

string

OData filter options.

Responses

Name Type Description
200 OK

ProtectableContainerResourceList

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

List protectable items with backupManagementType filter as AzureStorage

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectableContainers?api-version=2024-10-01&$filter=backupManagementType eq 'AzureStorage' and workloadType eq 'AzureFileShare'

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectableContainers/StorageContainer;storage;test-rg;teststorage",
      "name": "StorageContainer;storage;test-rg;testst",
      "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectableContainers",
      "properties": {
        "friendlyName": "teststorage",
        "backupManagementType": "AzureStorage",
        "protectableContainerType": "StorageContainer",
        "healthStatus": "Healthy",
        "containerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorage"
      }
    },
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectableContainers/StorageContainer;ClassicStorage;test-rg;teststorage",
      "name": "StorageContainer;ClassicStorage;test-rg;teststorage",
      "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectableContainers",
      "properties": {
        "friendlyName": "teststorage",
        "backupManagementType": "AzureStorage",
        "protectableContainerType": "StorageContainer",
        "healthStatus": "Healthy",
        "containerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ClassicStorage/storageAccounts/teststorage"
      }
    }
  ]
}

Definitions

Name Description
AzureStorageProtectableContainer

Azure Storage-specific protectable containers
AzureVMAppContainerProtectableContainer

Azure workload-specific container
BackupManagementType

Type of backup management for the backed up item.
CloudError

An error response from the Container Instance service.
CloudErrorBody

An error response from the Container Instance service.
ErrorAdditionalInfo

The resource management error additional info.
ProtectableContainerResource

Protectable Container Class.
ProtectableContainerResourceList

List of ProtectableContainer resources

AzureStorageProtectableContainer

Azure Storage-specific protectable containers

Name Type Description
backupManagementType

BackupManagementType

Type of backup management for the container.
containerId

string

Fabric Id of the container such as ARM Id.
friendlyName

string

Friendly name of the container.
healthStatus

string

Status of health of the container.
protectableContainerType string:

StorageContainer

Type of the container. The value of this property for

  1. Compute Azure VM is Microsoft.Compute/virtualMachines
  2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines

AzureVMAppContainerProtectableContainer

Azure workload-specific container

Name Type Description
backupManagementType

BackupManagementType

Type of backup management for the container.
containerId

string

Fabric Id of the container such as ARM Id.
friendlyName

string

Friendly name of the container.
healthStatus

string

Status of health of the container.
protectableContainerType string:

VMAppContainer

Type of the container. The value of this property for

  1. Compute Azure VM is Microsoft.Compute/virtualMachines
  2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines

BackupManagementType

Type of backup management for the backed up item.

Name Type Description
AzureBackupServer

string

AzureIaasVM

string

AzureSql

string

AzureStorage

string

AzureWorkload

string

DPM

string

DefaultBackup

string

Invalid

string

MAB

string

CloudError

An error response from the Container Instance service.

Name Type Description
error

CloudErrorBody

The error object.

CloudErrorBody

An error response from the Container Instance service.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details

CloudErrorBody[]

A list of additional details about the error.
message

string

A message describing the error, intended to be suitable for display in a user interface.
target

string

The target of the particular error. For example, the name of the property in error.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ProtectableContainerResource

Protectable Container Class.

Name Type Description
eTag

string

Optional ETag.
id

string

Resource Id represents the complete path to the resource.
location

string

Resource location.
name

string

Resource name associated with the resource.
properties ProtectableContainer:

ProtectableContainerResource properties
tags

object

Resource tags.
type

string

Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

ProtectableContainerResourceList

List of ProtectableContainer resources

Name Type Description
nextLink

string

The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value

ProtectableContainerResource[]

List of resources.