你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Protectable Containers - List

Service:

Recovery Services - Backup

API Version:

2023-02-01

列出可注册到恢复服务保管库的容器。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectableContainers?api-version=2023-02-01

With optional parameters:

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

URI 参数

名称	在	必需	类型	说明
fabricName	path	True	string
resourceGroupName	path	True	string	恢复服务保管库所在的资源组的名称。
subscriptionId	path	True	string	订阅 ID。
vaultName	path	True	string	恢复服务保管库的名称。
api-version	query	True	string	客户端 API 版本。
$filter	query		string	OData 筛选器选项。

响应

名称	类型	说明
200 OK	ProtectableContainerResourceList	确定
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户。

示例

List protectable items with backupManagementType filter as AzureStorage

Sample Request

HTTP

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

Java

/** Samples for ProtectableContainers List. */
public final class Main {
    /*
     * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureStorage/ProtectableContainers_List.json
     */
    /**
     * Sample code: List protectable items with backupManagementType filter as AzureStorage.
     *
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void listProtectableItemsWithBackupManagementTypeFilterAsAzureStorage(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager
            .protectableContainers()
            .list(
                "testvault",
                "testRg",
                "Azure",
                "backupManagementType eq 'AzureStorage' and workloadType eq 'AzureFileShare'",
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesbackup import RecoveryServicesBackupClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicesbackup
# USAGE
    python protectable_containers_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = RecoveryServicesBackupClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.protectable_containers.list(
        vault_name="testvault",
        resource_group_name="testRg",
        fabric_name="Azure",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureStorage/ProtectableContainers_List.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armrecoveryservicesbackup_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/a498cae6d1a93f4c33073f0747b93b22815c09b7/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureStorage/ProtectableContainers_List.json
func ExampleProtectableContainersClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrecoveryservicesbackup.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewProtectableContainersClient().NewListPager("testvault", "testRg", "Azure", &armrecoveryservicesbackup.ProtectableContainersClientListOptions{Filter: to.Ptr("backupManagementType eq 'AzureStorage' and workloadType eq 'AzureFileShare'")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ProtectableContainerResourceList = armrecoveryservicesbackup.ProtectableContainerResourceList{
		// 	Value: []*armrecoveryservicesbackup.ProtectableContainerResource{
		// 		{
		// 			Name: to.Ptr("StorageContainer;storage;test-rg;testst"),
		// 			Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupFabrics/protectableContainers"),
		// 			ID: to.Ptr("/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectableContainers/StorageContainer;storage;test-rg;teststorage"),
		// 			Properties: &armrecoveryservicesbackup.AzureStorageProtectableContainer{
		// 				BackupManagementType: to.Ptr(armrecoveryservicesbackup.BackupManagementTypeAzureStorage),
		// 				ContainerID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorage"),
		// 				FriendlyName: to.Ptr("teststorage"),
		// 				HealthStatus: to.Ptr("Healthy"),
		// 				ProtectableContainerType: to.Ptr(armrecoveryservicesbackup.ProtectableContainerTypeStorageContainer),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("StorageContainer;ClassicStorage;test-rg;teststorage"),
		// 			Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupFabrics/protectableContainers"),
		// 			ID: to.Ptr("/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectableContainers/StorageContainer;ClassicStorage;test-rg;teststorage"),
		// 			Properties: &armrecoveryservicesbackup.AzureStorageProtectableContainer{
		// 				BackupManagementType: to.Ptr(armrecoveryservicesbackup.BackupManagementTypeAzureStorage),
		// 				ContainerID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ClassicStorage/storageAccounts/teststorage"),
		// 				FriendlyName: to.Ptr("teststorage"),
		// 				HealthStatus: to.Ptr("Healthy"),
		// 				ProtectableContainerType: to.Ptr(armrecoveryservicesbackup.ProtectableContainerTypeStorageContainer),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the containers that can be registered to Recovery Services Vault.
 *
 * @summary Lists the containers that can be registered to Recovery Services Vault.
 * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureStorage/ProtectableContainers_List.json
 */
async function listProtectableItemsWithBackupManagementTypeFilterAsAzureStorage() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "testvault";
  const resourceGroupName = process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "testRg";
  const fabricName = "Azure";
  const filter = "backupManagementType eq 'AzureStorage' and workloadType eq 'AzureFileShare'";
  const options = { filter };
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.protectableContainers.list(
    vaultName,
    resourceGroupName,
    fabricName,
    options
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.RecoveryServicesBackup;
using Azure.ResourceManager.RecoveryServicesBackup.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureStorage/ProtectableContainers_List.json
// this example is just showing the usage of "ProtectableContainers_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "testRg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// invoke the operation and iterate over the result
string vaultName = "testvault";
string fabricName = "Azure";
string filter = "backupManagementType eq 'AzureStorage' and workloadType eq 'AzureFileShare'";
await foreach (ProtectableContainerResource item in resourceGroupResource.GetProtectableContainersAsync(vaultName, fabricName, filter: filter))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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"
      }
    }
  ]
}

定义

名称	说明
AzureStorageProtectableContainer	特定于 Azure 存储的可保护容器
AzureVMAppContainerProtectableContainer	特定于 Azure 工作负载的容器
BackupManagementType	备份项的备份管理类型。
CloudError	来自容器实例服务的错误响应。
CloudErrorBody	来自容器实例服务的错误响应。
ErrorAdditionalInfo	资源管理错误附加信息。
ProtectableContainerResource	可保护的容器类。
ProtectableContainerResourceList	ProtectableContainer 资源列表

AzureStorageProtectableContainer

特定于 Azure 存储的可保护容器

名称	类型	说明
backupManagementType	BackupManagementType	容器的备份管理类型。
containerId	string	容器的结构 ID，例如 ARM ID。
friendlyName	string	易记的容器名称。
healthStatus	string	容器的运行状况状态。
protectableContainerType	string: StorageContainer	容器的类型。 此属性的值 计算 Azure VM 为 Microsoft.Compute/virtualMachines 经典计算 Azure VM 为 Microsoft.ClassicCompute/virtualMachines

AzureVMAppContainerProtectableContainer

特定于 Azure 工作负载的容器

名称	类型	说明
backupManagementType	BackupManagementType	容器的备份管理类型。
containerId	string	容器的结构 ID，例如 ARM ID。
friendlyName	string	易记的容器名称。
healthStatus	string	容器的运行状况状态。
protectableContainerType	string: VMAppContainer	容器的类型。 此属性的值 计算 Azure VM 为 Microsoft.Compute/virtualMachines 经典计算 Azure VM 为 Microsoft.ClassicCompute/virtualMachines

BackupManagementType

备份项的备份管理类型。

名称	类型	说明
AzureBackupServer	string
AzureIaasVM	string
AzureSql	string
AzureStorage	string
AzureWorkload	string
DPM	string
DefaultBackup	string
Invalid	string
MAB	string

CloudError

来自容器实例服务的错误响应。

名称	类型	说明
error	CloudErrorBody	错误对象。

CloudErrorBody

来自容器实例服务的错误响应。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，该消息适用于在用户界面中显示。
target	string	特定错误的目标。 例如，属性的名称出错。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ProtectableContainerResource

可保护的容器类。

名称	类型	说明
eTag	string	可选 ETag。
id	string	资源 ID 表示资源的完整路径。
location	string	资源位置。
name	string	与资源关联的资源名称。
properties	ProtectableContainer: AzureStorageProtectableContainer AzureVMAppContainerProtectableContainer	ProtectableContainerResource 属性
tags	object	资源标记。
type	string	资源类型表示命名空间/ResourceType/ResourceType/... 格式的完整路径

ProtectableContainerResourceList

ProtectableContainer 资源列表

名称	类型	说明
nextLink	string	用于提取下一页资源的 URI。 调用 ListNext () 提取下一页资源。
value	ProtectableContainerResource[]	资源列表。