Protection Policies - Get

Service:

Recovery Services - Backup

API Version:

2023-02-01

Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.

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

URI Parameters

Name	In	Required	Type	Description
policyName	path	True	string	Backup policy information to be fetched.
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.

Responses

Name	Type	Description
200 OK	ProtectionPolicyResource	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 Azure IaasVm Enhanced Protection Policy Details

Get Azure IaasVm Protection Policy Details

Get Azure IaasVm Enhanced Protection Policy Details

Sample request

HTTP

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

Java

/** Samples for ProtectionPolicies Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/V2Policy/v2-Get-Policy.json
     */
    /**
     * Sample code: Get Azure IaasVm Enhanced Protection Policy Details.
     *
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void getAzureIaasVmEnhancedProtectionPolicyDetails(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager
            .protectionPolicies()
            .getWithResponse("NetSDKTestRsVault", "SwaggerTestRg", "v2-daily-sample", 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 v2_get_policy.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.protection_policies.get(
        vault_name="NetSDKTestRsVault",
        resource_group_name="SwaggerTestRg",
        policy_name="v2-daily-sample",
    )
    print(response)


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/V2Policy/v2-Get-Policy.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/AzureIaasVm/V2Policy/v2-Get-Policy.json
func ExampleProtectionPoliciesClient_Get_getAzureIaasVmEnhancedProtectionPolicyDetails() {
	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)
	}
	res, err := clientFactory.NewProtectionPoliciesClient().Get(ctx, "NetSDKTestRsVault", "SwaggerTestRg", "v2-daily-sample", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ProtectionPolicyResource = armrecoveryservicesbackup.ProtectionPolicyResource{
	// 	Name: to.Ptr("v2-daily-sample"),
	// 	Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/v2-daily-sample"),
	// 	Properties: &armrecoveryservicesbackup.AzureIaaSVMProtectionPolicy{
	// 		BackupManagementType: to.Ptr("AzureIaasVM"),
	// 		ProtectedItemsCount: to.Ptr[int32](0),
	// 		InstantRpRetentionRangeInDays: to.Ptr[int32](30),
	// 		PolicyType: to.Ptr(armrecoveryservicesbackup.IAASVMPolicyTypeV2),
	// 		RetentionPolicy: &armrecoveryservicesbackup.LongTermRetentionPolicy{
	// 			RetentionPolicyType: to.Ptr("LongTermRetentionPolicy"),
	// 			DailySchedule: &armrecoveryservicesbackup.DailyRetentionSchedule{
	// 				RetentionDuration: &armrecoveryservicesbackup.RetentionDuration{
	// 					Count: to.Ptr[int32](1),
	// 					DurationType: to.Ptr(armrecoveryservicesbackup.RetentionDurationTypeDays),
	// 				},
	// 				RetentionTimes: []*time.Time{
	// 					to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-24T02:00:00Z"); return t}())},
	// 				},
	// 			},
	// 			SchedulePolicy: &armrecoveryservicesbackup.SimpleSchedulePolicyV2{
	// 				SchedulePolicyType: to.Ptr("SimpleSchedulePolicyV2"),
	// 				DailySchedule: &armrecoveryservicesbackup.DailySchedule{
	// 					ScheduleRunTimes: []*time.Time{
	// 						to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-24T10:00:00Z"); return t}())},
	// 					},
	// 					ScheduleRunFrequency: to.Ptr(armrecoveryservicesbackup.ScheduleRunTypeDaily),
	// 				},
	// 				TimeZone: to.Ptr("Pacific Standard Time"),
	// 			},
	// 		}
}

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 the details of the backup policies associated to Recovery Services Vault. This is an asynchronous
operation. Status of the operation can be fetched using GetPolicyOperationResult API.
 *
 * @summary Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous
operation. Status of the operation can be fetched using GetPolicyOperationResult API.
 * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/V2Policy/v2-Get-Policy.json
 */
async function getAzureIaasVMEnhancedProtectionPolicyDetails() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "NetSDKTestRsVault";
  const resourceGroupName = process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "SwaggerTestRg";
  const policyName = "v2-daily-sample";
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const result = await client.protectionPolicies.get(vaultName, resourceGroupName, policyName);
  console.log(result);
}

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;
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/AzureIaasVm/V2Policy/v2-Get-Policy.json
// this example is just showing the usage of "ProtectionPolicies_Get" 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 = "SwaggerTestRg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this BackupProtectionPolicyResource
string vaultName = "NetSDKTestRsVault";
BackupProtectionPolicyCollection collection = resourceGroupResource.GetBackupProtectionPolicies(vaultName);

// invoke the operation
string policyName = "v2-daily-sample";
bool result = await collection.ExistsAsync(policyName);

Console.WriteLine($"Succeeded: {result}");

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

{
  "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",
    "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

Sample request

HTTP

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

Java

/** Samples for ProtectionPolicies Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/ProtectionPolicies_Get.json
     */
    /**
     * Sample code: Get Azure IaasVm Protection Policy Details.
     *
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void getAzureIaasVmProtectionPolicyDetails(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager
            .protectionPolicies()
            .getWithResponse("NetSDKTestRsVault", "SwaggerTestRg", "testPolicy1", 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 protection_policies_get.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.protection_policies.get(
        vault_name="NetSDKTestRsVault",
        resource_group_name="SwaggerTestRg",
        policy_name="testPolicy1",
    )
    print(response)


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/ProtectionPolicies_Get.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/AzureIaasVm/ProtectionPolicies_Get.json
func ExampleProtectionPoliciesClient_Get_getAzureIaasVmProtectionPolicyDetails() {
	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)
	}
	res, err := clientFactory.NewProtectionPoliciesClient().Get(ctx, "NetSDKTestRsVault", "SwaggerTestRg", "testPolicy1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ProtectionPolicyResource = armrecoveryservicesbackup.ProtectionPolicyResource{
	// 	Name: to.Ptr("testPolicy1"),
	// 	Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupPolicies"),
	// 	ID: to.Ptr("/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1"),
	// 	Properties: &armrecoveryservicesbackup.AzureIaaSVMProtectionPolicy{
	// 		BackupManagementType: to.Ptr("AzureIaasVM"),
	// 		ProtectedItemsCount: to.Ptr[int32](0),
	// 		RetentionPolicy: &armrecoveryservicesbackup.LongTermRetentionPolicy{
	// 			RetentionPolicyType: to.Ptr("LongTermRetentionPolicy"),
	// 			DailySchedule: &armrecoveryservicesbackup.DailyRetentionSchedule{
	// 				RetentionDuration: &armrecoveryservicesbackup.RetentionDuration{
	// 					Count: to.Ptr[int32](1),
	// 					DurationType: to.Ptr(armrecoveryservicesbackup.RetentionDurationTypeDays),
	// 				},
	// 				RetentionTimes: []*time.Time{
	// 					to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-24T02:00:00Z"); return t}())},
	// 				},
	// 			},
	// 			SchedulePolicy: &armrecoveryservicesbackup.SimpleSchedulePolicy{
	// 				SchedulePolicyType: to.Ptr("SimpleSchedulePolicy"),
	// 				ScheduleRunFrequency: to.Ptr(armrecoveryservicesbackup.ScheduleRunTypeDaily),
	// 				ScheduleRunTimes: []*time.Time{
	// 					to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-24T02:00:00Z"); return t}())},
	// 					ScheduleWeeklyFrequency: to.Ptr[int32](0),
	// 				},
	// 				TimeZone: to.Ptr("Pacific Standard Time"),
	// 			},
	// 		}
}

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 the details of the backup policies associated to Recovery Services Vault. This is an asynchronous
operation. Status of the operation can be fetched using GetPolicyOperationResult API.
 *
 * @summary Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous
operation. Status of the operation can be fetched using GetPolicyOperationResult API.
 * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/examples/AzureIaasVm/ProtectionPolicies_Get.json
 */
async function getAzureIaasVMProtectionPolicyDetails() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "NetSDKTestRsVault";
  const resourceGroupName = process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "SwaggerTestRg";
  const policyName = "testPolicy1";
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const result = await client.protectionPolicies.get(vaultName, resourceGroupName, policyName);
  console.log(result);
}

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;
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/AzureIaasVm/ProtectionPolicies_Get.json
// this example is just showing the usage of "ProtectionPolicies_Get" 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 = "SwaggerTestRg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this BackupProtectionPolicyResource
string vaultName = "NetSDKTestRsVault";
BackupProtectionPolicyCollection collection = resourceGroupResource.GetBackupProtectionPolicies(vaultName);

// invoke the operation
string policyName = "testPolicy1";
bool result = await collection.ExistsAsync(policyName);

Console.WriteLine($"Succeeded: {result}");

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

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

Definitions

Name	Description
AzureFileShareProtectionPolicy	AzureStorage backup policy.
AzureIaaSVMProtectionPolicy	IaaS VM workload-specific backup policy.
AzureSqlProtectionPolicy	Azure SQL workload-specific backup policy.
AzureVmWorkloadProtectionPolicy	Azure VM (Mercury) workload-specific backup policy.
CloudError	An error response from the Container Instance service.
CloudErrorBody	An error response from the Container Instance service.
DailyRetentionFormat	Daily retention format.
DailyRetentionSchedule	Daily retention schedule.
DailySchedule
Day	Day of the week.
DayOfWeek
ErrorAdditionalInfo	The resource management error additional info.
GenericProtectionPolicy	Azure VM (Mercury) workload-specific backup policy.
HourlySchedule
IAASVMPolicyType
InstantRPAdditionalDetails
LogSchedulePolicy	Log policy schedule.
LongTermRetentionPolicy	Long term retention policy.
LongTermSchedulePolicy	Long term policy schedule.
MabProtectionPolicy	Mab container-specific backup policy.
MonthlyRetentionSchedule	Monthly retention schedule.
MonthOfYear	List of months of year of yearly retention policy.
PolicyType	Type of backup policy type
ProtectionPolicyResource	Base class for backup policy. Workload-specific backup policies are derived from this class.
RetentionDuration	Retention duration.
RetentionDurationType	Retention duration type: days/weeks/months/years Used only if TieringMode is set to TierAfter
RetentionScheduleFormat	Retention schedule format type for monthly retention policy.
ScheduleRunType	Frequency of the schedule operation of this policy.
Settings	Common settings field for backup management
SimpleRetentionPolicy	Simple policy retention.
SimpleSchedulePolicy	Simple policy schedule.
SimpleSchedulePolicyV2	The V2 policy schedule for IaaS that supports hourly backups.
SubProtectionPolicy	Sub-protection policy which includes schedule and retention
TieringMode	Tiering Mode to control automatic tiering of recovery points. Supported values are: TierRecommended: Tier all recovery points recommended to be tiered TierAfter: Tier all recovery points after a fixed period, as specified in duration + durationType below. DoNotTier: Do not tier any recovery points
TieringPolicy	Tiering Policy for a target tier. If the policy is not specified for a given target tier, service retains the existing configured tiering policy for that tier
WeeklyRetentionFormat	Weekly retention format.
WeeklyRetentionSchedule	Weekly retention schedule.
WeeklySchedule
WeekOfMonth	List of weeks of month.
WorkloadType	Type of workload for the backup management
YearlyRetentionSchedule	Yearly retention schedule.

AzureFileShareProtectionPolicy

AzureStorage backup policy.

Name	Type	Description
backupManagementType	string: AzureStorage	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
protectedItemsCount	integer	Number of items associated with this policy.
resourceGuardOperationRequests	string[]	ResourceGuard Operation Requests
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Retention policy with the details on backup copy retention ranges.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Backup schedule specified as part of backup policy.
timeZone	string	TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".
workLoadType	WorkloadType	Type of workload for the backup management

AzureIaaSVMProtectionPolicy

IaaS VM workload-specific backup policy.

Name	Type	Description
backupManagementType	string: AzureIaasVM	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
instantRPDetails	InstantRPAdditionalDetails
instantRpRetentionRangeInDays	integer	Instant RP retention policy range in days
policyType	IAASVMPolicyType
protectedItemsCount	integer	Number of items associated with this policy.
resourceGuardOperationRequests	string[]	ResourceGuard Operation Requests
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Retention policy with the details on backup copy retention ranges.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Backup schedule specified as part of backup policy.
tieringPolicy	<string,  TieringPolicy>	Tiering policy to automatically move RPs to another tier Key is Target Tier, defined in RecoveryPointTierType enum. Tiering policy specifies the criteria to move RP to the target tier.
timeZone	string	TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".

AzureSqlProtectionPolicy

Azure SQL workload-specific backup policy.

Name	Type	Description
backupManagementType	string: AzureSql	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
protectedItemsCount	integer	Number of items associated with this policy.
resourceGuardOperationRequests	string[]	ResourceGuard Operation Requests
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Retention policy details.

AzureVmWorkloadProtectionPolicy

Azure VM (Mercury) workload-specific backup policy.

Name	Type	Description
backupManagementType	string: AzureWorkload	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
makePolicyConsistent	boolean	Fix the policy inconsistency
protectedItemsCount	integer	Number of items associated with this policy.
resourceGuardOperationRequests	string[]	ResourceGuard Operation Requests
settings	Settings	Common settings for the backup management
subProtectionPolicy	SubProtectionPolicy[]	List of sub-protection policies which includes schedule and retention
workLoadType	WorkloadType	Type of workload for the backup management

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.

DailyRetentionFormat

Daily retention format.

Name	Type	Description
daysOfTheMonth	Day[]	List of days of the month.

DailyRetentionSchedule

Daily retention schedule.

Name	Type	Description
retentionDuration	RetentionDuration	Retention duration of retention Policy.
retentionTimes	string[]	Retention times of retention policy.

DailySchedule

Name	Type	Description
scheduleRunTimes	string[]	List of times of day this schedule has to be run.

Day

Day of the week.

Name	Type	Description
date	integer	Date of the month
isLast	boolean	Whether Date is last date of month

DayOfWeek

Name	Type	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ErrorAdditionalInfo

The resource management error additional info.

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

GenericProtectionPolicy

Azure VM (Mercury) workload-specific backup policy.

Name	Type	Description
backupManagementType	string: GenericProtectionPolicy	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
fabricName	string	Name of this policy's fabric.
protectedItemsCount	integer	Number of items associated with this policy.
resourceGuardOperationRequests	string[]	ResourceGuard Operation Requests
subProtectionPolicy	SubProtectionPolicy[]	List of sub-protection policies which includes schedule and retention
timeZone	string	TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".

HourlySchedule

Name	Type	Description
interval	integer	Interval at which backup needs to be triggered. For hourly the value can be 4/6/8/12
scheduleWindowDuration	integer	To specify duration of the backup window
scheduleWindowStartTime	string	To specify start time of the backup window

IAASVMPolicyType

Name	Type	Description
Invalid	string
V1	string
V2	string

InstantRPAdditionalDetails

Name	Type	Description
azureBackupRGNamePrefix	string
azureBackupRGNameSuffix	string

LogSchedulePolicy

Log policy schedule.

Name	Type	Description
scheduleFrequencyInMins	integer	Frequency of the log schedule operation of this policy in minutes.
schedulePolicyType	string: LogSchedulePolicy	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.

LongTermRetentionPolicy

Long term retention policy.

Name	Type	Description
dailySchedule	DailyRetentionSchedule	Daily retention schedule of the protection policy.
monthlySchedule	MonthlyRetentionSchedule	Monthly retention schedule of the protection policy.
retentionPolicyType	string: LongTermRetentionPolicy	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
weeklySchedule	WeeklyRetentionSchedule	Weekly retention schedule of the protection policy.
yearlySchedule	YearlyRetentionSchedule	Yearly retention schedule of the protection policy.

LongTermSchedulePolicy

Long term policy schedule.

Name	Type	Description
schedulePolicyType	string: LongTermSchedulePolicy	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.

MabProtectionPolicy

Mab container-specific backup policy.

Name	Type	Description
backupManagementType	string: MAB	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
protectedItemsCount	integer	Number of items associated with this policy.
resourceGuardOperationRequests	string[]	ResourceGuard Operation Requests
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Retention policy details.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Backup schedule of backup policy.

MonthlyRetentionSchedule

Monthly retention schedule.

Name	Type	Description
retentionDuration	RetentionDuration	Retention duration of retention Policy.
retentionScheduleDaily	DailyRetentionFormat	Daily retention format for monthly retention policy.
retentionScheduleFormatType	RetentionScheduleFormat	Retention schedule format type for monthly retention policy.
retentionScheduleWeekly	WeeklyRetentionFormat	Weekly retention format for monthly retention policy.
retentionTimes	string[]	Retention times of retention policy.

MonthOfYear

List of months of year of yearly retention policy.

Name	Type	Description
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

Type of backup policy type

Name	Type	Description
CopyOnlyFull	string
Differential	string
Full	string
Incremental	string
Invalid	string
Log	string
SnapshotCopyOnlyFull	string
SnapshotFull	string

ProtectionPolicyResource

Base class for backup policy. Workload-specific backup policies are derived from this 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	ProtectionPolicy: AzureFileShareProtectionPolicy AzureIaaSVMProtectionPolicy AzureSqlProtectionPolicy AzureVmWorkloadProtectionPolicy GenericProtectionPolicy MabProtectionPolicy	ProtectionPolicyResource properties
tags	object	Resource tags.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

RetentionDuration

Retention duration.

Name	Type	Description
count	integer	Count of duration types. Retention duration is obtained by the counting the duration type Count times. For example, when Count = 3 and DurationType = Weeks, retention duration will be three weeks.
durationType	RetentionDurationType	Retention duration type of retention policy.

RetentionDurationType

Retention duration type: days/weeks/months/years Used only if TieringMode is set to TierAfter

Name	Type	Description
Days	string
Invalid	string
Months	string
Weeks	string
Years	string

RetentionScheduleFormat

Retention schedule format type for monthly retention policy.

Name	Type	Description
Daily	string
Invalid	string
Weekly	string

ScheduleRunType

Frequency of the schedule operation of this policy.

Name	Type	Description
Daily	string
Hourly	string
Invalid	string
Weekly	string

Settings

Common settings field for backup management

Name	Type	Description
isCompression	boolean	Workload compression flag. This has been added so that 'isSqlCompression' will be deprecated once clients upgrade to consider this flag.
issqlcompression	boolean	SQL compression flag
timeZone	string	TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".

SimpleRetentionPolicy

Simple policy retention.

Name	Type	Description
retentionDuration	RetentionDuration	Retention duration of the protection policy.
retentionPolicyType	string: SimpleRetentionPolicy	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.

SimpleSchedulePolicy

Simple policy schedule.

Name	Type	Description
hourlySchedule	HourlySchedule	Hourly Schedule of this Policy
schedulePolicyType	string: SimpleSchedulePolicy	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
scheduleRunDays	DayOfWeek[]	List of days of week this schedule has to be run.
scheduleRunFrequency	ScheduleRunType	Frequency of the schedule operation of this policy.
scheduleRunTimes	string[]	List of times of day this schedule has to be run.
scheduleWeeklyFrequency	integer	At every number weeks this schedule has to be run.

SimpleSchedulePolicyV2

The V2 policy schedule for IaaS that supports hourly backups.

Name	Type	Description
dailySchedule	DailySchedule	Daily schedule of this policy
hourlySchedule	HourlySchedule	hourly schedule of this policy
schedulePolicyType	string: SimpleSchedulePolicyV2	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
scheduleRunFrequency	ScheduleRunType	Frequency of the schedule operation of this policy.
weeklySchedule	WeeklySchedule	Weekly schedule of this policy

SubProtectionPolicy

Sub-protection policy which includes schedule and retention

Name	Type	Description
policyType	PolicyType	Type of backup policy type
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Retention policy with the details on backup copy retention ranges.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Backup schedule specified as part of backup policy.
tieringPolicy	<string,  TieringPolicy>	Tiering policy to automatically move RPs to another tier. Key is Target Tier, defined in RecoveryPointTierType enum. Tiering policy specifies the criteria to move RP to the target tier.

TieringMode

Tiering Mode to control automatic tiering of recovery points. Supported values are:

1. TierRecommended: Tier all recovery points recommended to be tiered
2. TierAfter: Tier all recovery points after a fixed period, as specified in duration + durationType below.
3. DoNotTier: Do not tier any recovery points

Name	Type	Description
DoNotTier	string
Invalid	string
TierAfter	string
TierRecommended	string

TieringPolicy

Tiering Policy for a target tier. If the policy is not specified for a given target tier, service retains the existing configured tiering policy for that tier

Name	Type	Description
duration	integer	Number of days/weeks/months/years to retain backups in current tier before tiering. Used only if TieringMode is set to TierAfter
durationType	RetentionDurationType	Retention duration type: days/weeks/months/years Used only if TieringMode is set to TierAfter
tieringMode	TieringMode	Tiering Mode to control automatic tiering of recovery points. Supported values are: TierRecommended: Tier all recovery points recommended to be tiered TierAfter: Tier all recovery points after a fixed period, as specified in duration + durationType below. DoNotTier: Do not tier any recovery points

WeeklyRetentionFormat

Weekly retention format.

Name	Type	Description
daysOfTheWeek	DayOfWeek[]	List of days of the week.
weeksOfTheMonth	WeekOfMonth[]	List of weeks of month.

WeeklyRetentionSchedule

Weekly retention schedule.

Name	Type	Description
daysOfTheWeek	DayOfWeek[]	List of days of week for weekly retention policy.
retentionDuration	RetentionDuration	Retention duration of retention Policy.
retentionTimes	string[]	Retention times of retention policy.

WeeklySchedule

Name	Type	Description
scheduleRunDays	DayOfWeek[]
scheduleRunTimes	string[]	List of times of day this schedule has to be run.

WeekOfMonth

List of weeks of month.

Name	Type	Description
First	string
Fourth	string
Invalid	string
Last	string
Second	string
Third	string

WorkloadType

Type of workload for the backup management

Name	Type	Description
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

Yearly retention schedule.

Name	Type	Description
monthsOfYear	MonthOfYear[]	List of months of year of yearly retention policy.
retentionDuration	RetentionDuration	Retention duration of retention Policy.
retentionScheduleDaily	DailyRetentionFormat	Daily retention format for yearly retention policy.
retentionScheduleFormatType	RetentionScheduleFormat	Retention schedule format for yearly retention policy.
retentionScheduleWeekly	WeeklyRetentionFormat	Weekly retention format for yearly retention policy.
retentionTimes	string[]	Retention times of retention policy.