Backup Policies - Update
Patch a backup policy for Netapp Account
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}?api-version=2025-09-01
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
account
|
path | True |
string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$ |
The name of the NetApp account |
|
backup
|
path | True |
string |
Backup policy Name which uniquely identify backup policy. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
The name of the resource group. The name is case insensitive. |
|
subscription
|
path | True |
string (uuid) |
The ID of the target subscription. The value must be an UUID. |
|
api-version
|
query | True |
string minLength: 1 |
The API version to use for this operation. |
Request Body
| Name | Type | Description |
|---|---|---|
| location |
string |
Resource location |
| properties.dailyBackupsToKeep |
integer (int32) |
Daily backups count to keep |
| properties.enabled |
boolean |
The property to decide policy is enabled or not |
| properties.monthlyBackupsToKeep |
integer (int32) |
Monthly backups count to keep |
| properties.weeklyBackupsToKeep |
integer (int32) |
Weekly backups count to keep |
| tags |
object |
Resource tags |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Azure operation completed successfully. |
|
| 202 Accepted |
The request has been accepted for processing, but processing has not yet completed. Headers
|
|
| Other Status Codes |
An unexpected error response. |
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
BackupPolicies_Update
Sample request
PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/backupPolicyName?api-version=2025-09-01
{
"location": "westus",
"properties": {
"dailyBackupsToKeep": 5,
"enabled": false,
"monthlyBackupsToKeep": 10,
"weeklyBackupsToKeep": 10
}
}
Sample response
{
"name": "account1/backupPolicyName",
"type": "Microsoft.NetApp/netAppAccounts/backupPolicies",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName",
"location": "westus",
"properties": {
"dailyBackupsToKeep": 5,
"enabled": false,
"monthlyBackupsToKeep": 10,
"provisioningState": "Succeeded",
"volumeBackups": [
{
"backupsCount": 5,
"policyEnabled": true,
"volumeName": "volume 1"
}
],
"volumesAssigned": 1,
"weeklyBackupsToKeep": 10
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2025-09-01
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2025-09-01&operationResultResponseType=Location
{
"name": "account1/backupPolicyName",
"type": "Microsoft.NetApp/netAppAccounts/backupPolicies",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName",
"location": "westus",
"properties": {
"dailyBackupsToKeep": 5,
"enabled": false,
"monthlyBackupsToKeep": 10,
"provisioningState": "Succeeded",
"volumeBackups": [
{
"backupsCount": 5,
"policyEnabled": true,
"volumeName": "volume 1"
}
],
"volumesAssigned": 1,
"weeklyBackupsToKeep": 10
}
}
Definitions
| Name | Description |
|---|---|
|
Backup |
Backup policy information |
|
Backup |
Backup policy Details for create and update |
|
created |
The type of identity that created the resource. |
|
Error |
The resource management error additional info. |
|
Error |
The error detail. |
|
Error |
Error response |
|
system |
Metadata pertaining to creation and last modification of the resource. |
|
Volume |
Volume details using the backup policy |
BackupPolicy
Backup policy information
| Name | Type | Description |
|---|---|---|
| etag |
string |
"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") |
| id |
string (arm-id) |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| location |
string |
The geo-location where the resource lives |
| name |
string |
The name of the resource |
| properties.backupPolicyId |
string |
Backup Policy GUID ID |
| properties.dailyBackupsToKeep |
integer (int32) |
Daily backups count to keep |
| properties.enabled |
boolean |
The property to decide policy is enabled or not |
| properties.monthlyBackupsToKeep |
integer (int32) |
Monthly backups count to keep |
| properties.provisioningState |
string |
Azure lifecycle management |
| properties.volumeBackups |
A list of volumes assigned to this policy |
|
| properties.volumesAssigned |
integer (int32) |
Volumes using current backup policy |
| properties.weeklyBackupsToKeep |
integer (int32) |
Weekly backups count to keep |
| systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
|
| tags |
object |
Resource tags. |
| type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
BackupPolicyPatch
Backup policy Details for create and update
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id |
| location |
string |
Resource location |
| name |
string |
Resource name |
| properties.backupPolicyId |
string |
Backup Policy GUID ID |
| properties.dailyBackupsToKeep |
integer (int32) |
Daily backups count to keep |
| properties.enabled |
boolean |
The property to decide policy is enabled or not |
| properties.monthlyBackupsToKeep |
integer (int32) |
Monthly backups count to keep |
| properties.provisioningState |
string |
Azure lifecycle management |
| properties.volumeBackups |
A list of volumes assigned to this policy |
|
| properties.volumesAssigned |
integer (int32) |
Volumes using current backup policy |
| properties.weeklyBackupsToKeep |
integer (int32) |
Weekly backups count to keep |
| tags |
object |
Resource tags |
| type |
string |
Resource type |
createdByType
The type of identity that created the resource.
| Value | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorAdditionalInfo
The resource management error additional info.
| Name | Type | Description |
|---|---|---|
| info |
object |
The additional info. |
| type |
string |
The additional info type. |
ErrorDetail
The error detail.
| Name | Type | Description |
|---|---|---|
| additionalInfo |
The error additional info. |
|
| code |
string |
The error code. |
| details |
The error details. |
|
| message |
string |
The error message. |
| target |
string |
The error target. |
ErrorResponse
Error response
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
systemData
Metadata pertaining to creation and last modification of the resource.
| Name | Type | Description |
|---|---|---|
| createdAt |
string (date-time) |
The timestamp of resource creation (UTC). |
| createdBy |
string |
The identity that created the resource. |
| createdByType |
The type of identity that created the resource. |
|
| lastModifiedAt |
string (date-time) |
The timestamp of resource last modification (UTC) |
| lastModifiedBy |
string |
The identity that last modified the resource. |
| lastModifiedByType |
The type of identity that last modified the resource. |
VolumeBackups
Volume details using the backup policy
| Name | Type | Description |
|---|---|---|
| backupsCount |
integer (int32) |
Total count of backups for volume |
| policyEnabled |
boolean |
Policy enabled |
| volumeName |
string |
Volume name |
| volumeResourceId |
string (arm-id) |
ResourceId used to identify the Volume |