Backup Vaults - Get

Service:

Data Protection

API-versie:

2025-07-01

Hiermee wordt een resource geretourneerd die hoort bij een resourcegroep.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}?api-version=2025-07-01

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
vaultName	path	True	string	De naam van de back-upkluis.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	BackupVaultResource	OK
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Imitatie van uw gebruikersaccount.

Voorbeelden

Get BackupVault

Get BackupVault With CMK

Get BackupVault With MSI

Get BackupVault

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample?api-version=2025-07-01

Voorbeeldrespons

Statuscode:

200

{
  "identity": {
    "type": "None"
  },
  "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.DataProtection/Backupvaults",
  "location": "WestUS",
  "tags": {
    "key1": "val1"
  },
  "properties": {
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllJobFailures": "Enabled"
      }
    },
    "provisioningState": "Succeeded",
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ],
    "featureSettings": {
      "crossRegionRestoreSettings": {
        "state": "Enabled"
      }
    },
    "securitySettings": {
      "softDeleteSettings": {
        "state": "Enabled",
        "retentionDurationInDays": 14
      }
    },
    "secureScore": "Adequate",
    "bcdrSecurityLevel": "Good"
  }
}

Get BackupVault With CMK

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample?api-version=2025-07-01

Voorbeeldrespons

Statuscode:

200

{
  "identity": {
    "principalId": "c009b9a0-0024-417c-83cd-025d3776045d",
    "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
    "type": "SystemAssigned"
  },
  "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.DataProtection/Backupvaults",
  "location": "WestUS",
  "tags": {
    "key1": "val1"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "securitySettings": {
      "softDeleteSettings": {
        "state": "Off",
        "retentionDurationInDays": 0
      },
      "immutabilitySettings": {
        "state": "Disabled"
      },
      "encryptionSettings": {
        "state": "Enabled",
        "keyVaultProperties": {
          "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3"
        },
        "kekIdentity": {
          "identityType": "UserAssigned",
          "identityId": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi"
        },
        "infrastructureEncryption": "Disabled"
      }
    },
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ]
  }
}

Get BackupVault With MSI

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample?api-version=2025-07-01

Voorbeeldrespons

Statuscode:

200

{
  "identity": {
    "principalId": "c009b9a0-0024-417c-83cd-025d3776045d",
    "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
    "type": "SystemAssigned"
  },
  "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.DataProtection/Backupvaults",
  "location": "WestUS",
  "tags": {
    "key1": "val1"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ],
    "featureSettings": {
      "crossRegionRestoreSettings": {
        "state": "Enabled"
      }
    },
    "securitySettings": {
      "softDeleteSettings": {
        "state": "Enabled",
        "retentionDurationInDays": 14
      }
    },
    "secureScore": "Adequate",
    "bcdrSecurityLevel": "Good"
  }
}

Definities

Name	Description
AlertsState
AzureMonitorAlertSettings	Instellingen voor waarschuwingen op basis van Azure Monitor
BackupVault	Back-up Vault
BackupVaultResource	BackupVault-resource
BCDRSecurityLevel	Beveiligingsniveau van Backup Vault
CloudError	CloudError
CmkKekIdentity	De details van de beheerde identiteit die wordt gebruikt voor CMK
CmkKeyVaultProperties	De eigenschappen van de Key Vault die als host fungeert voor CMK
createdByType	Het type identiteit waarmee de resource is gemaakt.
CrossRegionRestoreSettings
CrossRegionRestoreState	CrossRegionRestore-status
CrossSubscriptionRestoreSettings	Instellingen voor CrossSubscriptionRestore
CrossSubscriptionRestoreState	CrossSubscriptionRestore-status
DppIdentityDetails	DppIdentityDetails
encryptionSettings	Door de klant beheerde sleuteldetails van de resource.
EncryptionState	Versleutelingsstatus van de Backup Vault.
Error	Het antwoord van het resourcebeheerfout.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
FeatureSettings	Klasse met functie-instellingen van kluis
IdentityType	Het identiteitstype. SystemAssigned en UserAssigned sluiten elkaar wederzijds uit. SystemAssigned gebruikt impliciet gemaakte beheerde identiteit.
ImmutabilitySettings	Instellingen voor onveranderbaarheid op kluisniveau
ImmutabilityState	Onveranderbaarheidsstatus
InfrastructureEncryptionState	De dubbele versleutelingsstatus in- of uitschakelen
MonitoringSettings	Bewakingsinstellingen
ProvisioningState	Inrichtingsstatus van de BackupVault-resource
ResourceMoveDetails	ResourceMoveDetails wordt geretourneerd als reactie op getresource-aanroep van ARM
ResourceMoveState	Status van resourceverplaatsing voor back-upkluis
SecureScoreLevel	Beveiligingsscore van Backup Vault
SecuritySettings	Klasse met beveiligingsinstellingen van kluis
SoftDeleteSettings	Gerelateerde instellingen voor voorlopig verwijderen
SoftDeleteState	Status van voorlopig verwijderen
StorageSetting	Opslaginstelling
StorageSettingStoreTypes	Hiermee wordt het type gegevensarchief opgehaald of ingesteld.
StorageSettingTypes	Hiermee haalt u het type op of stelt u het in.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
UserAssignedIdentity	Door de gebruiker toegewezen identiteitseigenschappen

AlertsState

Inventarisatie

Waarde	Description
Disabled
Enabled

AzureMonitorAlertSettings

Object

Instellingen voor waarschuwingen op basis van Azure Monitor

Name	Type	Description
alertsForAllJobFailures	AlertsState

BackupVault

Object

Back-up Vault

Name	Type	Description
bcdrSecurityLevel	BCDRSecurityLevel	Beveiligingsniveau van Backup Vault
featureSettings	FeatureSettings	Functie-instellingen
isVaultProtectedByResourceGuard	boolean	Is kluis beveiligd door Resource Guard
monitoringSettings	MonitoringSettings	Bewakingsinstellingen
provisioningState	ProvisioningState	Inrichtingsstatus van de BackupVault-resource
replicatedRegions	string[]	Lijst met gerepliceerde regio's voor Backup Vault
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests waarop lac-controle wordt uitgevoerd
resourceMoveDetails	ResourceMoveDetails	Details van resourceverplaatsing voor back-upkluis
resourceMoveState	ResourceMoveState	Status van resourceverplaatsing voor back-upkluis
secureScore	SecureScoreLevel	Beveiligingsscore van Backup Vault
securitySettings	SecuritySettings	Beveiligingsinstellingen
storageSettings	StorageSetting[]	Opslaginstellingen

BackupVaultResource

Object

BackupVault-resource

Name	Type	Description
eTag	string	Optionele ETag.
id	string	Resource-id vertegenwoordigt het volledige pad naar de resource.
identity	DppIdentityDetails	DppIdentityDetails Details van beheerde identiteit invoeren
location	string	Resourcelocatie.
name	string	Resourcenaam die is gekoppeld aan de resource.
properties	BackupVault	Back-up Vault Eigenschappen van BackupVaultResource
systemData	systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
tags	object	Resourcetags.
type	string	Resourcetype vertegenwoordigt het volledige pad van de formuliernaamruimte/ResourceType/ResourceType/...

BCDRSecurityLevel

Inventarisatie

Beveiligingsniveau van Backup Vault

Waarde	Description
Excellent
Fair
Good
NotSupported
Poor

CloudError

Object

CloudError

Name	Type	Description
error	Error	Het antwoord van het resourcebeheerfout.

CmkKekIdentity

Object

De details van de beheerde identiteit die wordt gebruikt voor CMK

Name	Type	Description
identityId	string	De beheerde identiteit die moet worden gebruikt met toegangsmachtigingen voor de Key Vault. Geef hier een waarde op in het geval van identiteitstypen: Alleen UserAssigned.
identityType	IdentityType	Het identiteitstype. SystemAssigned en UserAssigned sluiten elkaar wederzijds uit. SystemAssigned gebruikt impliciet gemaakte beheerde identiteit.

CmkKeyVaultProperties

Object

De eigenschappen van de Key Vault die als host fungeert voor CMK

Name	Type	Description
keyUri	string	De sleutel-URI van de door de klant beheerde sleutel

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

CrossRegionRestoreSettings

Object

Name	Type	Description
state	CrossRegionRestoreState	CrossRegionRestore-status

CrossRegionRestoreState

Inventarisatie

CrossRegionRestore-status

Waarde	Description
Disabled
Enabled

CrossSubscriptionRestoreSettings

Object

Instellingen voor CrossSubscriptionRestore

Name	Type	Description
state	CrossSubscriptionRestoreState	CrossSubscriptionRestore-status

CrossSubscriptionRestoreState

Inventarisatie

CrossSubscriptionRestore-status

Waarde	Description
Disabled
Enabled
PermanentlyDisabled

DppIdentityDetails

Object

DppIdentityDetails

Name	Type	Description
principalId	string	De object-id van het service-principal-object voor de beheerde identiteit die wordt gebruikt om op rollen gebaseerde toegang te verlenen tot een Azure-resource.
tenantId	string	Een GUID (Globally Unique Identifier) die de Azure AD-tenant vertegenwoordigt waar de resource nu lid is.
type	string	Het identityType dat systemAssigned, UserAssigned, SystemAssigned, UserAssigned of None kan zijn
userAssignedIdentities	<string,  UserAssignedIdentity>	Hiermee haalt u de door de gebruiker toegewezen identiteiten op of stelt u deze in.

encryptionSettings

Object

Door de klant beheerde sleuteldetails van de resource.

Name	Type	Description
infrastructureEncryption	InfrastructureEncryptionState	De dubbele versleutelingsstatus in- of uitschakelen
kekIdentity	CmkKekIdentity	De details van de beheerde identiteit die wordt gebruikt voor CMK
keyVaultProperties	CmkKeyVaultProperties	De eigenschappen van de Key Vault die als host fungeert voor CMK
state	EncryptionState	Versleutelingsstatus van de Backup Vault.

EncryptionState

Inventarisatie

Versleutelingsstatus van de Backup Vault.

Waarde	Description
Disabled	CMK-versleuteling is uitgeschakeld in de Backup Vault. De gebruiker kan deze status niet instellen zodra de versleutelingsstatus is ingeschakeld.
Enabled	CMK-versleuteling is ingeschakeld in de Backup Vault
Inconsistent	CMK-versleuteling heeft een inconsistente status in de Backup Vault. Deze status geeft aan dat de gebruiker de bewerking voor versleutelingsinstellingen onmiddellijk opnieuw moet uitvoeren om de status te corrigeren.

Error

Object

Het antwoord van het resourcebeheerfout.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	Error[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

FeatureSettings

Object

Klasse met functie-instellingen van kluis

Name	Type	Description
crossRegionRestoreSettings	CrossRegionRestoreSettings
crossSubscriptionRestoreSettings	CrossSubscriptionRestoreSettings	Instellingen voor CrossSubscriptionRestore

IdentityType

Inventarisatie

Het identiteitstype. SystemAssigned en UserAssigned sluiten elkaar wederzijds uit. SystemAssigned gebruikt impliciet gemaakte beheerde identiteit.

Waarde	Description
SystemAssigned
UserAssigned

ImmutabilitySettings

Object

Instellingen voor onveranderbaarheid op kluisniveau

Name	Type	Description
state	ImmutabilityState	Onveranderbaarheidsstatus

ImmutabilityState

Inventarisatie

Onveranderbaarheidsstatus

Waarde	Description
Disabled
Locked
Unlocked

InfrastructureEncryptionState

Inventarisatie

De dubbele versleutelingsstatus in- of uitschakelen

Waarde	Description
Disabled
Enabled

MonitoringSettings

Object

Bewakingsinstellingen

Name	Type	Description
azureMonitorAlertSettings	AzureMonitorAlertSettings	Instellingen voor waarschuwingen op basis van Azure Monitor

ProvisioningState

Inventarisatie

Inrichtingsstatus van de BackupVault-resource

Waarde	Description
Failed
Provisioning
Succeeded
Unknown
Updating

ResourceMoveDetails

Object

ResourceMoveDetails wordt geretourneerd als reactie op getresource-aanroep van ARM

Name	Type	Description
completionTimeUtc	string	Voltooiingstijd in UTC van de meest recente ResourceMove-bewerking is geprobeerd. ISO 8601-indeling.
operationId	string	CorrelationId van de meest recente ResourceMove-bewerking geprobeerd
sourceResourcePath	string	ARM-resourcepad van bronresource
startTimeUtc	string	Begintijd in UTC van de meest recente ResourceMove-bewerking geprobeerd. ISO 8601-indeling.
targetResourcePath	string	ARM-resourcepad van de doelresource die wordt gebruikt in de meest recente ResourceMove-bewerking

ResourceMoveState

Inventarisatie

Status van resourceverplaatsing voor back-upkluis

Waarde	Description
CommitFailed
CommitTimedout
CriticalFailure
Failed
InProgress
MoveSucceeded
PartialSuccess
PrepareFailed
PrepareTimedout
Unknown

SecureScoreLevel

Inventarisatie

Beveiligingsscore van Backup Vault

Waarde	Description
Adequate
Maximum
Minimum
None
NotSupported

SecuritySettings

Object

Klasse met beveiligingsinstellingen van kluis

Name	Type	Description
encryptionSettings	encryptionSettings	Door de klant beheerde sleuteldetails van de resource.
immutabilitySettings	ImmutabilitySettings	Instellingen voor onveranderbaarheid op kluisniveau
softDeleteSettings	SoftDeleteSettings	Gerelateerde instellingen voor voorlopig verwijderen

SoftDeleteSettings

Object

Gerelateerde instellingen voor voorlopig verwijderen

Name	Type	Description
retentionDurationInDays	number (double)	Bewaarduur voor voorlopig verwijderen
state	SoftDeleteState	Status van voorlopig verwijderen

SoftDeleteState

Inventarisatie

Status van voorlopig verwijderen

Waarde	Description
AlwaysOn	Voorlopig verwijderen is permanent ingeschakeld voor de BackupVault en de instelling kan niet worden gewijzigd
Off	Voorlopig verwijderen is uitgeschakeld voor BackupVault
On	Voorlopig verwijderen is ingeschakeld voor BackupVault, maar kan worden uitgeschakeld

StorageSetting

Object

Opslaginstelling

Name	Type	Description
datastoreType	StorageSettingStoreTypes	Hiermee wordt het type gegevensarchief opgehaald of ingesteld.
type	StorageSettingTypes	Hiermee haalt u het type op of stelt u het in.

StorageSettingStoreTypes

Inventarisatie

Hiermee wordt het type gegevensarchief opgehaald of ingesteld.

Waarde	Description
ArchiveStore
OperationalStore
VaultStore

StorageSettingTypes

Inventarisatie

Hiermee haalt u het type op of stelt u het in.

Waarde	Description
GeoRedundant
LocallyRedundant
ZoneRedundant

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

UserAssignedIdentity

Object

Door de gebruiker toegewezen identiteitseigenschappen

Name	Type	Description
clientId	string (uuid)	De client-id van de toegewezen identiteit.
principalId	string (uuid)	De principal-id van de toegewezen identiteit.