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

Backup Protection Intent - List

Service:

Recovery Services - Backup

API Version:

2023-02-01

提供保管库中存在的所有意向的可分页列表。

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

With optional parameters:

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

URI 参数

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

响应

名称	类型	说明
200 OK	ProtectionIntentResourceList	确定

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

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

示例

List protection intent with backupManagementType filter

Sample Request

HTTP

GET https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupProtectionIntents?api-version=2023-02-01

Java

/** Samples for BackupProtectionIntent List. */
public final class Main {
    /*
     * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureWorkload/BackupProtectionIntent_List.json
     */
    /**
     * Sample code: List protection intent with backupManagementType filter.
     *
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void listProtectionIntentWithBackupManagementTypeFilter(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager.backupProtectionIntents().list("myVault", "myRG", null, null, 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 backup_protection_intent_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.backup_protection_intent.list(
        vault_name="myVault",
        resource_group_name="myRG",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureWorkload/BackupProtectionIntent_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/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/AzureWorkload/BackupProtectionIntent_List.json
func ExampleBackupProtectionIntentClient_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.NewBackupProtectionIntentClient().NewListPager("myVault", "myRG", &armrecoveryservicesbackup.BackupProtectionIntentClientListOptions{Filter: nil,
		SkipToken: nil,
	})
	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.ProtectionIntentResourceList = armrecoveryservicesbackup.ProtectionIntentResourceList{
		// 	Value: []*armrecoveryservicesbackup.ProtectionIntentResource{
		// 		{
		// 			Name: to.Ptr("249D9B07-D2EF-4202-AA64-65F35418564E"),
		// 			Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupProtectionIntent"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupFabrics/Azure/backupProtectionIntent/249D9B07-D2EF-4202-AA64-65F35418564E"),
		// 			Properties: &armrecoveryservicesbackup.AzureWorkloadContainerAutoProtectionIntent{
		// 				BackupManagementType: to.Ptr(armrecoveryservicesbackup.BackupManagementTypeAzureWorkload),
		// 				ItemID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupProtectionContainer/VMAppContainer;Compute;testVmName/backupProtectableItems/SQLInstance;MSSQLSERVER"),
		// 				PolicyID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myPolicy"),
		// 				ProtectionIntentItemType: to.Ptr(armrecoveryservicesbackup.ProtectionIntentItemTypeAzureWorkloadContainerAutoProtectionIntent),
		// 			},
		// 	}},
		// }
	}
}

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 Provides a pageable list of all intents that are present within a vault.
 *
 * @summary Provides a pageable list of all intents that are present within a vault.
 * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureWorkload/BackupProtectionIntent_List.json
 */
async function listProtectionIntentWithBackupManagementTypeFilter() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "myVault";
  const resourceGroupName = process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "myRG";
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.backupProtectionIntent.list(vaultName, resourceGroupName)) {
    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/AzureWorkload/BackupProtectionIntent_List.json
// this example is just showing the usage of "BackupProtectionIntent_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 = "myRG";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// invoke the operation and iterate over the result
string vaultName = "myVault";
await foreach (BackupProtectionIntentResource item in resourceGroupResource.GetBackupProtectionIntentsAsync(vaultName))
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    BackupProtectionIntentData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupFabrics/Azure/backupProtectionIntent/249D9B07-D2EF-4202-AA64-65F35418564E",
      "name": "249D9B07-D2EF-4202-AA64-65F35418564E",
      "type": "Microsoft.RecoveryServices/vaults/backupProtectionIntent",
      "properties": {
        "protectionIntentItemType": "AzureWorkloadContainerAutoProtectionIntent",
        "backupManagementType": "AzureWorkload",
        "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myPolicy",
        "itemId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupProtectionContainer/VMAppContainer;Compute;testVmName/backupProtectableItems/SQLInstance;MSSQLSERVER"
      }
    }
  ]
}

定义

名称	说明
AzureRecoveryServiceVaultProtectionIntent	Azure 恢复服务保管库特定的保护意向项。
AzureResourceProtectionIntent	特定于 IaaS VM 的备份保护意向项。
AzureWorkloadAutoProtectionIntent	Azure 恢复服务保管库特定的保护意向项。
AzureWorkloadContainerAutoProtectionIntent	Azure 工作负载特定的保护意向项。
AzureWorkloadSQLAutoProtectionIntent	Azure 工作负载 SQL 自动保护意向项。
BackupManagementType	备份项的备份管理类型。
ProtectionIntentResource	backup ProtectionIntent 的基类。
ProtectionIntentResourceList	ProtectionIntent 资源列表
ProtectionStatus	备份项的状态。
WorkloadItemType	要为其设置意向的项的工作负荷项类型

AzureRecoveryServiceVaultProtectionIntent

Azure 恢复服务保管库特定的保护意向项。

名称	类型	说明
backupManagementType	BackupManagementType	备份项的备份管理类型。
itemId	string	受保护项的 ID，如果是 Azure Vm，则为 ProtectedItemId
policyId	string	用于备份此项的备份策略的 ID。
protectionIntentItemType	string: RecoveryServiceVaultItem	备份保护Intent 类型。
protectionState	ProtectionStatus	此备份项的备份状态。
sourceResourceId	string	要备份的资源的 ARM ID。

AzureResourceProtectionIntent

特定于 IaaS VM 的备份保护意向项。

名称	类型	说明
backupManagementType	BackupManagementType	备份项的备份管理类型。
friendlyName	string	此备份项表示的 VM 的友好名称。
itemId	string	受保护项的 ID，如果是 Azure Vm，则为 ProtectedItemId
policyId	string	用于备份此项的备份策略的 ID。
protectionIntentItemType	string: AzureResourceItem	备份保护Intent 类型。
protectionState	ProtectionStatus	此备份项的备份状态。
sourceResourceId	string	要备份的资源的 ARM ID。

AzureWorkloadAutoProtectionIntent

Azure 恢复服务保管库特定的保护意向项。

名称	类型	说明
backupManagementType	BackupManagementType	备份项的备份管理类型。
itemId	string	受保护项的 ID，如果是 Azure Vm，则为 ProtectedItemId
policyId	string	用于备份此项的备份策略的 ID。
protectionIntentItemType	string: AzureWorkloadAutoProtectionIntent	备份保护Intent 类型。
protectionState	ProtectionStatus	此备份项的备份状态。
sourceResourceId	string	要备份的资源的 ARM ID。

AzureWorkloadContainerAutoProtectionIntent

Azure 工作负载特定的保护意向项。

名称	类型	说明
backupManagementType	BackupManagementType	备份项的备份管理类型。
itemId	string	受保护项的 ID，如果是 Azure Vm，则为 ProtectedItemId
policyId	string	用于备份此项的备份策略的 ID。
protectionIntentItemType	string: AzureWorkloadContainerAutoProtectionIntent	备份保护Intent 类型。
protectionState	ProtectionStatus	此备份项的备份状态。
sourceResourceId	string	要备份的资源的 ARM ID。

AzureWorkloadSQLAutoProtectionIntent

Azure 工作负载 SQL 自动保护意向项。

名称	类型	说明
backupManagementType	BackupManagementType	备份项的备份管理类型。
itemId	string	受保护项的 ID，如果是 Azure Vm，则为 ProtectedItemId
policyId	string	用于备份此项的备份策略的 ID。
protectionIntentItemType	string: AzureWorkloadSQLAutoProtectionIntent	备份保护Intent 类型。
protectionState	ProtectionStatus	此备份项的备份状态。
sourceResourceId	string	要备份的资源的 ARM ID。
workloadItemType	WorkloadItemType	要为其设置意向的项的工作负荷项类型

BackupManagementType

备份项的备份管理类型。

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

ProtectionIntentResource

backup ProtectionIntent 的基类。

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

ProtectionIntentResourceList

ProtectionIntent 资源列表

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

ProtectionStatus

备份项的状态。

名称	类型	说明
Invalid	string
NotProtected	string
Protected	string
Protecting	string
ProtectionFailed	string

WorkloadItemType

要为其设置意向的项的工作负荷项类型

名称	类型	说明
Invalid	string
SAPAseDatabase	string
SAPAseSystem	string
SAPHanaDBInstance	string
SAPHanaDatabase	string
SAPHanaSystem	string
SQLDataBase	string
SQLInstance	string