Backups - Update
Patch a Backup under the Backup Vault
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}?api-version=2025-03-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 pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_.]{0,255}$ |
The name of the backup |
backup
|
path | True |
string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$ |
The name of the Backup Vault |
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 |
---|---|---|
properties.label |
string |
Label for backup |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
202 Accepted |
Accepted -- Create or update request accepted; operation will complete asynchronously Headers Location: string |
|
Other Status Codes |
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
BackupsUnderBackupVault_Update
Sample request
Sample response
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1",
"name": "account1/backupVault1/backup1",
"type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups",
"properties": {
"creationDate": "2017-08-15T13:23:33Z",
"provisioningState": "Succeeded",
"size": 10011,
"label": "myLabel",
"backupType": "Manual",
"snapshotName": "backup1",
"volumeResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1"
}
}
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-03-01&operationResultResponseType=Location
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-03-01
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1",
"name": "account1/backupVault1/backup1",
"type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups",
"properties": {
"creationDate": "2017-08-15T13:23:33Z",
"provisioningState": "Succeeded",
"size": 10011,
"label": "myLabel",
"backupType": "Manual",
"snapshotName": "backup1",
"volumeResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1"
}
}
Definitions
Name | Description |
---|---|
backup |
Backup under a Backup Vault |
backup |
Backup patch |
backup |
backupType |
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. |
backup
Backup under a Backup Vault
Name | Type | Default value | Description |
---|---|---|---|
id |
string (arm-id) |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
|
name |
string |
The name of the resource |
|
properties.backupId |
string minLength: 36maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ |
backupId |
|
properties.backupPolicyResourceId |
string (arm-id) |
ResourceId used to identify the backup policy |
|
properties.backupType |
backupType |
||
properties.completionDate |
string (date-time) |
completionDate |
|
properties.creationDate |
string (date-time) |
creationDate |
|
properties.failureReason |
string |
Failure reason |
|
properties.isLargeVolume |
boolean |
Specifies if the backup is for a large volume. |
|
properties.label |
string |
Label for backup |
|
properties.provisioningState |
string |
Azure lifecycle management |
|
properties.size |
integer (int64) |
Size of backup in bytes |
|
properties.snapshotCreationDate |
string (date-time) |
snapshotCreationDate |
|
properties.snapshotName |
string |
The name of the snapshot |
|
properties.useExistingSnapshot |
boolean |
False |
Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups |
properties.volumeResourceId |
string (arm-id) |
ResourceId used to identify the Volume |
|
systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
||
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
backupPatch
Backup patch
Name | Type | Description |
---|---|---|
properties.label |
string |
Label for backup |
backupType
backupType
Value | Description |
---|---|
Manual |
Manual backup |
Scheduled |
Scheduled backup |
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. |