Backup Vaults - Get In Resource Group

Service:

Data Protection

API Version:

2023-01-01

Gibt eine Ressourcensammlung zurück, die zu einer Ressourcengruppe gehört.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string uuid	Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	BackupVaultResourceList	OK
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	geben Sie die Identität Ihres Benutzerkontos an.

Beispiele

Get BackupVaults in ResourceGroup

Sample Request

HTTP

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

Java

/** Samples for BackupVaults ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json
     */
    /**
     * Sample code: Get BackupVaults in ResourceGroup.
     *
     * @param manager Entry point to DataProtectionManager.
     */
    public static void getBackupVaultsInResourceGroup(
        com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager.backupVaults().listByResourceGroup("SampleResourceGroup", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python get_backup_vaults_in_resource_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataProtectionMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="0b352192-dcac-4cc7-992e-a96190ccc68c",
    )

    response = client.backup_vaults.get_in_resource_group(
        resource_group_name="SampleResourceGroup",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdataprotection_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dataprotection/armdataprotection/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1b33e81bbdc28fcd6644a1315b8d7b1b6d030590/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json
func ExampleBackupVaultsClient_NewGetInResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBackupVaultsClient().NewGetInResourceGroupPager("SampleResourceGroup", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.BackupVaultResourceList = armdataprotection.BackupVaultResourceList{
		// 	Value: []*armdataprotection.BackupVaultResource{
		// 		{
		// 			Name: to.Ptr("ExampleVault1"),
		// 			Type: to.Ptr("Microsoft.DataProtection/BackupVaults"),
		// 			ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1"),
		// 			Location: to.Ptr("WestUS"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("val1"),
		// 			},
		// 			Identity: &armdataprotection.DppIdentityDetails{
		// 				Type: to.Ptr("None"),
		// 			},
		// 			Properties: &armdataprotection.BackupVault{
		// 				ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
		// 				StorageSettings: []*armdataprotection.StorageSetting{
		// 					{
		// 						Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
		// 						DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
		// 				}},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("ExampleVault2"),
		// 			Type: to.Ptr("Microsoft.DataProtection/BackupVaults"),
		// 			ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2"),
		// 			Location: to.Ptr("WestUS"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("val1"),
		// 			},
		// 			Identity: &armdataprotection.DppIdentityDetails{
		// 				Type: to.Ptr("SystemAssigned"),
		// 				PrincipalID: to.Ptr("c009b9a0-0024-417c-83cd-025d3776045d"),
		// 				TenantID: to.Ptr("83abe5cd-bcc3-441a-bd86-e6a75360cecc"),
		// 			},
		// 			Properties: &armdataprotection.BackupVault{
		// 				MonitoringSettings: &armdataprotection.MonitoringSettings{
		// 					AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
		// 						AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
		// 					},
		// 				},
		// 				ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
		// 				StorageSettings: []*armdataprotection.StorageSetting{
		// 					{
		// 						Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
		// 						DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DataProtectionClient } = require("@azure/arm-dataprotection");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Returns resource collection belonging to a resource group.
 *
 * @summary Returns resource collection belonging to a resource group.
 * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json
 */
async function getBackupVaultsInResourceGroup() {
  const subscriptionId =
    process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "0b352192-dcac-4cc7-992e-a96190ccc68c";
  const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "SampleResourceGroup";
  const credential = new DefaultAzureCredential();
  const client = new DataProtectionClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.backupVaults.listInResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "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"
          }
        ]
      }
    },
    {
      "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"
          }
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
AlertsState
AzureMonitorAlertSettings	Einstellungen für Azure Monitor-basierte Warnungen
BackupVault	BackupVault
BackupVaultResource	BackupVault-Ressource
BackupVaultResourceList	BackupVaultResourceList
CloudError	CloudError
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CrossSubscriptionRestoreSettings	CrossSubscriptionRestore-Einstellungen
CrossSubscriptionRestoreState	CrossSubscriptionRestore-Zustand
DppIdentityDetails	DppIdentityDetails
Error	Die Fehlerantwort für die Ressourcenverwaltung.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
FeatureSettings	Klasse mit Featureeinstellungen des Tresors
ImmutabilitySettings	Unveränderlichkeitseinstellungen auf Tresorebene
ImmutabilityState	Unveränderlichkeitszustand
MonitoringSettings	Überwachungseinstellungen
ProvisioningState	Bereitstellungsstatus der BackupVault-Ressource
ResourceMoveDetails	ResourceMoveDetails wird als Antwort auf den GetResource-Aufruf von ARM zurückgegeben.
ResourceMoveState	Ressourcenverschiebungsstatus für Sicherungstresor
SecuritySettings	Klasse mit Sicherheitseinstellungen des Tresors
SoftDeleteSettings	Einstellungen für vorläufiges Löschen
SoftDeleteState	Zustand des vorläufigen Löschens
StorageSetting	StorageSetting
StorageSettingStoreTypes	Ruft den Typ des Datenspeichers ab oder legt diese fest.
StorageSettingTypes	Ruft den Typ ab oder legt den Typ fest.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

AlertsState

Name	Typ	Beschreibung
Disabled	string
Enabled	string

AzureMonitorAlertSettings

Einstellungen für Azure Monitor-basierte Warnungen

Name	Typ	Beschreibung
alertsForAllJobFailures	AlertsState

BackupVault

BackupVault

Name	Typ	Beschreibung
featureSettings	FeatureSettings	Featureeinstellungen
isVaultProtectedByResourceGuard	boolean	Ist der Tresor durch Ressourcenschutz geschützt
monitoringSettings	MonitoringSettings	Überwachungseinstellungen
provisioningState	ProvisioningState	Bereitstellungsstatus der BackupVault-Ressource
resourceMoveDetails	ResourceMoveDetails	Details zur Ressourcenverschiebung für den Sicherungstresor
resourceMoveState	ResourceMoveState	Ressourcenverschiebungsstatus für Sicherungstresor
securitySettings	SecuritySettings	Sicherheitseinstellungen
storageSettings	StorageSetting[]	Speichereinstellungen

BackupVaultResource

BackupVault-Ressource

Name	Typ	Beschreibung
eTag	string	Optionales ETag.
id	string	Die Ressourcen-ID stellt den vollständigen Pfad zur Ressource dar.
identity	DppIdentityDetails	DppIdentityDetails Eingeben von Details zur verwalteten Identität
location	string	Ressourcenspeicherort
name	string	Ressourcenname, der der Ressource zugeordnet ist.
properties	BackupVault	BackupVault BackupVaultResource-Eigenschaften
systemData	systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
tags	object	Ressourcentags.
type	string	Der Ressourcentyp stellt den vollständigen Pfad des Formulars Namespace/ResourceType/ResourceType/...

BackupVaultResourceList

BackupVaultResourceList

Name	Typ	Beschreibung
nextLink	string	Der URI, um die nächste Seite der Ressourcen abzurufen. Call ListNext() ruft die nächste Seite von Ressourcen ab.
value	BackupVaultResource[]	Liste der Ressourcen.

CloudError

CloudError

Name	Typ	Beschreibung
error	Error	Die Fehlerantwort für die Ressourcenverwaltung.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

CrossSubscriptionRestoreSettings

CrossSubscriptionRestore-Einstellungen

Name	Typ	Beschreibung
state	CrossSubscriptionRestoreState	CrossSubscriptionRestore-Zustand

CrossSubscriptionRestoreState

CrossSubscriptionRestore-Zustand

Name	Typ	Beschreibung
Disabled	string
Enabled	string
PermanentlyDisabled	string

DppIdentityDetails

DppIdentityDetails

Name	Typ	Beschreibung
principalId	string	Die Objekt-ID des Dienstprinzipalsobjekts für die verwaltete Identität, die verwendet wird, um rollenbasierten Zugriff auf eine Azure-Ressource zu gewähren.
tenantId	string	Ein Globally Unique Identifier (GUID), der den Azure AD-Mandanten darstellt, in dem die Ressource jetzt mitglied ist.
type	string	Der identityType, der entweder SystemAssigned oder None sein kann.

Error

Die Fehlerantwort für die Ressourcenverwaltung.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen zum Fehler.
code	string	Der Fehlercode.
details	Error[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Infotyp.

FeatureSettings

Klasse mit Featureeinstellungen des Tresors

Name	Typ	Beschreibung
crossSubscriptionRestoreSettings	CrossSubscriptionRestoreSettings	CrossSubscriptionRestore-Einstellungen

ImmutabilitySettings

Unveränderlichkeitseinstellungen auf Tresorebene

Name	Typ	Beschreibung
state	ImmutabilityState	Unveränderlichkeitszustand

ImmutabilityState

Unveränderlichkeitszustand

Name	Typ	Beschreibung
Disabled	string
Locked	string
Unlocked	string

MonitoringSettings

Überwachungseinstellungen

Name	Typ	Beschreibung
azureMonitorAlertSettings	AzureMonitorAlertSettings	Einstellungen für Azure Monitor-basierte Warnungen

ProvisioningState

Bereitstellungsstatus der BackupVault-Ressource

Name	Typ	Beschreibung
Failed	string
Provisioning	string
Succeeded	string
Unknown	string
Updating	string

ResourceMoveDetails

ResourceMoveDetails wird als Antwort auf den GetResource-Aufruf von ARM zurückgegeben.

Name	Typ	Beschreibung
completionTimeUtc	string	Abschlusszeit in UTC des letzten ResourceMove-Vorgangs versucht. Die Angabe erfolgt im ISO 8601-Format.
operationId	string	CorrelationId des letzten ResourceMove-Vorgangs versucht
sourceResourcePath	string	ARM-Ressourcenpfad der Quellressource
startTimeUtc	string	Startzeit in UTC des letzten ResourceMove-Vorgangs versucht. Die Angabe erfolgt im ISO 8601-Format.
targetResourcePath	string	ARM-Ressourcenpfad der Zielressource, die im neuesten ResourceMove-Vorgang verwendet wird

ResourceMoveState

Ressourcenverschiebungsstatus für Sicherungstresor

Name	Typ	Beschreibung
CommitFailed	string
CommitTimedout	string
CriticalFailure	string
Failed	string
InProgress	string
MoveSucceeded	string
PartialSuccess	string
PrepareFailed	string
PrepareTimedout	string
Unknown	string

SecuritySettings

Klasse mit Sicherheitseinstellungen des Tresors

Name	Typ	Beschreibung
immutabilitySettings	ImmutabilitySettings	Unveränderlichkeitseinstellungen auf Tresorebene
softDeleteSettings	SoftDeleteSettings	Einstellungen für vorläufiges Löschen

SoftDeleteSettings

Einstellungen für vorläufiges Löschen

Name	Typ	Beschreibung
retentionDurationInDays	number	Aufbewahrungsdauer für vorläufiges Löschen
state	SoftDeleteState	Zustand des vorläufigen Löschens

SoftDeleteState

Zustand des vorläufigen Löschens

Name	Typ	Beschreibung
AlwaysOn	string	Vorläufiges Löschen ist für den BackupVault dauerhaft aktiviert, und die Einstellung kann nicht geändert werden.
Off	string	Vorläufiges Löschen ist für den BackupVault deaktiviert.
On	string	Vorläufiges Löschen ist für backupVault aktiviert, kann aber deaktiviert werden.

StorageSetting

StorageSetting

Name	Typ	Beschreibung
datastoreType	StorageSettingStoreTypes	Ruft den Typ des Datenspeichers ab oder legt diese fest.
type	StorageSettingTypes	Ruft den Typ ab oder legt den Typ fest.

StorageSettingStoreTypes

Ruft den Typ des Datenspeichers ab oder legt diese fest.

Name	Typ	Beschreibung
ArchiveStore	string
OperationalStore	string
VaultStore	string

StorageSettingTypes

Ruft den Typ ab oder legt den Typ fest.

Name	Typ	Beschreibung
GeoRedundant	string
LocallyRedundant	string
ZoneRedundant	string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.