Update Backup Policy

  • Article

Updates the backup policy.

Updates the backup policy identified by {backupPolicyName}

Request

Method Request URI
POST /BackupRestore/BackupPolicies/{backupPolicyName}/$/Update?api-version=6.4&timeout={timeout}&ValidateConnection={ValidateConnection}

Parameters

Name Type Required Location
backupPolicyName string Yes Path
api-version string Yes Query
timeout integer (int64) No Query
ValidateConnection boolean No Query
BackupPolicyDescription BackupPolicyDescription Yes Body

backupPolicyName

Type: string
Required: Yes

The name of the backup policy.

api-version

Type: string
Required: Yes
Default: 6.4

The version of the API. This parameter is required and its value must be '6.4'.

Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.

Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.

timeout

Type: integer (int64)
Required: No
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

ValidateConnection

Type: boolean
Required: No
Default: false

Specifies whether to validate the storage connection and credentials before creating or updating the backup policies.

BackupPolicyDescription

Type: BackupPolicyDescription
Required: Yes

Describes the backup policy.

Responses

HTTP Status Code Description Response Schema
200 (OK) A successful operation returns 200 status code and updates the backup policy description.
All other status codes The detailed error response.
 FabricError

Examples

Update backup policy

This example shows how to update the schedule of a backup policy to take backup twice everyday at 9 AM and 5 PM UTC which shall get deleted after 30 days, with Azure blob store as the backup location.

Request

POST http://localhost:19080/BackupRestore/BackupPolicies/DailyAzureBackupPolicy/$/Update?api-version=6.4
Body
{
  "Name": "DailyAzureBackupPolicy",
  "AutoRestoreOnDataLoss": false,
  "MaxIncrementalBackups": "3",
  "Schedule": {
    "ScheduleKind": "TimeBased",
    "ScheduleFrequencyType": "Daily",
    "RunTimes": [
      "0001-01-01T09:00:00Z",
      "0001-01-01T17:00:00Z"
    ]
  },
  "Storage": {
    "StorageKind": "AzureBlobStore",
    "FriendlyName": "Azure_storagesample",
    "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<PutYourAccountKeyHere>",
    "ContainerName": "BackupContainer"
  },
  "RetentionPolicy": {
    "RetentionPolicyType": "Basic",
    "MinimumNumberOfBackups": "60",
    "RetentionDuration": "P30D"
  }
}

200 Response

Body

The response body is empty.