Backup Vaults - Create Or Update

Serviço:: Data Protection

Versão da API:: 2026-03-01

Cria ou atualiza um recurso BackupVault que pertence a um grupo de recursos.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
vaultName	path	True	string	O nome do BackupVaultResource
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-authorization-auxiliary		string
x-ms-deleted-vault-id		string	A ID do cofre de backup excluído a ser restaurado durante o fluxo de recuperação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
location	True	string	A localização geográfica onde o recurso reside
properties	True	BackupVault	Propriedades de BackupVaultResource
eTag		string	ETag opcional.
identity		DppIdentityDetails	Detalhes da identidade gerenciada de entrada
tags		object	Tags de recursos.

Respostas

Nome	Tipo	Description
200 OK	BackupVaultResource	Operação de atualização do recurso 'BackupVaultResource' bem-sucedida
201 Created	BackupVaultResource	Operação de criação do recurso 'BackupVaultResource' bem-sucedida Cabeçalhos Location: string Retry-After: integer
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Nome

Tipo

Description

200 OK

BackupVaultResource

Operação de atualização do recurso 'BackupVaultResource' bem-sucedida

201 Created

BackupVaultResource

Operação de criação do recurso 'BackupVaultResource' bem-sucedida

Cabeçalhos

Location: string
Retry-After: integer

Other Status Codes

CloudError

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Create BackupVault

Create BackupVault With CMK

Create BackupVault With MSI

Create or Update Backup Vault With CMK and Resource Guard Enabled

Restore a soft-deleted backup vault

Create BackupVault

Solicitação de exemplo

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

{
  "location": "WestUS",
  "properties": {
    "featureSettings": {
      "crossRegionRestoreSettings": {
        "state": "Enabled"
      }
    },
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllJobFailures": "Enabled"
      }
    },
    "securitySettings": {
      "softDeleteSettings": {
        "retentionDurationInDays": 14,
        "state": "Enabled"
      }
    },
    "storageSettings": [
      {
        "type": "LocallyRedundant",
        "datastoreType": "VaultStore"
      }
    ]
  },
  "tags": {
    "key1": "val1"
  }
}


import com.azure.resourcemanager.dataprotection.models.AlertsState;
import com.azure.resourcemanager.dataprotection.models.AzureMonitorAlertSettings;
import com.azure.resourcemanager.dataprotection.models.BackupVault;
import com.azure.resourcemanager.dataprotection.models.CrossRegionRestoreSettings;
import com.azure.resourcemanager.dataprotection.models.CrossRegionRestoreState;
import com.azure.resourcemanager.dataprotection.models.FeatureSettings;
import com.azure.resourcemanager.dataprotection.models.MonitoringSettings;
import com.azure.resourcemanager.dataprotection.models.SecuritySettings;
import com.azure.resourcemanager.dataprotection.models.SoftDeleteSettings;
import com.azure.resourcemanager.dataprotection.models.SoftDeleteState;
import com.azure.resourcemanager.dataprotection.models.StorageSetting;
import com.azure.resourcemanager.dataprotection.models.StorageSettingStoreTypes;
import com.azure.resourcemanager.dataprotection.models.StorageSettingTypes;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for BackupVaults CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-03-01/VaultCRUD/PutBackupVault.json
     */
    /**
     * Sample code: Create BackupVault.
     * 
     * @param manager Entry point to DataProtectionManager.
     */
    public static void createBackupVault(com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager.backupVaults().define("swaggerExample").withRegion("WestUS")
            .withExistingResourceGroup("SampleResourceGroup")
            .withProperties(new BackupVault()
                .withMonitoringSettings(new MonitoringSettings().withAzureMonitorAlertSettings(
                    new AzureMonitorAlertSettings().withAlertsForAllJobFailures(AlertsState.ENABLED)))
                .withSecuritySettings(new SecuritySettings().withSoftDeleteSettings(new SoftDeleteSettings()
                    .withState(SoftDeleteState.fromString("Enabled")).withRetentionDurationInDays(14.0D)))
                .withStorageSettings(
                    Arrays.asList(new StorageSetting().withDatastoreType(StorageSettingStoreTypes.VAULT_STORE)
                        .withType(StorageSettingTypes.LOCALLY_REDUNDANT)))
                .withFeatureSettings(new FeatureSettings().withCrossRegionRestoreSettings(
                    new CrossRegionRestoreSettings().withState(CrossRegionRestoreState.ENABLED))))
            .withTags(mapOf("key1", "fakeTokenPlaceholder")).create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python put_backup_vault.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="SUBSCRIPTION_ID",
    )

    response = client.backup_vaults.begin_create_or_update(
        resource_group_name="SampleResourceGroup",
        vault_name="swaggerExample",
        parameters={
            "location": "WestUS",
            "properties": {
                "featureSettings": {"crossRegionRestoreSettings": {"state": "Enabled"}},
                "monitoringSettings": {"azureMonitorAlertSettings": {"alertsForAllJobFailures": "Enabled"}},
                "securitySettings": {"softDeleteSettings": {"retentionDurationInDays": 14, "state": "Enabled"}},
                "storageSettings": [{"datastoreType": "VaultStore", "type": "LocallyRedundant"}],
            },
            "tags": {"key1": "val1"},
        },
    ).result()
    print(response)


# x-ms-original-file: 2026-03-01/VaultCRUD/PutBackupVault.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

package armdataprotection_test

import (
	"context"
	"log"

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

// Generated from example definition: 2026-03-01/VaultCRUD/PutBackupVault.json
func ExampleBackupVaultsClient_BeginCreateOrUpdate_createBackupVault() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataprotection.NewClientFactory("0b352192-dcac-4cc7-992e-a96190ccc68c", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBackupVaultsClient().BeginCreateOrUpdate(ctx, "SampleResourceGroup", "swaggerExample", armdataprotection.BackupVaultResource{
		Location: to.Ptr("WestUS"),
		Properties: &armdataprotection.BackupVault{
			FeatureSettings: &armdataprotection.FeatureSettings{
				CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
					State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
				},
			},
			MonitoringSettings: &armdataprotection.MonitoringSettings{
				AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
					AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
				},
			},
			SecuritySettings: &armdataprotection.SecuritySettings{
				SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
					RetentionDurationInDays: to.Ptr[float64](14),
					State:                   to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
				},
			},
			StorageSettings: []*armdataprotection.StorageSetting{
				{
					Type:          to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
					DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
				},
			},
		},
		Tags: map[string]*string{
			"key1": to.Ptr("val1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdataprotection.BackupVaultsClientCreateOrUpdateResponse{
	// 	BackupVaultResource: &armdataprotection.BackupVaultResource{
	// 		Name: to.Ptr("swaggerExample"),
	// 		Type: to.Ptr("Microsoft.DataProtection/Backupvaults"),
	// 		ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample"),
	// 		Location: to.Ptr("WestUS"),
	// 		Properties: &armdataprotection.BackupVault{
	// 			FeatureSettings: &armdataprotection.FeatureSettings{
	// 				CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
	// 					State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
	// 				},
	// 			},
	// 			MonitoringSettings: &armdataprotection.MonitoringSettings{
	// 				AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
	// 					AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
	// 				},
	// 			},
	// 			ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
	// 			SecureScore: to.Ptr(armdataprotection.SecureScoreLevelAdequate),
	// 			SecuritySettings: &armdataprotection.SecuritySettings{
	// 				SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
	// 					RetentionDurationInDays: to.Ptr[float64](14),
	// 					State: to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
	// 				},
	// 			},
	// 			StorageSettings: []*armdataprotection.StorageSetting{
	// 				{
	// 					Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
	// 					DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
	// 				},
	// 			},
	// 		},
	// 		Tags: map[string]*string{
	// 			"key1": to.Ptr("val1"),
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to creates or updates a BackupVault resource belonging to a resource group.
 *
 * @summary creates or updates a BackupVault resource belonging to a resource group.
 * x-ms-original-file: 2026-03-01/VaultCRUD/PutBackupVault.json
 */
async function createBackupVault() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "0b352192-dcac-4cc7-992e-a96190ccc68c";
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.backupVaults.createOrUpdate("SampleResourceGroup", "swaggerExample", {
    location: "WestUS",
    properties: {
      featureSettings: { crossRegionRestoreSettings: { state: "Enabled" } },
      monitoringSettings: { azureMonitorAlertSettings: { alertsForAllJobFailures: "Enabled" } },
      securitySettings: { softDeleteSettings: { retentionDurationInDays: 14, state: "Enabled" } },
      storageSettings: [{ type: "LocallyRedundant", datastoreType: "VaultStore" }],
    },
    tags: { key1: "val1" },
  });
  console.log(result);
}

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

Resposta de exemplo

Código de status:: 200

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

Código de status:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2026-03-01
Retry-After: 10

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

Create BackupVault With CMK

Solicitação de exemplo

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

{
  "location": "WestUS",
  "properties": {
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllJobFailures": "Enabled"
      }
    },
    "securitySettings": {
      "encryptionSettings": {
        "infrastructureEncryption": "Enabled",
        "kekIdentity": {
          "identityId": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourceGroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi",
          "identityType": "UserAssigned"
        },
        "keyVaultProperties": {
          "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3"
        },
        "state": "Enabled"
      },
      "immutabilitySettings": {
        "state": "Disabled"
      },
      "softDeleteSettings": {
        "retentionDurationInDays": 0,
        "state": "Off"
      }
    },
    "storageSettings": [
      {
        "type": "LocallyRedundant",
        "datastoreType": "VaultStore"
      }
    ]
  },
  "tags": {
    "key1": "val1"
  }
}


import com.azure.resourcemanager.dataprotection.models.AlertsState;
import com.azure.resourcemanager.dataprotection.models.AzureMonitorAlertSettings;
import com.azure.resourcemanager.dataprotection.models.BackupVault;
import com.azure.resourcemanager.dataprotection.models.CmkKekIdentity;
import com.azure.resourcemanager.dataprotection.models.CmkKeyVaultProperties;
import com.azure.resourcemanager.dataprotection.models.EncryptionSettings;
import com.azure.resourcemanager.dataprotection.models.EncryptionState;
import com.azure.resourcemanager.dataprotection.models.IdentityType;
import com.azure.resourcemanager.dataprotection.models.ImmutabilitySettings;
import com.azure.resourcemanager.dataprotection.models.ImmutabilityState;
import com.azure.resourcemanager.dataprotection.models.InfrastructureEncryptionState;
import com.azure.resourcemanager.dataprotection.models.MonitoringSettings;
import com.azure.resourcemanager.dataprotection.models.SecuritySettings;
import com.azure.resourcemanager.dataprotection.models.SoftDeleteSettings;
import com.azure.resourcemanager.dataprotection.models.SoftDeleteState;
import com.azure.resourcemanager.dataprotection.models.StorageSetting;
import com.azure.resourcemanager.dataprotection.models.StorageSettingStoreTypes;
import com.azure.resourcemanager.dataprotection.models.StorageSettingTypes;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for BackupVaults CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-03-01/VaultCRUD/PutBackupVaultWithCMK.json
     */
    /**
     * Sample code: Create BackupVault With CMK.
     * 
     * @param manager Entry point to DataProtectionManager.
     */
    public static void
        createBackupVaultWithCMK(com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager.backupVaults().define("swaggerExample").withRegion("WestUS")
            .withExistingResourceGroup("SampleResourceGroup")
            .withProperties(new BackupVault()
                .withMonitoringSettings(new MonitoringSettings().withAzureMonitorAlertSettings(
                    new AzureMonitorAlertSettings().withAlertsForAllJobFailures(AlertsState.ENABLED)))
                .withSecuritySettings(new SecuritySettings()
                    .withSoftDeleteSettings(
                        new SoftDeleteSettings().withState(SoftDeleteState.OFF).withRetentionDurationInDays(0.0D))
                    .withImmutabilitySettings(new ImmutabilitySettings().withState(ImmutabilityState.DISABLED))
                    .withEncryptionSettings(new EncryptionSettings().withState(EncryptionState.ENABLED)
                        .withKeyVaultProperties(new CmkKeyVaultProperties().withKeyUri("fakeTokenPlaceholder"))
                        .withKekIdentity(
                            new CmkKekIdentity().withIdentityType(IdentityType.USER_ASSIGNED).withIdentityId(
                                "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi"))
                        .withInfrastructureEncryption(InfrastructureEncryptionState.ENABLED)))
                .withStorageSettings(
                    Arrays.asList(new StorageSetting().withDatastoreType(StorageSettingStoreTypes.VAULT_STORE)
                        .withType(StorageSettingTypes.LOCALLY_REDUNDANT))))
            .withTags(mapOf("key1", "fakeTokenPlaceholder")).create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python put_backup_vault_with_cmk.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="SUBSCRIPTION_ID",
    )

    response = client.backup_vaults.begin_create_or_update(
        resource_group_name="SampleResourceGroup",
        vault_name="swaggerExample",
        parameters={
            "location": "WestUS",
            "properties": {
                "monitoringSettings": {"azureMonitorAlertSettings": {"alertsForAllJobFailures": "Enabled"}},
                "securitySettings": {
                    "encryptionSettings": {
                        "infrastructureEncryption": "Enabled",
                        "kekIdentity": {
                            "identityId": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi",
                            "identityType": "UserAssigned",
                        },
                        "keyVaultProperties": {
                            "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3"
                        },
                        "state": "Enabled",
                    },
                    "immutabilitySettings": {"state": "Disabled"},
                    "softDeleteSettings": {"retentionDurationInDays": 0, "state": "Off"},
                },
                "storageSettings": [{"datastoreType": "VaultStore", "type": "LocallyRedundant"}],
            },
            "tags": {"key1": "val1"},
        },
    ).result()
    print(response)


# x-ms-original-file: 2026-03-01/VaultCRUD/PutBackupVaultWithCMK.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

package armdataprotection_test

import (
	"context"
	"log"

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

// Generated from example definition: 2026-03-01/VaultCRUD/PutBackupVaultWithCMK.json
func ExampleBackupVaultsClient_BeginCreateOrUpdate_createBackupVaultWithCmk() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataprotection.NewClientFactory("0b352192-dcac-4cc7-992e-a96190ccc68c", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBackupVaultsClient().BeginCreateOrUpdate(ctx, "SampleResourceGroup", "swaggerExample", armdataprotection.BackupVaultResource{
		Location: to.Ptr("WestUS"),
		Properties: &armdataprotection.BackupVault{
			MonitoringSettings: &armdataprotection.MonitoringSettings{
				AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
					AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
				},
			},
			SecuritySettings: &armdataprotection.SecuritySettings{
				EncryptionSettings: &armdataprotection.EncryptionSettings{
					InfrastructureEncryption: to.Ptr(armdataprotection.InfrastructureEncryptionStateEnabled),
					KekIdentity: &armdataprotection.CmkKekIdentity{
						IdentityID:   to.Ptr("/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi"),
						IdentityType: to.Ptr(armdataprotection.IdentityTypeUserAssigned),
					},
					KeyVaultProperties: &armdataprotection.CmkKeyVaultProperties{
						KeyURI: to.Ptr("https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3"),
					},
					State: to.Ptr(armdataprotection.EncryptionStateEnabled),
				},
				ImmutabilitySettings: &armdataprotection.ImmutabilitySettings{
					State: to.Ptr(armdataprotection.ImmutabilityStateDisabled),
				},
				SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
					RetentionDurationInDays: to.Ptr[float64](0),
					State:                   to.Ptr(armdataprotection.SoftDeleteStateOff),
				},
			},
			StorageSettings: []*armdataprotection.StorageSetting{
				{
					Type:          to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
					DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
				},
			},
		},
		Tags: map[string]*string{
			"key1": to.Ptr("val1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdataprotection.BackupVaultsClientCreateOrUpdateResponse{
	// 	BackupVaultResource: &armdataprotection.BackupVaultResource{
	// 		Name: to.Ptr("swaggerExample"),
	// 		Type: to.Ptr("Microsoft.DataProtection/Backupvaults"),
	// 		ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample"),
	// 		Location: to.Ptr("WestUS"),
	// 		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),
	// 				},
	// 			},
	// 		},
	// 		Tags: map[string]*string{
	// 			"key1": to.Ptr("val1"),
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to creates or updates a BackupVault resource belonging to a resource group.
 *
 * @summary creates or updates a BackupVault resource belonging to a resource group.
 * x-ms-original-file: 2026-03-01/VaultCRUD/PutBackupVaultWithCMK.json
 */
async function createBackupVaultWithCMK() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "0b352192-dcac-4cc7-992e-a96190ccc68c";
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.backupVaults.createOrUpdate("SampleResourceGroup", "swaggerExample", {
    location: "WestUS",
    properties: {
      monitoringSettings: { azureMonitorAlertSettings: { alertsForAllJobFailures: "Enabled" } },
      securitySettings: {
        encryptionSettings: {
          infrastructureEncryption: "Enabled",
          kekIdentity: {
            identityId:
              "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi",
            identityType: "UserAssigned",
          },
          keyVaultProperties: {
            keyUri: "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3",
          },
          state: "Enabled",
        },
        immutabilitySettings: { state: "Disabled" },
        softDeleteSettings: { retentionDurationInDays: 0, state: "Off" },
      },
      storageSettings: [{ type: "LocallyRedundant", datastoreType: "VaultStore" }],
    },
    tags: { key1: "val1" },
  });
  console.log(result);
}

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

Resposta de exemplo

Código de status:: 200

{
  "name": "swaggerExample",
  "type": "Microsoft.DataProtection/Backupvaults",
  "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
  "location": "WestUS",
  "properties": {
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllJobFailures": "Enabled"
      }
    },
    "provisioningState": "Succeeded",
    "storageSettings": [
      {
        "type": "LocallyRedundant",
        "datastoreType": "VaultStore"
      }
    ]
  },
  "tags": {
    "key1": "val1"
  }
}

Código de status:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-04-01-privatepreview
Retry-After: 10

{
  "name": "swaggerExample",
  "type": "Microsoft.DataProtection/Backupvaults",
  "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
  "location": "WestUS",
  "properties": {
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllJobFailures": "Enabled"
      }
    },
    "provisioningState": "Provisioning",
    "securitySettings": {
      "encryptionSettings": {
        "infrastructureEncryption": "Enabled",
        "kekIdentity": {
          "identityId": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourceGroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi",
          "identityType": "UserAssigned"
        },
        "keyVaultProperties": {
          "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3"
        },
        "state": "Enabled"
      },
      "immutabilitySettings": {
        "state": "Disabled"
      },
      "softDeleteSettings": {
        "retentionDurationInDays": 0,
        "state": "Off"
      }
    },
    "storageSettings": [
      {
        "type": "LocallyRedundant",
        "datastoreType": "VaultStore"
      }
    ]
  },
  "tags": {
    "key1": "val1"
  }
}

Create BackupVault With MSI

Solicitação de exemplo

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

{
  "location": "WestUS",
  "properties": {
    "featureSettings": {
      "crossRegionRestoreSettings": {
        "state": "Enabled"
      }
    },
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllJobFailures": "Enabled"
      }
    },
    "securitySettings": {
      "softDeleteSettings": {
        "retentionDurationInDays": 14,
        "state": "Enabled"
      }
    },
    "storageSettings": [
      {
        "type": "LocallyRedundant",
        "datastoreType": "VaultStore"
      }
    ]
  },
  "tags": {
    "key1": "val1"
  }
}


import com.azure.resourcemanager.dataprotection.models.AlertsState;
import com.azure.resourcemanager.dataprotection.models.AzureMonitorAlertSettings;
import com.azure.resourcemanager.dataprotection.models.BackupVault;
import com.azure.resourcemanager.dataprotection.models.CrossRegionRestoreSettings;
import com.azure.resourcemanager.dataprotection.models.CrossRegionRestoreState;
import com.azure.resourcemanager.dataprotection.models.FeatureSettings;
import com.azure.resourcemanager.dataprotection.models.MonitoringSettings;
import com.azure.resourcemanager.dataprotection.models.SecuritySettings;
import com.azure.resourcemanager.dataprotection.models.SoftDeleteSettings;
import com.azure.resourcemanager.dataprotection.models.SoftDeleteState;
import com.azure.resourcemanager.dataprotection.models.StorageSetting;
import com.azure.resourcemanager.dataprotection.models.StorageSettingStoreTypes;
import com.azure.resourcemanager.dataprotection.models.StorageSettingTypes;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for BackupVaults CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-03-01/VaultCRUD/PutBackupVaultWithMSI.json
     */
    /**
     * Sample code: Create BackupVault With MSI.
     * 
     * @param manager Entry point to DataProtectionManager.
     */
    public static void
        createBackupVaultWithMSI(com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager.backupVaults().define("swaggerExample").withRegion("WestUS")
            .withExistingResourceGroup("SampleResourceGroup")
            .withProperties(new BackupVault()
                .withMonitoringSettings(new MonitoringSettings().withAzureMonitorAlertSettings(
                    new AzureMonitorAlertSettings().withAlertsForAllJobFailures(AlertsState.ENABLED)))
                .withSecuritySettings(new SecuritySettings().withSoftDeleteSettings(new SoftDeleteSettings()
                    .withState(SoftDeleteState.fromString("Enabled")).withRetentionDurationInDays(14.0D)))
                .withStorageSettings(
                    Arrays.asList(new StorageSetting().withDatastoreType(StorageSettingStoreTypes.VAULT_STORE)
                        .withType(StorageSettingTypes.LOCALLY_REDUNDANT)))
                .withFeatureSettings(new FeatureSettings().withCrossRegionRestoreSettings(
                    new CrossRegionRestoreSettings().withState(CrossRegionRestoreState.ENABLED))))
            .withTags(mapOf("key1", "fakeTokenPlaceholder")).create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python put_backup_vault_with_msi.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="SUBSCRIPTION_ID",
    )

    response = client.backup_vaults.begin_create_or_update(
        resource_group_name="SampleResourceGroup",
        vault_name="swaggerExample",
        parameters={
            "location": "WestUS",
            "properties": {
                "featureSettings": {"crossRegionRestoreSettings": {"state": "Enabled"}},
                "monitoringSettings": {"azureMonitorAlertSettings": {"alertsForAllJobFailures": "Enabled"}},
                "securitySettings": {"softDeleteSettings": {"retentionDurationInDays": 14, "state": "Enabled"}},
                "storageSettings": [{"datastoreType": "VaultStore", "type": "LocallyRedundant"}],
            },
            "tags": {"key1": "val1"},
        },
    ).result()
    print(response)


# x-ms-original-file: 2026-03-01/VaultCRUD/PutBackupVaultWithMSI.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

package armdataprotection_test

import (
	"context"
	"log"

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

// Generated from example definition: 2026-03-01/VaultCRUD/PutBackupVaultWithMSI.json
func ExampleBackupVaultsClient_BeginCreateOrUpdate_createBackupVaultWithMsi() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataprotection.NewClientFactory("0b352192-dcac-4cc7-992e-a96190ccc68c", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBackupVaultsClient().BeginCreateOrUpdate(ctx, "SampleResourceGroup", "swaggerExample", armdataprotection.BackupVaultResource{
		Location: to.Ptr("WestUS"),
		Properties: &armdataprotection.BackupVault{
			FeatureSettings: &armdataprotection.FeatureSettings{
				CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
					State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
				},
			},
			MonitoringSettings: &armdataprotection.MonitoringSettings{
				AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
					AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
				},
			},
			SecuritySettings: &armdataprotection.SecuritySettings{
				SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
					RetentionDurationInDays: to.Ptr[float64](14),
					State:                   to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
				},
			},
			StorageSettings: []*armdataprotection.StorageSetting{
				{
					Type:          to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
					DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
				},
			},
		},
		Tags: map[string]*string{
			"key1": to.Ptr("val1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdataprotection.BackupVaultsClientCreateOrUpdateResponse{
	// 	BackupVaultResource: &armdataprotection.BackupVaultResource{
	// 		Name: to.Ptr("swaggerExample"),
	// 		Type: to.Ptr("Microsoft.DataProtection/Backupvaults"),
	// 		ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample"),
	// 		Location: to.Ptr("WestUS"),
	// 		Properties: &armdataprotection.BackupVault{
	// 			FeatureSettings: &armdataprotection.FeatureSettings{
	// 				CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
	// 					State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
	// 				},
	// 			},
	// 			MonitoringSettings: &armdataprotection.MonitoringSettings{
	// 				AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
	// 					AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
	// 				},
	// 			},
	// 			ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
	// 			SecureScore: to.Ptr(armdataprotection.SecureScoreLevelAdequate),
	// 			SecuritySettings: &armdataprotection.SecuritySettings{
	// 				SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
	// 					RetentionDurationInDays: to.Ptr[float64](14),
	// 					State: to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
	// 				},
	// 			},
	// 			StorageSettings: []*armdataprotection.StorageSetting{
	// 				{
	// 					Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
	// 					DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
	// 				},
	// 			},
	// 		},
	// 		Tags: map[string]*string{
	// 			"key1": to.Ptr("val1"),
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to creates or updates a BackupVault resource belonging to a resource group.
 *
 * @summary creates or updates a BackupVault resource belonging to a resource group.
 * x-ms-original-file: 2026-03-01/VaultCRUD/PutBackupVaultWithMSI.json
 */
async function createBackupVaultWithMSI() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "0b352192-dcac-4cc7-992e-a96190ccc68c";
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.backupVaults.createOrUpdate("SampleResourceGroup", "swaggerExample", {
    location: "WestUS",
    properties: {
      featureSettings: { crossRegionRestoreSettings: { state: "Enabled" } },
      monitoringSettings: { azureMonitorAlertSettings: { alertsForAllJobFailures: "Enabled" } },
      securitySettings: { softDeleteSettings: { retentionDurationInDays: 14, state: "Enabled" } },
      storageSettings: [{ type: "LocallyRedundant", datastoreType: "VaultStore" }],
    },
    tags: { key1: "val1" },
  });
  console.log(result);
}

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

Resposta de exemplo

Código de status:: 200

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

Código de status:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2026-03-01
Retry-After: 10

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

Create or Update Backup Vault With CMK and Resource Guard Enabled

Solicitação de exemplo

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

{
  "location": "WestUS",
  "tags": {
    "key1": "val1"
  },
  "identity": {
    "type": "None"
  },
  "properties": {
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllJobFailures": "Enabled"
      }
    },
    "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": "Enabled"
      }
    },
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ]
  }
}

Resposta de exemplo

Código de status:: 201

Retry-After: 10
Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2026-03-01

{
  "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"
      }
    },
    "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": "Enabled"
      }
    },
    "resourceGuardOperationRequests": [
      "/subscriptions/754ec39f-8d2a-44cf-bfbf-13107ac85c36/resourcegroups/mua-testing/providers/Microsoft.DataProtection/resourceGuards/gvjreddy-test-ecy-rg-reader/dppModifyEncryptionSettingsRequests/default"
    ],
    "provisioningState": "Provisioning",
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ]
  }
}

Código de status:: 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"
      }
    ]
  }
}

Restore a soft-deleted backup vault

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample?api-version=2026-03-01


{
  "location": "WestUS",
  "properties": {
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllJobFailures": "Enabled"
      }
    },
    "securitySettings": {
      "softDeleteSettings": {
        "retentionDurationInDays": 14,
        "state": "Enabled"
      },
      "immutabilitySettings": {
        "state": "Disabled"
      }
    },
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ],
    "featureSettings": {
      "crossSubscriptionRestoreSettings": {
        "state": "Disabled"
      },
      "crossRegionRestoreSettings": {
        "state": "Enabled"
      }
    }
  },
  "tags": {
    "key1": "val1"
  }
}


import com.azure.resourcemanager.dataprotection.models.AlertsState;
import com.azure.resourcemanager.dataprotection.models.AzureMonitorAlertSettings;
import com.azure.resourcemanager.dataprotection.models.BackupVault;
import com.azure.resourcemanager.dataprotection.models.CrossRegionRestoreSettings;
import com.azure.resourcemanager.dataprotection.models.CrossRegionRestoreState;
import com.azure.resourcemanager.dataprotection.models.CrossSubscriptionRestoreSettings;
import com.azure.resourcemanager.dataprotection.models.CrossSubscriptionRestoreState;
import com.azure.resourcemanager.dataprotection.models.FeatureSettings;
import com.azure.resourcemanager.dataprotection.models.ImmutabilitySettings;
import com.azure.resourcemanager.dataprotection.models.ImmutabilityState;
import com.azure.resourcemanager.dataprotection.models.MonitoringSettings;
import com.azure.resourcemanager.dataprotection.models.SecuritySettings;
import com.azure.resourcemanager.dataprotection.models.SoftDeleteSettings;
import com.azure.resourcemanager.dataprotection.models.SoftDeleteState;
import com.azure.resourcemanager.dataprotection.models.StorageSetting;
import com.azure.resourcemanager.dataprotection.models.StorageSettingStoreTypes;
import com.azure.resourcemanager.dataprotection.models.StorageSettingTypes;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for BackupVaults CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-03-01/PutBackupVaultWithUndelete.json
     */
    /**
     * Sample code: Restore a soft-deleted backup vault.
     * 
     * @param manager Entry point to DataProtectionManager.
     */
    public static void
        restoreASoftDeletedBackupVault(com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager.backupVaults().define("swaggerExample").withRegion("WestUS")
            .withExistingResourceGroup("SampleResourceGroup")
            .withProperties(new BackupVault()
                .withMonitoringSettings(new MonitoringSettings().withAzureMonitorAlertSettings(
                    new AzureMonitorAlertSettings().withAlertsForAllJobFailures(AlertsState.ENABLED)))
                .withSecuritySettings(new SecuritySettings()
                    .withSoftDeleteSettings(new SoftDeleteSettings().withState(SoftDeleteState.fromString("Enabled"))
                        .withRetentionDurationInDays(14.0D))
                    .withImmutabilitySettings(new ImmutabilitySettings().withState(ImmutabilityState.DISABLED)))
                .withStorageSettings(
                    Arrays.asList(new StorageSetting().withDatastoreType(StorageSettingStoreTypes.VAULT_STORE)
                        .withType(StorageSettingTypes.LOCALLY_REDUNDANT)))
                .withFeatureSettings(new FeatureSettings()
                    .withCrossSubscriptionRestoreSettings(
                        new CrossSubscriptionRestoreSettings().withState(CrossSubscriptionRestoreState.DISABLED))
                    .withCrossRegionRestoreSettings(
                        new CrossRegionRestoreSettings().withState(CrossRegionRestoreState.ENABLED))))
            .withTags(mapOf("key1", "fakeTokenPlaceholder"))
            .withXMsDeletedVaultId(
                "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DataProtection/locations/WestUS/deletedVaults/swaggerExample")
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python put_backup_vault_with_undelete.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="SUBSCRIPTION_ID",
    )

    response = client.backup_vaults.begin_create_or_update(
        resource_group_name="SampleResourceGroup",
        vault_name="swaggerExample",
        parameters={
            "location": "WestUS",
            "properties": {
                "featureSettings": {
                    "crossRegionRestoreSettings": {"state": "Enabled"},
                    "crossSubscriptionRestoreSettings": {"state": "Disabled"},
                },
                "monitoringSettings": {"azureMonitorAlertSettings": {"alertsForAllJobFailures": "Enabled"}},
                "securitySettings": {
                    "immutabilitySettings": {"state": "Disabled"},
                    "softDeleteSettings": {"retentionDurationInDays": 14, "state": "Enabled"},
                },
                "storageSettings": [{"datastoreType": "VaultStore", "type": "LocallyRedundant"}],
            },
            "tags": {"key1": "val1"},
        },
    ).result()
    print(response)


# x-ms-original-file: 2026-03-01/PutBackupVaultWithUndelete.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

package armdataprotection_test

import (
	"context"
	"log"

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

// Generated from example definition: 2026-03-01/PutBackupVaultWithUndelete.json
func ExampleBackupVaultsClient_BeginCreateOrUpdate_restoreASoftDeletedBackupVault() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataprotection.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBackupVaultsClient().BeginCreateOrUpdate(ctx, "SampleResourceGroup", "swaggerExample", armdataprotection.BackupVaultResource{
		Location: to.Ptr("WestUS"),
		Properties: &armdataprotection.BackupVault{
			MonitoringSettings: &armdataprotection.MonitoringSettings{
				AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
					AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
				},
			},
			SecuritySettings: &armdataprotection.SecuritySettings{
				SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
					RetentionDurationInDays: to.Ptr[float64](14),
					State:                   to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
				},
				ImmutabilitySettings: &armdataprotection.ImmutabilitySettings{
					State: to.Ptr(armdataprotection.ImmutabilityStateDisabled),
				},
			},
			StorageSettings: []*armdataprotection.StorageSetting{
				{
					DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
					Type:          to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
				},
			},
			FeatureSettings: &armdataprotection.FeatureSettings{
				CrossSubscriptionRestoreSettings: &armdataprotection.CrossSubscriptionRestoreSettings{
					State: to.Ptr(armdataprotection.CrossSubscriptionRestoreStateDisabled),
				},
				CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
					State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
				},
			},
		},
		Tags: map[string]*string{
			"key1": to.Ptr("val1"),
		},
	}, &armdataprotection.BackupVaultsClientBeginCreateOrUpdateOptions{
		XMSDeletedVaultID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DataProtection/locations/WestUS/deletedVaults/swaggerExample")})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdataprotection.BackupVaultsClientCreateOrUpdateResponse{
	// 	BackupVaultResource: &armdataprotection.BackupVaultResource{
	// 		Location: to.Ptr("WestUS"),
	// 		Tags: map[string]*string{
	// 			"key1": to.Ptr("val1"),
	// 		},
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/swaggerExample"),
	// 		Name: to.Ptr("swaggerExample"),
	// 		Type: to.Ptr("Microsoft.DataProtection/BackupVaults"),
	// 		Properties: &armdataprotection.BackupVault{
	// 			ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
	// 			ResourceMoveState: to.Ptr(armdataprotection.ResourceMoveStateUnknown),
	// 			MonitoringSettings: &armdataprotection.MonitoringSettings{
	// 				AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
	// 					AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
	// 				},
	// 			},
	// 			SecuritySettings: &armdataprotection.SecuritySettings{
	// 				SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
	// 					RetentionDurationInDays: to.Ptr[float64](14),
	// 					State: to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
	// 				},
	// 				ImmutabilitySettings: &armdataprotection.ImmutabilitySettings{
	// 					State: to.Ptr(armdataprotection.ImmutabilityStateDisabled),
	// 				},
	// 			},
	// 			StorageSettings: []*armdataprotection.StorageSetting{
	// 				{
	// 					DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
	// 					Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
	// 				},
	// 			},
	// 			FeatureSettings: &armdataprotection.FeatureSettings{
	// 				CrossSubscriptionRestoreSettings: &armdataprotection.CrossSubscriptionRestoreSettings{
	// 					State: to.Ptr(armdataprotection.CrossSubscriptionRestoreStateDisabled),
	// 				},
	// 				CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
	// 					State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
	// 				},
	// 			},
	// 			SecureScore: to.Ptr(armdataprotection.SecureScoreLevelMaximum),
	// 			IsVaultProtectedByResourceGuard: to.Ptr(false),
	// 			ResourceGuardOperationRequests: []*string{
	// 			},
	// 			ReplicatedRegions: []*string{
	// 			},
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to creates or updates a BackupVault resource belonging to a resource group.
 *
 * @summary creates or updates a BackupVault resource belonging to a resource group.
 * x-ms-original-file: 2026-03-01/PutBackupVaultWithUndelete.json
 */
async function restoreASoftDeletedBackupVault() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.backupVaults.createOrUpdate(
    "SampleResourceGroup",
    "swaggerExample",
    {
      location: "WestUS",
      properties: {
        monitoringSettings: { azureMonitorAlertSettings: { alertsForAllJobFailures: "Enabled" } },
        securitySettings: {
          softDeleteSettings: { retentionDurationInDays: 14, state: "Enabled" },
          immutabilitySettings: { state: "Disabled" },
        },
        storageSettings: [{ datastoreType: "VaultStore", type: "LocallyRedundant" }],
        featureSettings: {
          crossSubscriptionRestoreSettings: { state: "Disabled" },
          crossRegionRestoreSettings: { state: "Enabled" },
        },
      },
      tags: { key1: "val1" },
    },
    {
      xMsDeletedVaultId:
        "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DataProtection/locations/WestUS/deletedVaults/swaggerExample",
    },
  );
  console.log(result);
}

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

Resposta de exemplo

Código de status:: 200

{
  "location": "WestUS",
  "tags": {
    "key1": "val1"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.DataProtection/BackupVaults",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceMoveState": "Unknown",
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllJobFailures": "Enabled"
      }
    },
    "securitySettings": {
      "softDeleteSettings": {
        "retentionDurationInDays": 14,
        "state": "Enabled"
      },
      "immutabilitySettings": {
        "state": "Disabled"
      }
    },
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ],
    "featureSettings": {
      "crossSubscriptionRestoreSettings": {
        "state": "Disabled"
      },
      "crossRegionRestoreSettings": {
        "state": "Enabled"
      }
    },
    "secureScore": "Maximum",
    "isVaultProtectedByResourceGuard": false,
    "resourceGuardOperationRequests": [],
    "replicatedRegions": []
  }
}

Código de status:: 201

{
  "location": "WestUS",
  "tags": {
    "key1": "val1"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.DataProtection/BackupVaults",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceMoveState": "Unknown",
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllJobFailures": "Enabled"
      }
    },
    "securitySettings": {
      "softDeleteSettings": {
        "retentionDurationInDays": 14,
        "state": "Enabled"
      },
      "immutabilitySettings": {
        "state": "Disabled"
      }
    },
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ],
    "featureSettings": {
      "crossSubscriptionRestoreSettings": {
        "state": "Disabled"
      },
      "crossRegionRestoreSettings": {
        "state": "Enabled"
      }
    },
    "secureScore": "Maximum",
    "isVaultProtectedByResourceGuard": false,
    "resourceGuardOperationRequests": [],
    "replicatedRegions": []
  }
}

Definições

Nome	Description
AlertsState
AzureMonitorAlertSettings	Configurações para alertas baseados no Azure Monitor
BackupVault	Cofre de backup
BackupVaultResource	Recurso do Cofre de Backup
BCDRSecurityLevel	Nível de segurança do Cofre de Backup
CloudError	Uma resposta de erro do Backup do Azure.
CmkKekIdentity	Os detalhes da identidade gerenciada usada para o CMK
CmkKeyVaultProperties	As propriedades do Key Vault que hospeda o CMK
createdByType	O tipo de identidade que criou o recurso.
CrossRegionRestoreSettings
CrossRegionRestoreState	Estado CrossRegionRestore
CrossSubscriptionRestoreSettings	Configurações de CrossSubscriptionRestore
CrossSubscriptionRestoreState	Estado CrossSubscriptionRestore
DppIdentityDetails	Detalhes da identidade
encryptionSettings	Detalhes da Chave Gerenciada do Cliente do recurso.
EncryptionState	Estado de criptografia do Cofre de Backup.
Error	A resposta de erro de gerenciamento de recursos.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
FeatureSettings	Classe que contém as configurações de recurso do cofre
IdentityType	O tipo de identidade. 'SystemAssigned' e 'UserAssigned' são mutuamente exclusivos. 'SystemAssigned' usará a identidade gerenciada criada implicitamente.
ImmutabilitySettings	Configurações de Imutabilidade no nível do cofre
ImmutabilityState	Estado de imutabilidade
InfrastructureEncryptionState	Habilitando/desabilitando o estado de Criptografia Dupla
MonitoringSettings	Configurações de monitoramento
ProvisioningState	Estado de provisionamento do recurso BackupVault
ResourceMoveDetails	ResourceMoveDetails será retornado em resposta à chamada GetResource do ARM
ResourceMoveState	Estado de movimentação de recursos para o cofre de backup
SecureScoreLevel	Classificação segura do Cofre de Backup
SecuritySettings	Classe que contém configurações de segurança do cofre
SoftDeleteSettings	Configurações relacionadas à exclusão reversível
SoftDeleteState	Estado da exclusão reversível
StorageSetting	Configuração de armazenamento
StorageSettingStoreTypes	Obtém ou define o tipo do armazenamento de dados.
StorageSettingTypes	Obtém ou define o tipo.
systemData	Metadados relativos à criação e última modificação do recurso.
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário

AlertsState

Enumeração

Valor	Description
Enabled
Disabled

AzureMonitorAlertSettings

Objeto

Configurações para alertas baseados no Azure Monitor

Nome	Tipo	Description
alertsForAllJobFailures	AlertsState

BackupVault

Objeto

Cofre de backup

Nome	Tipo	Description
bcdrSecurityLevel	BCDRSecurityLevel	Nível de segurança do Cofre de Backup
featureSettings	FeatureSettings	Configurações de recurso
isVaultProtectedByResourceGuard	boolean	É o cofre protegido pelo resource guard
monitoringSettings	MonitoringSettings	Configurações de monitoramento
provisioningState	ProvisioningState	Estado de provisionamento do recurso BackupVault
replicatedRegions	string[]	Lista de regiões replicadas para o Cofre de Backup
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests no qual a verificação LAC será executada
resourceMoveDetails	ResourceMoveDetails	Detalhes de movimentação de recursos para o cofre de backup
resourceMoveState	ResourceMoveState	Estado de movimentação de recursos para o cofre de backup
secureScore	SecureScoreLevel	Classificação segura do Cofre de Backup
securitySettings	SecuritySettings	Configurações de segurança
storageSettings	StorageSetting[]	Configurações de armazenamento

BackupVaultResource

Objeto

Recurso do Cofre de Backup

Nome	Tipo	Description
eTag	string	ETag opcional.
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	DppIdentityDetails	Detalhes da identidade gerenciada de entrada
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties	BackupVault	Propriedades de BackupVaultResource
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BCDRSecurityLevel

Enumeração

Nível de segurança do Cofre de Backup

Valor	Description
Poor
Fair
Good
Excellent
NotSupported

CloudError

Objeto

Uma resposta de erro do Backup do Azure.

Nome	Tipo	Description
error	Error	A resposta de erro de gerenciamento de recursos.

CmkKekIdentity

Objeto

Os detalhes da identidade gerenciada usada para o CMK

Nome	Tipo	Description
identityId	string	A identidade gerenciada a ser usada que tem permissões de acesso para o Key Vault. Forneça um valor aqui no caso de tipos de identidade: somente "UserAssigned".
identityType	IdentityType	O tipo de identidade. 'SystemAssigned' e 'UserAssigned' são mutuamente exclusivos. 'SystemAssigned' usará a identidade gerenciada criada implicitamente.

CmkKeyVaultProperties

Objeto

As propriedades do Key Vault que hospeda o CMK

Nome	Tipo	Description
keyUri	string	O uri de chave da chave gerenciada pelo cliente

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

CrossRegionRestoreSettings

Objeto

Nome	Tipo	Description
state	CrossRegionRestoreState	Estado CrossRegionRestore

CrossRegionRestoreState

Enumeração

Estado CrossRegionRestore

Valor	Description
Disabled
Enabled

CrossSubscriptionRestoreSettings

Objeto

Configurações de CrossSubscriptionRestore

Nome	Tipo	Description
state	CrossSubscriptionRestoreState	Estado CrossSubscriptionRestore

CrossSubscriptionRestoreState

Enumeração

Estado CrossSubscriptionRestore

Valor	Description
Disabled
PermanentlyDisabled
Enabled

DppIdentityDetails

Objeto

Detalhes da identidade

Nome	Tipo	Description
principalId	string	A ID do objeto da entidade de serviço para a identidade gerenciada que é usada para conceder acesso baseado em função a um recurso do Azure.
tenantId	string	Um GUID (Identificador Global exclusivo) que representa o locatário do Azure AD em que o recurso agora é membro.
type	string	O identityType que pode ser SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' ou None
userAssignedIdentities	<string, UserAssignedIdentity>	Obtém ou define as identidades atribuídas pelo usuário.

encryptionSettings

Objeto

Detalhes da Chave Gerenciada do Cliente do recurso.

Nome	Tipo	Description
infrastructureEncryption	InfrastructureEncryptionState	Habilitando/desabilitando o estado de Criptografia Dupla
kekIdentity	CmkKekIdentity	Os detalhes da identidade gerenciada usada para o CMK
keyVaultProperties	CmkKeyVaultProperties	As propriedades do Key Vault que hospeda o CMK
state	EncryptionState	Estado de criptografia do Cofre de Backup.

EncryptionState

Enumeração

Estado de criptografia do Cofre de Backup.

Valor	Description
Enabled	A criptografia cmk está habilitada no Cofre de Backup
Disabled	A criptografia cmk está desabilitada no Cofre de Backup. O usuário não poderá definir esse estado depois que o Estado de Criptografia estiver "Habilitado".
Inconsistent	A criptografia cmk está em estado inconsistente no Cofre de Backup. Esse estado indica que o usuário precisa repetir a operação de configurações de criptografia imediatamente para corrigir o estado.

Error

Objeto

A resposta de erro de gerenciamento de recursos.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	Error[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

FeatureSettings

Objeto

Classe que contém as configurações de recurso do cofre

Nome	Tipo	Description
crossRegionRestoreSettings	CrossRegionRestoreSettings
crossSubscriptionRestoreSettings	CrossSubscriptionRestoreSettings	Configurações de CrossSubscriptionRestore

IdentityType

Enumeração

O tipo de identidade. 'SystemAssigned' e 'UserAssigned' são mutuamente exclusivos. 'SystemAssigned' usará a identidade gerenciada criada implicitamente.

Valor	Description
SystemAssigned
UserAssigned

ImmutabilitySettings

Objeto

Configurações de Imutabilidade no nível do cofre

Nome	Tipo	Description
state	ImmutabilityState	Estado de imutabilidade

ImmutabilityState

Enumeração

Estado de imutabilidade

Valor	Description
Disabled
Unlocked
Locked

InfrastructureEncryptionState

Enumeração

Habilitando/desabilitando o estado de Criptografia Dupla

Valor	Description
Enabled
Disabled

MonitoringSettings

Objeto

Configurações de monitoramento

Nome	Tipo	Description
azureMonitorAlertSettings	AzureMonitorAlertSettings	Configurações para alertas baseados no Azure Monitor

ProvisioningState

Enumeração

Estado de provisionamento do recurso BackupVault

Valor	Description
Failed
Provisioning
Succeeded
Unknown
Updating

ResourceMoveDetails

Objeto

ResourceMoveDetails será retornado em resposta à chamada GetResource do ARM

Nome	Tipo	Description
completionTimeUtc	string	Tempo de conclusão em UTC da operação mais recente do ResourceMove tentada. Formato ISO 8601.
operationId	string	CorrelationId da última operação ResourceMove tentada
sourceResourcePath	string	Caminho de recurso do ARM do recurso de origem
startTimeUtc	string	Hora de início em UTC da operação mais recente do ResourceMove tentada. Formato ISO 8601.
targetResourcePath	string	Caminho de recurso do ARM do recurso de destino usado na operação ResourceMove mais recente

ResourceMoveState

Enumeração

Estado de movimentação de recursos para o cofre de backup

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

SecureScoreLevel

Enumeração

Classificação segura do Cofre de Backup

Valor	Description
None
Minimum
Adequate
Maximum
NotSupported

SecuritySettings

Objeto

Classe que contém configurações de segurança do cofre

Nome	Tipo	Description
encryptionSettings	encryptionSettings	Detalhes da Chave Gerenciada do Cliente do recurso.
immutabilitySettings	ImmutabilitySettings	Configurações de Imutabilidade no nível do cofre
softDeleteSettings	SoftDeleteSettings	Configurações relacionadas à exclusão reversível

SoftDeleteSettings

Objeto

Configurações relacionadas à exclusão reversível

Nome	Tipo	Description
retentionDurationInDays	number (double)	Duração da retenção de exclusão reversível
state	SoftDeleteState	Estado da exclusão reversível

SoftDeleteState

Enumeração

Estado da exclusão reversível

Valor	Description
Off	A exclusão reversível está desativada para o BackupVault
On	A Exclusão Reversível está habilitada para o BackupVault, mas pode ser desativada
AlwaysOn	A Exclusão Reversível está habilitada permanentemente para o BackupVault e a configuração não pode ser alterada

StorageSetting

Objeto

Configuração de armazenamento

Nome	Tipo	Description
datastoreType	StorageSettingStoreTypes	Obtém ou define o tipo do armazenamento de dados.
type	StorageSettingTypes	Obtém ou define o tipo.

StorageSettingStoreTypes

Enumeração

Obtém ou define o tipo do armazenamento de dados.

Valor	Description
ArchiveStore
OperationalStore
VaultStore

StorageSettingTypes

Enumeração

Obtém ou define o tipo.

Valor	Description
GeoRedundant
LocallyRedundant
ZoneRedundant

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Objeto

Propriedades de identidade atribuídas pelo usuário

Nome	Tipo	Description
clientId	string (uuid)	A ID do cliente da identidade atribuída.
principalId	string (uuid)	A ID da entidade de segurança da identidade atribuída.