Backup Vaults - Get In Resource Group
Returnerar resurssamling som tillhör en resursgrupp.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults?api-version=2024-04-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
subscription
|
path | True |
string uuid |
ID för målprenumerationen. Värdet måste vara ett UUID. |
api-version
|
query | True |
string |
DEN API-version som ska användas för den här åtgärden. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OKEJ |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto. |
Exempel
Get BackupVaults in ResourceGroup
Exempelbegäran
GET https://management.azure.com/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults?api-version=2024-04-01
Exempelsvar
{
"value": [
{
"identity": {
"type": "None"
},
"id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1",
"name": "ExampleVault1",
"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"
}
},
{
"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/ExampleVault2",
"name": "ExampleVault2",
"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"
}
}
]
}
Definitioner
Name | Description |
---|---|
Alerts |
|
Azure |
Inställningar för Azure Monitor-baserade aviseringar |
Backup |
BackupVault |
Backup |
BackupVault-resurs |
Backup |
BackupVaultResourceList |
BCDRSecurity |
Säkerhetsnivå för säkerhetskopieringsvalv |
Cloud |
CloudError |
Cmk |
Information om den hanterade identitet som används för CMK |
Cmk |
Egenskaperna för Key Vault som är värd för CMK |
created |
Den typ av identitet som skapade resursen. |
Cross |
|
Cross |
CrossRegionRestore-tillstånd |
Cross |
CrossSubscriptionRestore-inställningar |
Cross |
CrossSubscriptionRestore-tillstånd |
Dpp |
DppIdentityDetails |
encryption |
Kundhanterad nyckelinformation om resursen. |
Encryption |
Krypteringstillstånd för säkerhetskopieringsvalvet. |
Error |
Svar på resurshanteringsfel. |
Error |
Ytterligare information om resurshanteringsfelet. |
Feature |
Klass som innehåller funktionsinställningar för valv |
Identity |
Identitetstypen. "SystemAssigned" och "UserAssigned" är ömsesidigt uteslutande. "SystemAssigned" använder implicit skapad hanterad identitet. |
Immutability |
Oföränderlighetsinställningar på valvnivå |
Immutability |
Oföränderlighetstillstånd |
Infrastructure |
Aktivera/inaktivera tillståndet dubbelkryptering |
Monitoring |
Övervakningsinställningar |
Provisioning |
Etableringstillstånd för BackupVault-resursen |
Resource |
ResourceMoveDetails returneras som svar på GetResource-anrop från ARM |
Resource |
Resursflytttillstånd för säkerhetskopieringsvalv |
Secure |
Säkerhetspoäng för säkerhetskopieringsvalv |
Security |
Klass som innehåller säkerhetsinställningar för valv |
Soft |
Relaterade inställningar för mjuk borttagning |
Soft |
Tillstånd för mjuk borttagning |
Storage |
StorageSetting |
Storage |
Hämtar eller anger datalagringstypen. |
Storage |
Hämtar eller anger typen. |
system |
Metadata som rör skapande och senaste ändring av resursen. |
User |
Användartilldelade identitetsegenskaper |
AlertsState
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
AzureMonitorAlertSettings
Inställningar för Azure Monitor-baserade aviseringar
Name | Typ | Description |
---|---|---|
alertsForAllJobFailures |
BackupVault
BackupVault
Name | Typ | Description |
---|---|---|
bcdrSecurityLevel |
Säkerhetsnivå för säkerhetskopieringsvalv |
|
featureSettings |
Funktionsinställningar |
|
isVaultProtectedByResourceGuard |
boolean |
Skyddas valvet av resource guard |
monitoringSettings |
Övervakningsinställningar |
|
provisioningState |
Etableringstillstånd för BackupVault-resursen |
|
replicatedRegions |
string[] |
Lista över replikerade regioner för Backup Vault |
resourceGuardOperationRequests |
string[] |
ResourceGuardOperationRequests som LAC-kontrollen ska utföras på |
resourceMoveDetails |
Information om resursflytt för säkerhetskopieringsvalv |
|
resourceMoveState |
Resursflytttillstånd för säkerhetskopieringsvalv |
|
secureScore |
Säkerhetspoäng för säkerhetskopieringsvalv |
|
securitySettings |
Säkerhetsinställningar |
|
storageSettings |
Lagringsinställningar |
BackupVaultResource
BackupVault-resurs
Name | Typ | Description |
---|---|---|
eTag |
string |
Valfri ETag. |
id |
string |
Resurs-ID representerar den fullständiga sökvägen till resursen. |
identity |
DppIdentityDetails |
|
location |
string |
Resursplats. |
name |
string |
Resursnamn som är associerat med resursen. |
properties |
BackupVault |
|
systemData |
Metadata som rör skapande och senaste ändring av resursen. |
|
tags |
object |
Resurstaggar. |
type |
string |
Resurstyp representerar den fullständiga sökvägen till formuläret Namespace/ResourceType/ResourceType/... |
BackupVaultResourceList
BackupVaultResourceList
Name | Typ | Description |
---|---|---|
nextLink |
string |
URI:n för att hämta nästa sida med resurser. Anropa ListNext() hämtar nästa sida med resurser. |
value |
Lista över resurser. |
BCDRSecurityLevel
Säkerhetsnivå för säkerhetskopieringsvalv
Name | Typ | Description |
---|---|---|
Excellent |
string |
|
Fair |
string |
|
Good |
string |
|
NotSupported |
string |
|
Poor |
string |
CloudError
CloudError
Name | Typ | Description |
---|---|---|
error |
Svar på resurshanteringsfel. |
CmkKekIdentity
Information om den hanterade identitet som används för CMK
Name | Typ | Description |
---|---|---|
identityId |
string |
Den hanterade identitet som ska användas som har åtkomstbehörighet till Key Vault. Ange ett värde här om identitetstyper: "Användartilldelad" endast. |
identityType |
Identitetstypen. "SystemAssigned" och "UserAssigned" är ömsesidigt uteslutande. "SystemAssigned" använder implicit skapad hanterad identitet. |
CmkKeyVaultProperties
Egenskaperna för Key Vault som är värd för CMK
Name | Typ | Description |
---|---|---|
keyUri |
string |
Nyckel-URI för den kundhanterade nyckeln |
createdByType
Den typ av identitet som skapade resursen.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CrossRegionRestoreSettings
Name | Typ | Description |
---|---|---|
state |
CrossRegionRestore-tillstånd |
CrossRegionRestoreState
CrossRegionRestore-tillstånd
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
CrossSubscriptionRestoreSettings
CrossSubscriptionRestore-inställningar
Name | Typ | Description |
---|---|---|
state |
CrossSubscriptionRestore-tillstånd |
CrossSubscriptionRestoreState
CrossSubscriptionRestore-tillstånd
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
PermanentlyDisabled |
string |
DppIdentityDetails
DppIdentityDetails
Name | Typ | Description |
---|---|---|
principalId |
string |
Objekt-ID för objektet för tjänstens huvudnamn för den hanterade identitet som används för att bevilja rollbaserad åtkomst till en Azure-resurs. |
tenantId |
string |
En globalt unik identifierare (GUID) som representerar Azure AD-klientorganisationen där resursen nu är medlem. |
type |
string |
IdentityType som kan antingen vara SystemAssigned, UserAssigned, "SystemAssigned,UserAssigned" eller None |
userAssignedIdentities |
<string,
User |
Hämtar eller anger användartilldelade identiteter. |
encryptionSettings
Kundhanterad nyckelinformation om resursen.
Name | Typ | Description |
---|---|---|
infrastructureEncryption |
Aktivera/inaktivera tillståndet dubbelkryptering |
|
kekIdentity |
Information om den hanterade identitet som används för CMK |
|
keyVaultProperties |
Egenskaperna för Key Vault som är värd för CMK |
|
state |
Krypteringstillstånd för säkerhetskopieringsvalvet. |
EncryptionState
Krypteringstillstånd för säkerhetskopieringsvalvet.
Name | Typ | Description |
---|---|---|
Disabled |
string |
CMK-kryptering är inaktiverat i Backup Vault. Användaren kan inte ange det här tillståndet när krypteringstillståndet är aktiverat. |
Enabled |
string |
CMK-kryptering är aktiverat i Backup Vault |
Inconsistent |
string |
CMK-kryptering är i inkonsekvent tillstånd i Backup Vault. Det här tillståndet anger att användaren måste försöka utföra krypteringsinställningarna igen omedelbart för att korrigera tillståndet. |
Error
Svar på resurshanteringsfel.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Error[] |
Felinformationen. |
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Ytterligare information. |
type |
string |
Ytterligare informationstyp. |
FeatureSettings
Klass som innehåller funktionsinställningar för valv
Name | Typ | Description |
---|---|---|
crossRegionRestoreSettings | ||
crossSubscriptionRestoreSettings |
CrossSubscriptionRestore-inställningar |
IdentityType
Identitetstypen. "SystemAssigned" och "UserAssigned" är ömsesidigt uteslutande. "SystemAssigned" använder implicit skapad hanterad identitet.
Name | Typ | Description |
---|---|---|
SystemAssigned |
string |
|
UserAssigned |
string |
ImmutabilitySettings
Oföränderlighetsinställningar på valvnivå
Name | Typ | Description |
---|---|---|
state |
Oföränderlighetstillstånd |
ImmutabilityState
Oföränderlighetstillstånd
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Locked |
string |
|
Unlocked |
string |
InfrastructureEncryptionState
Aktivera/inaktivera tillståndet dubbelkryptering
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
MonitoringSettings
Övervakningsinställningar
Name | Typ | Description |
---|---|---|
azureMonitorAlertSettings |
Inställningar för Azure Monitor-baserade aviseringar |
ProvisioningState
Etableringstillstånd för BackupVault-resursen
Name | Typ | Description |
---|---|---|
Failed |
string |
|
Provisioning |
string |
|
Succeeded |
string |
|
Unknown |
string |
|
Updating |
string |
ResourceMoveDetails
ResourceMoveDetails returneras som svar på GetResource-anrop från ARM
Name | Typ | Description |
---|---|---|
completionTimeUtc |
string |
Slutförandetid i UTC för den senaste ResourceMove-åtgärden. ISO 8601-format. |
operationId |
string |
CorrelationId för senaste ResourceMove-åtgärdsförsök |
sourceResourcePath |
string |
ARM-resurssökväg för källresurs |
startTimeUtc |
string |
Starttid i UTC för den senaste ResourceMove-åtgärden. ISO 8601-format. |
targetResourcePath |
string |
ARM-resurssökväg för målresursen som används i den senaste ResourceMove-åtgärden |
ResourceMoveState
Resursflytttillstånd för säkerhetskopieringsvalv
Name | Typ | Description |
---|---|---|
CommitFailed |
string |
|
CommitTimedout |
string |
|
CriticalFailure |
string |
|
Failed |
string |
|
InProgress |
string |
|
MoveSucceeded |
string |
|
PartialSuccess |
string |
|
PrepareFailed |
string |
|
PrepareTimedout |
string |
|
Unknown |
string |
SecureScoreLevel
Säkerhetspoäng för säkerhetskopieringsvalv
Name | Typ | Description |
---|---|---|
Adequate |
string |
|
Maximum |
string |
|
Minimum |
string |
|
None |
string |
|
NotSupported |
string |
SecuritySettings
Klass som innehåller säkerhetsinställningar för valv
Name | Typ | Description |
---|---|---|
encryptionSettings |
Kundhanterad nyckelinformation om resursen. |
|
immutabilitySettings |
Oföränderlighetsinställningar på valvnivå |
|
softDeleteSettings |
Relaterade inställningar för mjuk borttagning |
SoftDeleteSettings
Relaterade inställningar för mjuk borttagning
Name | Typ | Description |
---|---|---|
retentionDurationInDays |
number |
Varaktighet för kvarhållning av mjuk borttagning |
state |
Tillstånd för mjuk borttagning |
SoftDeleteState
Tillstånd för mjuk borttagning
Name | Typ | Description |
---|---|---|
AlwaysOn |
string |
Mjuk borttagning är permanent aktiverat för BackupVault och inställningen kan inte ändras |
Off |
string |
Mjuk borttagning är inaktiverat för BackupVault |
On |
string |
Mjuk borttagning är aktiverat för BackupVault men kan stängas av |
StorageSetting
StorageSetting
Name | Typ | Description |
---|---|---|
datastoreType |
Hämtar eller anger datalagringstypen. |
|
type |
Hämtar eller anger typen. |
StorageSettingStoreTypes
Hämtar eller anger datalagringstypen.
Name | Typ | Description |
---|---|---|
ArchiveStore |
string |
|
OperationalStore |
string |
|
VaultStore |
string |
StorageSettingTypes
Hämtar eller anger typen.
Name | Typ | Description |
---|---|---|
GeoRedundant |
string |
|
LocallyRedundant |
string |
|
ZoneRedundant |
string |
systemData
Metadata som rör skapande och senaste ändring av resursen.
Name | Typ | Description |
---|---|---|
createdAt |
string |
Tidsstämpeln för resursskapande (UTC). |
createdBy |
string |
Identiteten som skapade resursen. |
createdByType |
Den typ av identitet som skapade resursen. |
|
lastModifiedAt |
string |
Tidsstämpeln för resursens senaste ändring (UTC) |
lastModifiedBy |
string |
Identiteten som senast ändrade resursen. |
lastModifiedByType |
Den typ av identitet som senast ändrade resursen. |
UserAssignedIdentity
Användartilldelade identitetsegenskaper
Name | Typ | Description |
---|---|---|
clientId |
string |
Klient-ID för den tilldelade identiteten. |
principalId |
string |
Huvud-ID för den tilldelade identiteten. |