This is an archive version of the document. To get the most up-to-date information, see the current version.

Modify Azure SQL Backup Policy

You can update an Azure SQL backup policy with the specified ID.

Request

To update backup policy settings, send the HTTP PUT request to the /policies/sql/{policyId} endpoint. {policyId} is a system ID assigned to the backup policy in the Veeam Backup for Microsoft Azure REST API.

HTTP Request

PUT https://<hostname>/api/v3/policies/sql/{policyId}

Query Parameters

To control the amount and order of data in the response, you can use the following query parameters:

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Request Body

To update the backup policy settings, send the parameters of the NewPolicySqlFromClientV3 schema in the request body.

Set the parameter values in the following format:

{

 "regions": [

   {

     "regionId": "string"

   }

 ],

 "selectedItems": {

   "databases": [

     {

       "id": "string"

     }

   ],

   "sqlServers": [

     {

       "id": "string"

     }

   ]

 },

 "excludedItems": {

   "databases": [

     {

       "id": "string"

     }

   ]

 },

 "stagingServerId": "string",

 "managedStagingServerId": "string",

 "name": "string",

 "description": "string",

 "retrySettings": {

   "retryCount": 0

 },

 "policyNotificationSettings": {

   "recipient": "string",

   "notifyOnSuccess": true,

   "notifyOnWarning": true,

   "notifyOnFailure": true

 },

 "isEnabled": true,

 "backupType": "AllSubscriptions",

 "dailySchedule": {

   "dailyType": "Everyday",

   "selectedDays": [

     "Sunday"

   ],

   "backupSchedule": {

     "hours": [

       0

     ],

     "retention": {

       "timeRetentionDuration": 0,

       "retentionDurationType": "Days"

     },

     "targetRepositoryId": "string"

   }

 },

 "weeklySchedule": {

   "startTime": 0,

   "backupSchedule": {

     "selectedDays": [

       "Sunday"

     ],

     "retention": {

       "timeRetentionDuration": 0,

       "retentionDurationType": "Days"

     },

     "targetRepositoryId": "string"

   }

 },

 "monthlySchedule": {

   "startTime": 0,

   "type": "First",

   "dayOfWeek": "Sunday",

   "dayOfMonth": 0,

   "monthlyLastDay": true,

   "backupSchedule": {

     "selectedMonths": [

       "January"

     ],

     "retention": {

       "timeRetentionDuration": 0,

       "retentionDurationType": "Days"

     },

     "targetRepositoryId": "string"

   }

 },

 "yearlySchedule": {

   "startTime": 0,

   "month": "January",

   "type": "First",

   "dayOfWeek": "Sunday",

   "dayOfMonth": 0,

   "yearlyLastDay": true,

   "retentionYearsCount": 0,

   "targetRepositoryId": "string"

 }

}

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 204 (No Content).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns a representation of the updated backup policy. The PolicySQLV3 schema is used for the resource representation.

Modify Azure SQL Backup PolicyExample

The following request updates a backup policy with the ID 406c92ee-7d88-47ab-9c35-d4099d137396.

 

Response:

204