Partager via


Backup Resource Vault Configs - Update

Updates vault security config.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupconfig/vaultconfig?api-version=2024-04-01

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 Header

Name Required Type Description
x-ms-authorization-auxiliary

string

Request Body

Name Type Description
eTag

string

Optional ETag.

location

string

Resource location.

properties

BackupResourceVaultConfig

BackupResourceVaultConfigResource properties

tags

object

Resource tags.

Responses

Name Type Description
200 OK

BackupResourceVaultConfigResource

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 Security Config

Sample request

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/SwaggerTest/backupconfig/vaultconfig?api-version=2024-04-01

{
  "properties": {
    "enhancedSecurityState": "Enabled"
  }
}

Sample response

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/SwaggerTest/backupconfig/vaultconfig",
  "name": "vaultconfig",
  "type": "Microsoft.RecoveryServices/vaults/backupconfig",
  "properties": {
    "enhancedSecurityState": "Enabled"
  }
}

Definitions

Name Description
BackupResourceVaultConfig

Backup resource vault config details.

BackupResourceVaultConfigResource

Backup resource vault config details.

EnhancedSecurityState

Enabled or Disabled.

Error

The error object.

ErrorAdditionalInfo

The resource management error additional info.

NewErrorResponse

The resource management error response.

SoftDeleteFeatureState

Soft Delete feature state

StorageType

Storage type

StorageTypeState

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

BackupResourceVaultConfig

Backup resource vault config details.

Name Type Description
enhancedSecurityState

EnhancedSecurityState

Enabled or Disabled.

isSoftDeleteFeatureStateEditable

boolean

This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault

resourceGuardOperationRequests

string[]

ResourceGuard Operation Requests

softDeleteFeatureState

SoftDeleteFeatureState

Soft Delete feature state

softDeleteRetentionPeriodInDays

integer

Soft delete retention period in days

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.

BackupResourceVaultConfigResource

Backup resource vault config 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

BackupResourceVaultConfig

BackupResourceVaultConfigResource properties

tags

object

Resource tags.

type

string

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

EnhancedSecurityState

Enabled or Disabled.

Name Type Description
Disabled

string

Enabled

string

Invalid

string

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.

SoftDeleteFeatureState

Soft Delete feature state

Name Type Description
AlwaysON

string

Disabled

string

Enabled

string

Invalid

string

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