Backup Vaults - Create Or Update

Service:

Data Protection

API Version:

2023-01-01

Membuat atau memperbarui sumber daya BackupVault milik grup sumber daya.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
subscriptionId	path	True	string uuid	ID langganan target. Nilai harus UUID.
vaultName	path	True	string	Nama brankas cadangan.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
location	True	string	Lokasi sumber daya.
properties	True	BackupVault	BackupVault Properti BackupVaultResource
eTag		string	ETag Opsional.
identity		DppIdentityDetails	DppIdentityDetails Masukkan Detail Identitas Terkelola
tags		object	Tag sumber daya.

Respons

Nama	Jenis	Deskripsi
200 OK	BackupVaultResource	OK
201 Created	BackupVaultResource	Dibuat
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda.

Contoh

Create BackupVault

Create BackupVault With MSI

Create BackupVault

Sample Request

HTTP

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

{
  "location": "WestUS",
  "tags": {
    "key1": "val1"
  },
  "identity": {
    "type": "None"
  },
  "properties": {
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllJobFailures": "Enabled"
      }
    },
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ]
  }
}

Java

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.DppIdentityDetails;
import com.azure.resourcemanager.dataprotection.models.MonitoringSettings;
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: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/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)))
                    .withStorageSettings(
                        Arrays
                            .asList(
                                new StorageSetting()
                                    .withDatastoreType(StorageSettingStoreTypes.VAULT_STORE)
                                    .withType(StorageSettingTypes.LOCALLY_REDUNDANT))))
            .withTags(mapOf("key1", "val1"))
            .withIdentity(new DppIdentityDetails().withType("None"))
            .create();
    }

    @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

Python

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="0b352192-dcac-4cc7-992e-a96190ccc68c",
    )

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


# x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/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

Go

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/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/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("<subscription-id>", 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"),
		Tags: map[string]*string{
			"key1": to.Ptr("val1"),
		},
		Identity: &armdataprotection.DppIdentityDetails{
			Type: to.Ptr("None"),
		},
		Properties: &armdataprotection.BackupVault{
			MonitoringSettings: &armdataprotection.MonitoringSettings{
				AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
					AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
				},
			},
			StorageSettings: []*armdataprotection.StorageSetting{
				{
					Type:          to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
					DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
				}},
		},
	}, 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.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"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("val1"),
	// 	},
	// 	Identity: &armdataprotection.DppIdentityDetails{
	// 		Type: to.Ptr("None"),
	// 	},
	// 	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 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: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/PutBackupVault.json
 */
async function createBackupVault() {
  const subscriptionId =
    process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "0b352192-dcac-4cc7-992e-a96190ccc68c";
  const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "SampleResourceGroup";
  const vaultName = "swaggerExample";
  const parameters = {
    identity: { type: "None" },
    location: "WestUS",
    properties: {
      monitoringSettings: {
        azureMonitorAlertSettings: { alertsForAllJobFailures: "Enabled" },
      },
      storageSettings: [{ type: "LocallyRedundant", datastoreType: "VaultStore" }],
    },
    tags: { key1: "val1" },
  };
  const credential = new DefaultAzureCredential();
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.backupVaults.beginCreateOrUpdateAndWait(
    resourceGroupName,
    vaultName,
    parameters
  );
  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

Sample Response

Status code:

201

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

Response Body

{
  "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": "Provisioning",
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ]
  }
}

Status code:

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

Create BackupVault With MSI

Sample Request

HTTP

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

{
  "location": "WestUS",
  "tags": {
    "key1": "val1"
  },
  "identity": {
    "type": "systemAssigned"
  },
  "properties": {
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllJobFailures": "Enabled"
      }
    },
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ]
  }
}

Java

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.DppIdentityDetails;
import com.azure.resourcemanager.dataprotection.models.MonitoringSettings;
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: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/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)))
                    .withStorageSettings(
                        Arrays
                            .asList(
                                new StorageSetting()
                                    .withDatastoreType(StorageSettingStoreTypes.VAULT_STORE)
                                    .withType(StorageSettingTypes.LOCALLY_REDUNDANT))))
            .withTags(mapOf("key1", "val1"))
            .withIdentity(new DppIdentityDetails().withType("systemAssigned"))
            .create();
    }

    @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

Python

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="0b352192-dcac-4cc7-992e-a96190ccc68c",
    )

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


# x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/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

Go

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/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/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("<subscription-id>", 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"),
		Tags: map[string]*string{
			"key1": to.Ptr("val1"),
		},
		Identity: &armdataprotection.DppIdentityDetails{
			Type: to.Ptr("systemAssigned"),
		},
		Properties: &armdataprotection.BackupVault{
			MonitoringSettings: &armdataprotection.MonitoringSettings{
				AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
					AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
				},
			},
			StorageSettings: []*armdataprotection.StorageSetting{
				{
					Type:          to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
					DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
				}},
		},
	}, 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.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"),
	// 	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 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: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/PutBackupVaultWithMSI.json
 */
async function createBackupVaultWithMsi() {
  const subscriptionId =
    process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "0b352192-dcac-4cc7-992e-a96190ccc68c";
  const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "SampleResourceGroup";
  const vaultName = "swaggerExample";
  const parameters = {
    identity: { type: "systemAssigned" },
    location: "WestUS",
    properties: {
      monitoringSettings: {
        azureMonitorAlertSettings: { alertsForAllJobFailures: "Enabled" },
      },
      storageSettings: [{ type: "LocallyRedundant", datastoreType: "VaultStore" }],
    },
    tags: { key1: "val1" },
  };
  const credential = new DefaultAzureCredential();
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.backupVaults.beginCreateOrUpdateAndWait(
    resourceGroupName,
    vaultName,
    parameters
  );
  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

Sample Response

Status code:

201

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

Response Body

{
  "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": "Provisioning",
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ]
  }
}

Status code:

200

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

Definisi

Nama	Deskripsi
AlertsState
AzureMonitorAlertSettings	Pengaturan untuk pemberitahuan berbasis Azure Monitor
BackupVault	BackupVault
BackupVaultResource	Sumber Daya BackupVault
CloudError	CloudError
createdByType	Jenis identitas yang membuat sumber daya.
CrossSubscriptionRestoreSettings	Pengaturan CrossSubscriptionRestore
CrossSubscriptionRestoreState	Status CrossSubscriptionRestore
DppIdentityDetails	DppIdentityDetails
Error	Respons kesalahan manajemen sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
FeatureSettings	Kelas yang berisi pengaturan fitur vault
ImmutabilitySettings	Pengaturan Imutabilitas pada tingkat vault
ImmutabilityState	Status imutabilitas
MonitoringSettings	Pengaturan Pemantauan
ProvisioningState	Status penyediaan sumber daya BackupVault
ResourceMoveDetails	ResourceMoveDetails akan dikembalikan sebagai respons terhadap panggilan GetResource dari ARM
ResourceMoveState	Status pemindahan sumber daya untuk brankas cadangan
SecuritySettings	Kelas yang berisi pengaturan keamanan vault
SoftDeleteSettings	Pengaturan terkait penghapusan sementara
SoftDeleteState	Status penghapusan sementara
StorageSetting	StorageSetting
StorageSettingStoreTypes	Mendapatkan atau mengatur jenis datastore.
StorageSettingTypes	Mendapatkan atau mengatur jenis.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

AlertsState

Nama	Jenis	Deskripsi
Disabled	string
Enabled	string

AzureMonitorAlertSettings

Pengaturan untuk pemberitahuan berbasis Azure Monitor

Nama	Jenis	Deskripsi
alertsForAllJobFailures	AlertsState

BackupVault

BackupVault

Nama	Jenis	Deskripsi
featureSettings	FeatureSettings	Pengaturan Fitur
isVaultProtectedByResourceGuard	boolean	Apakah vault dilindungi oleh resource guard
monitoringSettings	MonitoringSettings	Pengaturan Pemantauan
provisioningState	ProvisioningState	Status penyediaan sumber daya BackupVault
resourceMoveDetails	ResourceMoveDetails	Detail pemindahan sumber daya untuk brankas cadangan
resourceMoveState	ResourceMoveState	Status pemindahan sumber daya untuk brankas cadangan
securitySettings	SecuritySettings	Pengaturan Keamanan
storageSettings	StorageSetting[]	Pengaturan Penyimpanan

BackupVaultResource

Sumber Daya BackupVault

Nama	Jenis	Deskripsi
eTag	string	ETag Opsional.
id	string	Id Sumber Daya mewakili jalur lengkap ke sumber daya.
identity	DppIdentityDetails	DppIdentityDetails Masukkan Detail Identitas Terkelola
location	string	Lokasi sumber daya.
name	string	Nama sumber daya yang terkait dengan sumber daya.
properties	BackupVault	BackupVault Properti BackupVaultResource
systemData	systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya mewakili jalur lengkap formulir Namespace/ResourceType/ResourceType/...

CloudError

CloudError

Nama	Jenis	Deskripsi
error	Error	Respons kesalahan manajemen sumber daya.

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

CrossSubscriptionRestoreSettings

Pengaturan CrossSubscriptionRestore

Nama	Jenis	Deskripsi
state	CrossSubscriptionRestoreState	Status CrossSubscriptionRestore

CrossSubscriptionRestoreState

Status CrossSubscriptionRestore

Nama	Jenis	Deskripsi
Disabled	string
Enabled	string
PermanentlyDisabled	string

DppIdentityDetails

DppIdentityDetails

Nama	Jenis	Deskripsi
principalId	string	ID objek objek perwakilan layanan untuk identitas terkelola yang digunakan untuk memberikan akses berbasis peran ke sumber daya Azure.
tenantId	string	Pengidentifikasi Unik Global (GUID) yang mewakili penyewa Azure AD tempat sumber daya sekarang menjadi anggota.
type	string	IdentityType yang dapat berupa SystemAssigned atau None

Error

Respons kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	Error[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

FeatureSettings

Kelas yang berisi pengaturan fitur vault

Nama	Jenis	Deskripsi
crossSubscriptionRestoreSettings	CrossSubscriptionRestoreSettings	Pengaturan CrossSubscriptionRestore

ImmutabilitySettings

Pengaturan Imutabilitas pada tingkat vault

Nama	Jenis	Deskripsi
state	ImmutabilityState	Status imutabilitas

ImmutabilityState

Status imutabilitas

Nama	Jenis	Deskripsi
Disabled	string
Locked	string
Unlocked	string

MonitoringSettings

Pengaturan Pemantauan

Nama	Jenis	Deskripsi
azureMonitorAlertSettings	AzureMonitorAlertSettings	Pengaturan untuk pemberitahuan berbasis Azure Monitor

ProvisioningState

Status penyediaan sumber daya BackupVault

Nama	Jenis	Deskripsi
Failed	string
Provisioning	string
Succeeded	string
Unknown	string
Updating	string

ResourceMoveDetails

ResourceMoveDetails akan dikembalikan sebagai respons terhadap panggilan GetResource dari ARM

Nama	Jenis	Deskripsi
completionTimeUtc	string	Waktu penyelesaian dalam UTC dari operasi ResourceMove terbaru telah dicoba. Format ISO 8601.
operationId	string	CorrelationId dari operasi ResourceMove terbaru yang dicoba
sourceResourcePath	string	Jalur sumber daya ARM sumber daya sumber
startTimeUtc	string	Waktu mulai dalam UTC dari operasi ResourceMove terbaru telah dicoba. Format ISO 8601.
targetResourcePath	string	Jalur sumber daya ARM dari sumber daya target yang digunakan dalam operasi ResourceMove terbaru

ResourceMoveState

Status pemindahan sumber daya untuk brankas cadangan

Nama	Jenis	Deskripsi
CommitFailed	string
CommitTimedout	string
CriticalFailure	string
Failed	string
InProgress	string
MoveSucceeded	string
PartialSuccess	string
PrepareFailed	string
PrepareTimedout	string
Unknown	string

SecuritySettings

Kelas yang berisi pengaturan keamanan vault

Nama	Jenis	Deskripsi
immutabilitySettings	ImmutabilitySettings	Pengaturan Imutabilitas pada tingkat vault
softDeleteSettings	SoftDeleteSettings	Pengaturan terkait penghapusan sementara

SoftDeleteSettings

Pengaturan terkait penghapusan sementara

Nama	Jenis	Deskripsi
retentionDurationInDays	number	Durasi retensi penghapusan sementara
state	SoftDeleteState	Status penghapusan sementara

SoftDeleteState

Status penghapusan sementara

Nama	Jenis	Deskripsi
AlwaysOn	string	Penghapusan Sementara diaktifkan secara permanen untuk BackupVault dan pengaturan tidak dapat diubah
Off	string	Penghapusan Sementara dinonaktifkan untuk BackupVault
On	string	Penghapusan Sementara diaktifkan untuk BackupVault tetapi dapat dinonaktifkan

StorageSetting

StorageSetting

Nama	Jenis	Deskripsi
datastoreType	StorageSettingStoreTypes	Mendapatkan atau mengatur jenis datastore.
type	StorageSettingTypes	Mendapatkan atau mengatur jenis.

StorageSettingStoreTypes

Mendapatkan atau mengatur jenis datastore.

Nama	Jenis	Deskripsi
ArchiveStore	string
OperationalStore	string
VaultStore	string

StorageSettingTypes

Mendapatkan atau mengatur jenis.

Nama	Jenis	Deskripsi
GeoRedundant	string
LocallyRedundant	string
ZoneRedundant	string

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.