Share via

Backup Resource Vault Configs - Get

Service:
Recovery Services - Backup
API Version:
2025-08-01

Fetches resource vault config.

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

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
subscriptionId
 path True

string

minLength: 1

The ID of the target subscription.
vaultName
 path True

string

The name of the VaultResource
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

BackupResourceVaultConfigResource

Azure operation completed successfully.
Other Status Codes

ErrorResponse

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

Get Vault Security Config

Sample request

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

Sample response

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

Definitions

Name Description
BackupResourceVaultConfig

Backup resource vault config details.
BackupResourceVaultConfigResource

Backup resource vault config details.
createdByType

The type of identity that created the resource.
EnhancedSecurityState

Enabled or Disabled.
ErrorDetail

Error Detail class which encapsulates Code, Message and Recommendations.
ErrorResponse

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

Metadata pertaining to creation and last modification of the resource.

BackupResourceVaultConfig

Object

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 (int32)

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

Object

Backup resource vault config details.

Name Type Description
eTag

string

Optional ETag.
id

string

Fully qualified resource ID for the resource. Ex - /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

BackupResourceVaultConfig

BackupResourceVaultConfigResource properties
systemData

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"

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

EnhancedSecurityState

Enumeration

Enabled or Disabled.

Value Description
Invalid
Enabled
Disabled

ErrorDetail

Object

Error Detail class which encapsulates Code, Message and Recommendations.

Name Type Description
code

string

Error code.
message

string

Error Message related to the Code.
recommendations

string[]

List of recommendation strings.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

SoftDeleteFeatureState

Enumeration

Soft Delete feature state

Value Description
Invalid
Enabled
Disabled
AlwaysON

StorageType

Enumeration

Storage type

Value Description
Invalid
GeoRedundant
LocallyRedundant
ZoneRedundant
ReadAccessGeoZoneRedundant

StorageTypeState

Enumeration

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

Value Description
Invalid
Locked
Unlocked

systemData

Object

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

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

createdByType

The type of identity that last modified the resource.