Validate Backup Policy Settings

In this article

    You can check whether settings of an Azure SQL backup policy are valid.

    Request

    To check the the settings of the Azure SQL backup policy, send the HTTP POST request to the /policies/sql/testConfiguration endpoint.

    HTTP Request

    POST https://<hostname>/api/v3/policies/sql/testConfiguration

    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 validate the settings of the backup policy, send the parameters of the NewPolicySqlFromClientV3 schema in the request body in the following format:

    {

     "tenantId": "string",

     "serviceAccountId": "string",

     "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.

    Validate Backup Policy SettingsExample

    If backup policy settings are valid, Veeam Backup for Microsoft Azure does not return a response body, in other cases Veeam Backup for Microsoft Azure returns the severity level and the error message.

    Response:

    204

     

    [

     {

       "severity": "Success",

       "type": "string",

       "message": "string"

     }

    ]