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

Protection Policies - Get

提供与恢复服务保管库关联的备份策略的详细信息。 这是一个异步操作。 可以使用 GetPolicyOperationResult API 提取操作的状态。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}?api-version=2024-10-01

URI 参数

名称 必需 类型 说明
policyName
path True

string

要提取的备份策略信息。

resourceGroupName
path True

string

恢复服务保管库所在的资源组的名称。

subscriptionId
path True

string

订阅 ID。

vaultName
path True

string

恢复服务保管库的名称。

api-version
query True

string

客户端 API 版本。

响应

名称 类型 说明
200 OK

ProtectionPolicyResource

还行

Other Status Codes

CloudError

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

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

示例

Get Azure IaasVm Enhanced Protection Policy Details
Get Azure IaasVm Protection Policy Details

Get Azure IaasVm Enhanced Protection Policy Details

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/v2-daily-sample?api-version=2024-10-01

示例响应

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/v2-daily-sample",
  "name": "v2-daily-sample",
  "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
  "properties": {
    "backupManagementType": "AzureIaasVM",
    "instantRpRetentionRangeInDays": 30,
    "policyType": "V2",
    "snapshotConsistencyType": "OnlyCrashConsistent",
    "schedulePolicy": {
      "dailySchedule": {
        "scheduleRunTimes": [
          "2018-01-24T10:00:00Z"
        ]
      },
      "schedulePolicyType": "SimpleSchedulePolicyV2",
      "scheduleRunFrequency": "Daily"
    },
    "retentionPolicy": {
      "retentionPolicyType": "LongTermRetentionPolicy",
      "dailySchedule": {
        "retentionTimes": [
          "2018-01-24T02:00:00Z"
        ],
        "retentionDuration": {
          "count": 1,
          "durationType": "Days"
        }
      }
    },
    "timeZone": "Pacific Standard Time",
    "protectedItemsCount": 0,
    "resourceGuardOperationRequests": null
  }
}

Get Azure IaasVm Protection Policy Details

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1?api-version=2024-10-01

示例响应

{
  "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1",
  "name": "testPolicy1",
  "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
  "properties": {
    "backupManagementType": "AzureIaasVM",
    "schedulePolicy": {
      "schedulePolicyType": "SimpleSchedulePolicy",
      "scheduleRunFrequency": "Daily",
      "scheduleRunTimes": [
        "2018-01-24T02:00:00Z"
      ],
      "scheduleWeeklyFrequency": 0
    },
    "retentionPolicy": {
      "retentionPolicyType": "LongTermRetentionPolicy",
      "dailySchedule": {
        "retentionTimes": [
          "2018-01-24T02:00:00Z"
        ],
        "retentionDuration": {
          "count": 1,
          "durationType": "Days"
        }
      }
    },
    "timeZone": "Pacific Standard Time",
    "protectedItemsCount": 0
  }
}

定义

名称 说明
AzureFileShareProtectionPolicy

AzureStorage 备份策略。

AzureIaaSVMProtectionPolicy

特定于 IaaS VM 工作负荷的备份策略。

AzureSqlProtectionPolicy

特定于 Azure SQL 工作负荷的备份策略。

AzureVmWorkloadProtectionPolicy

特定于 Azure VM(Mercury)工作负荷的备份策略。

CloudError

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

CloudErrorBody

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

DailyRetentionFormat

每日保留格式。

DailyRetentionSchedule

每日保留计划。

DailySchedule
Day

一周中的一天。

DayOfWeek
ErrorAdditionalInfo

资源管理错误附加信息。

GenericProtectionPolicy

特定于 Azure VM(Mercury)工作负荷的备份策略。

HourlySchedule
IAASVMPolicyType
IaasVMSnapshotConsistencyType
InstantRPAdditionalDetails
LogSchedulePolicy

日志策略计划。

LongTermRetentionPolicy

长期保留策略。

LongTermSchedulePolicy

长期策略计划。

MabProtectionPolicy

特定于 Mab 容器的备份策略。

MonthlyRetentionSchedule

每月保留计划。

MonthOfYear

年度保留策略的月份列表。

PolicyType

备份策略类型

ProtectionPolicyResource

备份策略的基类。 特定于工作负荷的备份策略派生自此类。

RetentionDuration

保留期。

RetentionDurationType

保留持续时间类型:仅当 TieringMode 设置为 TierAfter 时使用天数/周/月/年

RetentionScheduleFormat

每月保留策略的保留计划格式类型。

ScheduleRunType

此策略的计划操作的频率。

Settings

备份管理的常见设置字段

SimpleRetentionPolicy

简单策略保留。

SimpleSchedulePolicy

简单的策略计划。

SimpleSchedulePolicyV2

支持每小时备份的 IaaS 的 V2 策略计划。

SnapshotBackupAdditionalDetails

WorkloadType SaPHanaSystem 的快照备份相关字段

SubProtectionPolicy

包括计划和保留的子保护策略

TieringMode

分层模式用于控制恢复点的自动分层。 支持的值包括:

  1. TierRecommended:对建议分层的所有恢复点进行分层
  2. TierAfter:按以下持续时间 + durationType 指定,在固定时间段后对所有恢复点进行分层。
  3. DoNotTier:不要对任何恢复点进行分层
TieringPolicy

目标层的分层策略。 如果未为给定的目标层指定策略,服务将保留该层的现有已配置分层策略

UserAssignedIdentityProperties

用户分配的托管标识属性

UserAssignedManagedIdentityDetails

用户分配的托管标识详细信息

VaultRetentionPolicy

AzureFileShare 的保管库保留策略

WeeklyRetentionFormat

每周保留格式。

WeeklyRetentionSchedule

每周保留计划。

WeeklySchedule
WeekOfMonth

月数周的列表。

WorkloadType

备份管理的工作负荷类型

YearlyRetentionSchedule

每年保留计划。

AzureFileShareProtectionPolicy

AzureStorage 备份策略。

名称 类型 说明
backupManagementType string:

AzureStorage

此属性将用作用于确定类型多态链中特定类型的鉴别器。

protectedItemsCount

integer

与此策略关联的项数。

resourceGuardOperationRequests

string[]

ResourceGuard 操作请求

retentionPolicy RetentionPolicy:

保留策略,其中包含有关备份复制保留范围的详细信息。

schedulePolicy SchedulePolicy:

备份计划指定为备份策略的一部分。

timeZone

string

时区可选输入作为字符串。 例如:TimeZone = “Pacific Standard Time”。

vaultRetentionPolicy

VaultRetentionPolicy

保留策略,其中包含强化备份复制保留范围的详细信息。

workLoadType

WorkloadType

备份管理的工作负荷类型

AzureIaaSVMProtectionPolicy

特定于 IaaS VM 工作负荷的备份策略。

名称 类型 说明
backupManagementType string:

AzureIaasVM

此属性将用作用于确定类型多态链中特定类型的鉴别器。

instantRPDetails

InstantRPAdditionalDetails

instantRpRetentionRangeInDays

integer

即时 RP 保留策略范围(以天为单位)

policyType

IAASVMPolicyType

protectedItemsCount

integer

与此策略关联的项数。

resourceGuardOperationRequests

string[]

ResourceGuard 操作请求

retentionPolicy RetentionPolicy:

保留策略,其中包含有关备份复制保留范围的详细信息。

schedulePolicy SchedulePolicy:

备份计划指定为备份策略的一部分。

snapshotConsistencyType

IaasVMSnapshotConsistencyType

tieringPolicy

<string,  TieringPolicy>

将 RP 自动移动到另一层密钥的分层策略是在 RecoveryPointTierType 枚举中定义的目标层。 分层策略指定将 RP 移动到目标层的条件。

timeZone

string

时区可选输入作为字符串。 例如:TimeZone = “Pacific Standard Time”。

AzureSqlProtectionPolicy

特定于 Azure SQL 工作负荷的备份策略。

名称 类型 说明
backupManagementType string:

AzureSql

此属性将用作用于确定类型多态链中特定类型的鉴别器。

protectedItemsCount

integer

与此策略关联的项数。

resourceGuardOperationRequests

string[]

ResourceGuard 操作请求

retentionPolicy RetentionPolicy:

保留策略详细信息。

AzureVmWorkloadProtectionPolicy

特定于 Azure VM(Mercury)工作负荷的备份策略。

名称 类型 说明
backupManagementType string:

AzureWorkload

此属性将用作用于确定类型多态链中特定类型的鉴别器。

makePolicyConsistent

boolean

修复策略不一致问题

protectedItemsCount

integer

与此策略关联的项数。

resourceGuardOperationRequests

string[]

ResourceGuard 操作请求

settings

Settings

备份管理的常见设置

subProtectionPolicy

SubProtectionPolicy[]

包括计划和保留的子保护策略列表

workLoadType

WorkloadType

备份管理的工作负荷类型

CloudError

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

名称 类型 说明
error

CloudErrorBody

错误对象。

CloudErrorBody

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

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误的标识符。 代码是固定的,旨在以编程方式使用。

details

CloudErrorBody[]

有关错误的其他详细信息的列表。

message

string

描述错误的消息,旨在适合在用户界面中显示。

target

string

特定错误的目标。 例如,错误属性的名称。

DailyRetentionFormat

每日保留格式。

名称 类型 说明
daysOfTheMonth

Day[]

月份的天数列表。

DailyRetentionSchedule

每日保留计划。

名称 类型 说明
retentionDuration

RetentionDuration

保留策略的保留期。

retentionTimes

string[]

保留策略的保留时间。

DailySchedule

名称 类型 说明
scheduleRunTimes

string[]

此计划必须运行的一天时间列表。

Day

一周中的一天。

名称 类型 说明
date

integer

月份的日期

isLast

boolean

日期是否为月份的最后一个日期

DayOfWeek

名称 类型 说明
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

GenericProtectionPolicy

特定于 Azure VM(Mercury)工作负荷的备份策略。

名称 类型 说明
backupManagementType string:

GenericProtectionPolicy

此属性将用作用于确定类型多态链中特定类型的鉴别器。

fabricName

string

此策略的结构的名称。

protectedItemsCount

integer

与此策略关联的项数。

resourceGuardOperationRequests

string[]

ResourceGuard 操作请求

subProtectionPolicy

SubProtectionPolicy[]

包括计划和保留的子保护策略列表

timeZone

string

时区可选输入作为字符串。 例如:TimeZone = “Pacific Standard Time”。

HourlySchedule

名称 类型 说明
interval

integer

需要触发备份的间隔。 对于每小时,该值可以为 4/6/8/12

scheduleWindowDuration

integer

指定备份窗口的持续时间

scheduleWindowStartTime

string

指定备份窗口的开始时间

IAASVMPolicyType

名称 类型 说明
Invalid

string

V1

string

V2

string

IaasVMSnapshotConsistencyType

名称 类型 说明
OnlyCrashConsistent

string

InstantRPAdditionalDetails

名称 类型 说明
azureBackupRGNamePrefix

string

azureBackupRGNameSuffix

string

LogSchedulePolicy

日志策略计划。

名称 类型 说明
scheduleFrequencyInMins

integer

此策略的日志计划操作频率(以分钟为单位)。

schedulePolicyType string:

LogSchedulePolicy

此属性将用作用于确定类型多态链中特定类型的鉴别器。

LongTermRetentionPolicy

长期保留策略。

名称 类型 说明
dailySchedule

DailyRetentionSchedule

保护策略的每日保留计划。

monthlySchedule

MonthlyRetentionSchedule

保护策略的每月保留计划。

retentionPolicyType string:

LongTermRetentionPolicy

此属性将用作用于确定类型多态链中特定类型的鉴别器。

weeklySchedule

WeeklyRetentionSchedule

保护策略的每周保留计划。

yearlySchedule

YearlyRetentionSchedule

保护策略的每年保留计划。

LongTermSchedulePolicy

长期策略计划。

名称 类型 说明
schedulePolicyType string:

LongTermSchedulePolicy

此属性将用作用于确定类型多态链中特定类型的鉴别器。

MabProtectionPolicy

特定于 Mab 容器的备份策略。

名称 类型 说明
backupManagementType string:

MAB

此属性将用作用于确定类型多态链中特定类型的鉴别器。

protectedItemsCount

integer

与此策略关联的项数。

resourceGuardOperationRequests

string[]

ResourceGuard 操作请求

retentionPolicy RetentionPolicy:

保留策略详细信息。

schedulePolicy SchedulePolicy:

备份策略的备份计划。

MonthlyRetentionSchedule

每月保留计划。

名称 类型 说明
retentionDuration

RetentionDuration

保留策略的保留期。

retentionScheduleDaily

DailyRetentionFormat

每月保留策略的每日保留格式。

retentionScheduleFormatType

RetentionScheduleFormat

每月保留策略的保留计划格式类型。

retentionScheduleWeekly

WeeklyRetentionFormat

每月保留策略的每周保留格式。

retentionTimes

string[]

保留策略的保留时间。

MonthOfYear

年度保留策略的月份列表。

名称 类型 说明
April

string

August

string

December

string

February

string

Invalid

string

January

string

July

string

June

string

March

string

May

string

November

string

October

string

September

string

PolicyType

备份策略类型

名称 类型 说明
CopyOnlyFull

string

Differential

string

Full

string

Incremental

string

Invalid

string

Log

string

SnapshotCopyOnlyFull

string

SnapshotFull

string

ProtectionPolicyResource

备份策略的基类。 特定于工作负荷的备份策略派生自此类。

名称 类型 说明
eTag

string

可选 ETag。

id

string

资源 ID 表示资源的完整路径。

location

string

资源位置。

name

string

与资源关联的资源名称。

properties ProtectionPolicy:

ProtectionPolicyResource 属性

tags

object

资源标记。

type

string

资源类型表示命名空间/ResourceType/ResourceType/...

RetentionDuration

保留期。

名称 类型 说明
count

integer

持续时间类型的计数。 保留期是通过计数类型计数时间获取的。 例如,当 Count = 3 且 DurationType = Weeks 时,保留期将为 3 周。

durationType

RetentionDurationType

保留期策略的保留期类型。

RetentionDurationType

保留持续时间类型:仅当 TieringMode 设置为 TierAfter 时使用天数/周/月/年

名称 类型 说明
Days

string

Invalid

string

Months

string

Weeks

string

Years

string

RetentionScheduleFormat

每月保留策略的保留计划格式类型。

名称 类型 说明
Daily

string

Invalid

string

Weekly

string

ScheduleRunType

此策略的计划操作的频率。

名称 类型 说明
Daily

string

Hourly

string

Invalid

string

Weekly

string

Settings

备份管理的常见设置字段

名称 类型 说明
isCompression

boolean

工作负荷压缩标志。 已添加此项,以便在客户端升级后弃用“isSqlCompression”来考虑此标志。

issqlcompression

boolean

SQL 压缩标志

timeZone

string

时区可选输入作为字符串。 例如:TimeZone = “Pacific Standard Time”。

SimpleRetentionPolicy

简单策略保留。

名称 类型 说明
retentionDuration

RetentionDuration

保护策略的保留期。

retentionPolicyType string:

SimpleRetentionPolicy

此属性将用作用于确定类型多态链中特定类型的鉴别器。

SimpleSchedulePolicy

简单的策略计划。

名称 类型 说明
hourlySchedule

HourlySchedule

此策略的每小时计划

schedulePolicyType string:

SimpleSchedulePolicy

此属性将用作用于确定类型多态链中特定类型的鉴别器。

scheduleRunDays

DayOfWeek[]

此计划必须运行每周天数的列表。

scheduleRunFrequency

ScheduleRunType

此策略的计划操作的频率。

scheduleRunTimes

string[]

此计划必须运行的一天时间列表。

scheduleWeeklyFrequency

integer

在每几个星期,必须运行此计划。

SimpleSchedulePolicyV2

支持每小时备份的 IaaS 的 V2 策略计划。

名称 类型 说明
dailySchedule

DailySchedule

此策略的每日计划

hourlySchedule

HourlySchedule

此策略的每小时计划

schedulePolicyType string:

SimpleSchedulePolicyV2

此属性将用作用于确定类型多态链中特定类型的鉴别器。

scheduleRunFrequency

ScheduleRunType

此策略的计划操作的频率。

weeklySchedule

WeeklySchedule

此策略的每周计划

SnapshotBackupAdditionalDetails

WorkloadType SaPHanaSystem 的快照备份相关字段

名称 类型 说明
instantRPDetails

string

instantRpRetentionRangeInDays

integer

userAssignedManagedIdentityDetails

UserAssignedManagedIdentityDetails

用户分配的托管标识详细信息

SubProtectionPolicy

包括计划和保留的子保护策略

名称 类型 说明
policyType

PolicyType

备份策略类型

retentionPolicy RetentionPolicy:

保留策略,其中包含有关备份复制保留范围的详细信息。

schedulePolicy SchedulePolicy:

备份计划指定为备份策略的一部分。

snapshotBackupAdditionalDetails

SnapshotBackupAdditionalDetails

WorkloadType SaPHanaSystem 的快照备份相关字段

tieringPolicy

<string,  TieringPolicy>

分层策略,用于自动将 RP 移到另一层。 密钥是在 RecoveryPointTierType 枚举中定义的目标层。 分层策略指定将 RP 移动到目标层的条件。

TieringMode

分层模式用于控制恢复点的自动分层。 支持的值包括:

  1. TierRecommended:对建议分层的所有恢复点进行分层
  2. TierAfter:按以下持续时间 + durationType 指定,在固定时间段后对所有恢复点进行分层。
  3. DoNotTier:不要对任何恢复点进行分层
名称 类型 说明
DoNotTier

string

Invalid

string

TierAfter

string

TierRecommended

string

TieringPolicy

目标层的分层策略。 如果未为给定的目标层指定策略,服务将保留该层的现有已配置分层策略

名称 类型 说明
duration

integer

在分层之前,在当前层中保留备份的天数/周/月/年数。 仅在 TieringMode 设置为 TierAfter 时才使用

durationType

RetentionDurationType

保留持续时间类型:仅当 TieringMode 设置为 TierAfter 时使用天数/周/月/年

tieringMode

TieringMode

分层模式用于控制恢复点的自动分层。 支持的值包括:

  1. TierRecommended:对建议分层的所有恢复点进行分层
  2. TierAfter:按以下持续时间 + durationType 指定,在固定时间段后对所有恢复点进行分层。
  3. DoNotTier:不要对任何恢复点进行分层

UserAssignedIdentityProperties

用户分配的托管标识属性

名称 类型 说明
clientId

string

分配的标识的客户端 ID。

principalId

string

已分配标识的主体 ID。

UserAssignedManagedIdentityDetails

用户分配的托管标识详细信息

名称 类型 说明
identityArmId

string

已分配标识的 ARM ID。

identityName

string

分配的标识的名称。

userAssignedIdentityProperties

UserAssignedIdentityProperties

用户分配的托管标识属性

VaultRetentionPolicy

AzureFileShare 的保管库保留策略

名称 类型 说明
snapshotRetentionInDays

integer

vaultRetention RetentionPolicy:

保留策略的基类。

WeeklyRetentionFormat

每周保留格式。

名称 类型 说明
daysOfTheWeek

DayOfWeek[]

一周中的天数列表。

weeksOfTheMonth

WeekOfMonth[]

月数周的列表。

WeeklyRetentionSchedule

每周保留计划。

名称 类型 说明
daysOfTheWeek

DayOfWeek[]

每周保留策略的星期几列表。

retentionDuration

RetentionDuration

保留策略的保留期。

retentionTimes

string[]

保留策略的保留时间。

WeeklySchedule

名称 类型 说明
scheduleRunDays

DayOfWeek[]

scheduleRunTimes

string[]

此计划必须运行的一天时间列表。

WeekOfMonth

月数周的列表。

名称 类型 说明
First

string

Fourth

string

Invalid

string

Last

string

Second

string

Third

string

WorkloadType

备份管理的工作负荷类型

名称 类型 说明
AzureFileShare

string

AzureSqlDb

string

Client

string

Exchange

string

FileFolder

string

GenericDataSource

string

Invalid

string

SAPAseDatabase

string

SAPHanaDBInstance

string

SAPHanaDatabase

string

SQLDB

string

SQLDataBase

string

Sharepoint

string

SystemState

string

VM

string

VMwareVM

string

YearlyRetentionSchedule

每年保留计划。

名称 类型 说明
monthsOfYear

MonthOfYear[]

年度保留策略的月份列表。

retentionDuration

RetentionDuration

保留策略的保留期。

retentionScheduleDaily

DailyRetentionFormat

每年保留策略的每日保留格式。

retentionScheduleFormatType

RetentionScheduleFormat

每年保留策略的保留计划格式。

retentionScheduleWeekly

WeeklyRetentionFormat

每年保留策略的每周保留格式。

retentionTimes

string[]

保留策略的保留时间。