Backup Resource Storage Configs - Update

  • Reference
Service:
Recovery Services - Backup
API Version:
2023-01-15

Updates vault storage model type.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig?api-version=2023-01-15

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

The name of the resource group where the recovery services vault is present.
subscriptionId
 path True

string

The subscription Id.
vaultName
 path True

string

The name of the recovery services vault.
api-version
 query True

string

Client Api Version.

Request Body

Name Type Description
eTag

string

Optional ETag.
location

string

Resource location.
properties

BackupResourceConfig

BackupResourceConfigResource properties
tags

object

Resource tags.

Responses

Name Type Description
200 OK

BackupResourceConfigResource

OK
Other Status Codes

NewErrorResponse

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

Update Vault Storage Configuration

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupstorageconfig/vaultstorageconfig?api-version=2023-01-15

{
  "properties": {
    "storageType": "LocallyRedundant",
    "storageTypeState": "Unlocked"
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupstorageconfig/vaultstorageconfig",
  "name": "vaultstorageconfig",
  "type": "Microsoft.RecoveryServices/vaults/backupstorageconfig",
  "properties": {
    "storageModelType": "LocallyRedundant",
    "storageType": "LocallyRedundant",
    "storageTypeState": "Unlocked"
  }
}

Definitions

Name Description
BackupResourceConfig

The resource storage details.
BackupResourceConfigResource

The resource storage details.
Error

The error object.
ErrorAdditionalInfo

The resource management error additional info.
NewErrorResponse

The resource management error response.
StorageType

Storage type
StorageTypeState

Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked.

BackupResourceConfig

The resource storage details.

Name Type Description
crossRegionRestoreFlag

boolean

Opt in details of Cross Region Restore feature.
storageModelType

StorageType

Storage type
storageType

StorageType

Storage type.
storageTypeState

StorageTypeState

Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked.

BackupResourceConfigResource

The resource storage details.

Name Type Description
eTag

string

Optional ETag.
id

string

Resource Id represents the complete path to the resource.
location

string

Resource location.
name

string

Resource name associated with the resource.
properties

BackupResourceConfig

BackupResourceConfigResource properties
tags

object

Resource tags.
type

string

Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

Error

The error object.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

NewErrorResponse[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

NewErrorResponse

The resource management error response.

Name Type Description
error

Error

The error object.

StorageType

Storage type

Name Type Description
GeoRedundant

string

Invalid

string

LocallyRedundant

string

ReadAccessGeoZoneRedundant

string

ZoneRedundant

string

StorageTypeState

Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked.

Name Type Description
Invalid

string

Locked

string

Unlocked

string