Backup Instances - Create Or Update

Service:

Data Protection

API Version:

2023-01-01

Создание или обновление экземпляра резервной копии в хранилище резервных копий

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
backupInstanceName	path	True	string	Имя экземпляра резервной копии.
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId	path	True	string uuid	Идентификатор целевой подписки. Значение должно быть UUID.
vaultName	path	True	string	Имя хранилища резервных копий.
api-version	query	True	string	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
properties	BackupInstance	Свойства BackupInstanceResource
tags	object	Теги ресурсов прокси-сервера.

Ответы

Имя	Тип	Описание
200 OK	BackupInstanceResource	ОК
201 Created	BackupInstanceResource	Создание
202 Accepted		Принято Headers Location: string Azure-AsyncOperation: string
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя.

Примеры

Create BackupInstance

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1?api-version=2023-01-01

{
  "tags": {
    "key1": "val1"
  },
  "properties": {
    "objectType": "BackupInstance",
    "friendlyName": "harshitbi2",
    "dataSourceSetInfo": {
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
      "resourceName": "viveksipgtest",
      "resourceType": "Microsoft.DBforPostgreSQL/servers",
      "resourceUri": "",
      "resourceLocation": "",
      "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
    },
    "dataSourceInfo": {
      "objectType": "Datasource",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
      "resourceName": "testdb",
      "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
      "resourceUri": "",
      "resourceLocation": "",
      "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
    },
    "datasourceAuthCredentials": {
      "secretStoreResource": {
        "uri": "https://samplevault.vault.azure.net/secrets/credentials",
        "secretStoreType": "AzureKeyVault"
      },
      "objectType": "SecretStoreBasedAuthCredentials"
    },
    "policyInfo": {
      "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
      "policyParameters": {
        "dataStoreParametersList": [
          {
            "objectType": "AzureOperationalStoreParameters",
            "dataStoreType": "OperationalStore",
            "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"
          }
        ]
      }
    },
    "validationType": "ShallowValidation"
  }
}

Java

import com.azure.resourcemanager.dataprotection.models.AzureOperationalStoreParameters;
import com.azure.resourcemanager.dataprotection.models.BackupInstance;
import com.azure.resourcemanager.dataprotection.models.DataStoreTypes;
import com.azure.resourcemanager.dataprotection.models.Datasource;
import com.azure.resourcemanager.dataprotection.models.DatasourceSet;
import com.azure.resourcemanager.dataprotection.models.PolicyInfo;
import com.azure.resourcemanager.dataprotection.models.PolicyParameters;
import com.azure.resourcemanager.dataprotection.models.SecretStoreBasedAuthCredentials;
import com.azure.resourcemanager.dataprotection.models.SecretStoreResource;
import com.azure.resourcemanager.dataprotection.models.SecretStoreType;
import com.azure.resourcemanager.dataprotection.models.ValidationType;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/** Samples for BackupInstances CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/PutBackupInstance.json
     */
    /**
     * Sample code: Create BackupInstance.
     *
     * @param manager Entry point to DataProtectionManager.
     */
    public static void createBackupInstance(com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager
            .backupInstances()
            .define("testInstance1")
            .withExistingBackupVault("000pikumar", "PratikPrivatePreviewVault1")
            .withTags(mapOf("key1", "val1"))
            .withProperties(
                new BackupInstance()
                    .withFriendlyName("harshitbi2")
                    .withDataSourceInfo(
                        new Datasource()
                            .withDatasourceType("Microsoft.DBforPostgreSQL/servers/databases")
                            .withObjectType("Datasource")
                            .withResourceId(
                                "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb")
                            .withResourceLocation("")
                            .withResourceName("testdb")
                            .withResourceType("Microsoft.DBforPostgreSQL/servers/databases")
                            .withResourceUri(""))
                    .withDataSourceSetInfo(
                        new DatasourceSet()
                            .withDatasourceType("Microsoft.DBforPostgreSQL/servers/databases")
                            .withObjectType("DatasourceSet")
                            .withResourceId(
                                "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest")
                            .withResourceLocation("")
                            .withResourceName("viveksipgtest")
                            .withResourceType("Microsoft.DBforPostgreSQL/servers")
                            .withResourceUri(""))
                    .withPolicyInfo(
                        new PolicyInfo()
                            .withPolicyId(
                                "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1")
                            .withPolicyParameters(
                                new PolicyParameters()
                                    .withDataStoreParametersList(
                                        Arrays
                                            .asList(
                                                new AzureOperationalStoreParameters()
                                                    .withDataStoreType(DataStoreTypes.OPERATIONAL_STORE)
                                                    .withResourceGroupId(
                                                        "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest")))))
                    .withDatasourceAuthCredentials(
                        new SecretStoreBasedAuthCredentials()
                            .withSecretStoreResource(
                                new SecretStoreResource()
                                    .withUri("https://samplevault.vault.azure.net/secrets/credentials")
                                    .withSecretStoreType(SecretStoreType.AZURE_KEY_VAULT)))
                    .withValidationType(ValidationType.SHALLOW_VALIDATION)
                    .withObjectType("BackupInstance"))
            .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_instance.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="04cf684a-d41f-4550-9f70-7708a3a2283b",
    )

    response = client.backup_instances.begin_create_or_update(
        resource_group_name="000pikumar",
        vault_name="PratikPrivatePreviewVault1",
        backup_instance_name="testInstance1",
        parameters={
            "properties": {
                "dataSourceInfo": {
                    "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
                    "objectType": "Datasource",
                    "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
                    "resourceLocation": "",
                    "resourceName": "testdb",
                    "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
                    "resourceUri": "",
                },
                "dataSourceSetInfo": {
                    "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
                    "objectType": "DatasourceSet",
                    "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
                    "resourceLocation": "",
                    "resourceName": "viveksipgtest",
                    "resourceType": "Microsoft.DBforPostgreSQL/servers",
                    "resourceUri": "",
                },
                "datasourceAuthCredentials": {
                    "objectType": "SecretStoreBasedAuthCredentials",
                    "secretStoreResource": {
                        "secretStoreType": "AzureKeyVault",
                        "uri": "https://samplevault.vault.azure.net/secrets/credentials",
                    },
                },
                "friendlyName": "harshitbi2",
                "objectType": "BackupInstance",
                "policyInfo": {
                    "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
                    "policyParameters": {
                        "dataStoreParametersList": [
                            {
                                "dataStoreType": "OperationalStore",
                                "objectType": "AzureOperationalStoreParameters",
                                "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest",
                            }
                        ]
                    },
                },
                "validationType": "ShallowValidation",
            },
            "tags": {"key1": "val1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/PutBackupInstance.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/BackupInstanceOperations/PutBackupInstance.json
func ExampleBackupInstancesClient_BeginCreateOrUpdate() {
	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.NewBackupInstancesClient().BeginCreateOrUpdate(ctx, "000pikumar", "PratikPrivatePreviewVault1", "testInstance1", armdataprotection.BackupInstanceResource{
		Tags: map[string]*string{
			"key1": to.Ptr("val1"),
		},
		Properties: &armdataprotection.BackupInstance{
			DataSourceInfo: &armdataprotection.Datasource{
				DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ObjectType:       to.Ptr("Datasource"),
				ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
				ResourceLocation: to.Ptr(""),
				ResourceName:     to.Ptr("testdb"),
				ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ResourceURI:      to.Ptr(""),
			},
			DataSourceSetInfo: &armdataprotection.DatasourceSet{
				DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ObjectType:       to.Ptr("DatasourceSet"),
				ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
				ResourceLocation: to.Ptr(""),
				ResourceName:     to.Ptr("viveksipgtest"),
				ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers"),
				ResourceURI:      to.Ptr(""),
			},
			DatasourceAuthCredentials: &armdataprotection.SecretStoreBasedAuthCredentials{
				ObjectType: to.Ptr("SecretStoreBasedAuthCredentials"),
				SecretStoreResource: &armdataprotection.SecretStoreResource{
					SecretStoreType: to.Ptr(armdataprotection.SecretStoreTypeAzureKeyVault),
					URI:             to.Ptr("https://samplevault.vault.azure.net/secrets/credentials"),
				},
			},
			FriendlyName: to.Ptr("harshitbi2"),
			ObjectType:   to.Ptr("BackupInstance"),
			PolicyInfo: &armdataprotection.PolicyInfo{
				PolicyID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"),
				PolicyParameters: &armdataprotection.PolicyParameters{
					DataStoreParametersList: []armdataprotection.DataStoreParametersClassification{
						&armdataprotection.AzureOperationalStoreParameters{
							DataStoreType:   to.Ptr(armdataprotection.DataStoreTypesOperationalStore),
							ObjectType:      to.Ptr("AzureOperationalStoreParameters"),
							ResourceGroupID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"),
						}},
				},
			},
			ValidationType: to.Ptr(armdataprotection.ValidationTypeShallowValidation),
		},
	}, 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.BackupInstanceResource = armdataprotection.BackupInstanceResource{
	// 	Name: to.Ptr("harshitbi2"),
	// 	Type: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances"),
	// 	ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("val1"),
	// 	},
	// 	Properties: &armdataprotection.BackupInstance{
	// 		DataSourceInfo: &armdataprotection.Datasource{
	// 			DatasourceType: to.Ptr("OssDB"),
	// 			ObjectType: to.Ptr("Datasource"),
	// 			ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
	// 			ResourceLocation: to.Ptr(""),
	// 			ResourceName: to.Ptr("testdb"),
	// 			ResourceType: to.Ptr("OssDB"),
	// 			ResourceURI: to.Ptr(""),
	// 		},
	// 		DataSourceSetInfo: &armdataprotection.DatasourceSet{
	// 			DatasourceType: to.Ptr("OssDB"),
	// 			ObjectType: to.Ptr("DatasourceSet"),
	// 			ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
	// 			ResourceLocation: to.Ptr(""),
	// 			ResourceName: to.Ptr("viveksipgtest"),
	// 			ResourceType: to.Ptr("OssDB"),
	// 			ResourceURI: to.Ptr(""),
	// 		},
	// 		FriendlyName: to.Ptr("harshitbi2"),
	// 		ObjectType: to.Ptr("BackupInstance"),
	// 		PolicyInfo: &armdataprotection.PolicyInfo{
	// 			PolicyID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"),
	// 			PolicyParameters: &armdataprotection.PolicyParameters{
	// 				DataStoreParametersList: []armdataprotection.DataStoreParametersClassification{
	// 					&armdataprotection.AzureOperationalStoreParameters{
	// 						DataStoreType: to.Ptr(armdataprotection.DataStoreTypesOperationalStore),
	// 						ObjectType: to.Ptr("AzureOperationalStoreParameters"),
	// 						ResourceGroupID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"),
	// 				}},
	// 			},
	// 			PolicyVersion: to.Ptr("3.2"),
	// 		},
	// 		ProtectionStatus: &armdataprotection.ProtectionStatusDetails{
	// 			Status: to.Ptr(armdataprotection.Status("NotProtected")),
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// }
}

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 Create or update a backup instance in a backup vault
 *
 * @summary Create or update a backup instance in a backup vault
 * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/PutBackupInstance.json
 */
async function createBackupInstance() {
  const subscriptionId =
    process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "04cf684a-d41f-4550-9f70-7708a3a2283b";
  const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "000pikumar";
  const vaultName = "PratikPrivatePreviewVault1";
  const backupInstanceName = "testInstance1";
  const parameters = {
    properties: {
      dataSourceInfo: {
        datasourceType: "Microsoft.DBforPostgreSQL/servers/databases",
        objectType: "Datasource",
        resourceID:
          "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
        resourceLocation: "",
        resourceName: "testdb",
        resourceType: "Microsoft.DBforPostgreSQL/servers/databases",
        resourceUri: "",
      },
      dataSourceSetInfo: {
        datasourceType: "Microsoft.DBforPostgreSQL/servers/databases",
        objectType: "DatasourceSet",
        resourceID:
          "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
        resourceLocation: "",
        resourceName: "viveksipgtest",
        resourceType: "Microsoft.DBforPostgreSQL/servers",
        resourceUri: "",
      },
      datasourceAuthCredentials: {
        objectType: "SecretStoreBasedAuthCredentials",
        secretStoreResource: {
          secretStoreType: "AzureKeyVault",
          uri: "https://samplevault.vault.azure.net/secrets/credentials",
        },
      },
      friendlyName: "harshitbi2",
      objectType: "BackupInstance",
      policyInfo: {
        policyId:
          "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
        policyParameters: {
          dataStoreParametersList: [
            {
              dataStoreType: "OperationalStore",
              objectType: "AzureOperationalStoreParameters",
              resourceGroupId:
                "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest",
            },
          ],
        },
      },
      validationType: "ShallowValidation",
    },
    tags: { key1: "val1" },
  };
  const credential = new DefaultAzureCredential();
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.backupInstances.beginCreateOrUpdateAndWait(
    resourceGroupName,
    vaultName,
    backupInstanceName,
    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

Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01
Retry-After: 60

Response Body

{
  "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
  "name": "harshitbi2",
  "type": "Microsoft.DataProtection/backupVaults/backupInstances",
  "tags": {
    "key1": "val1"
  },
  "properties": {
    "friendlyName": "harshitbi2",
    "dataSourceInfo": {
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
      "resourceUri": "",
      "datasourceType": "OssDB",
      "resourceName": "testdb",
      "resourceType": "OssDB",
      "resourceLocation": "",
      "objectType": "Datasource"
    },
    "dataSourceSetInfo": {
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
      "resourceUri": "",
      "datasourceType": "OssDB",
      "resourceName": "viveksipgtest",
      "resourceType": "OssDB",
      "resourceLocation": "",
      "objectType": "DatasourceSet"
    },
    "policyInfo": {
      "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
      "policyVersion": "3.2",
      "policyParameters": {
        "dataStoreParametersList": [
          {
            "objectType": "AzureOperationalStoreParameters",
            "dataStoreType": "OperationalStore",
            "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"
          }
        ]
      }
    },
    "protectionStatus": {
      "status": "NotProtected"
    },
    "provisioningState": "Provisioning",
    "objectType": "BackupInstance"
  }
}

Status code:

202

Azure-AsyncOperation: https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01
Location: https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01
Retry-After: 60

Status code:

200

{
  "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
  "name": "harshitbi2",
  "type": "Microsoft.DataProtection/backupVaults/backupInstances",
  "tags": {
    "key1": "val1"
  },
  "properties": {
    "friendlyName": "harshitbi2",
    "dataSourceInfo": {
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
      "resourceUri": "",
      "datasourceType": "OssDB",
      "resourceName": "testdb",
      "resourceType": "OssDB",
      "resourceLocation": "",
      "objectType": "Datasource"
    },
    "dataSourceSetInfo": {
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
      "resourceUri": "",
      "datasourceType": "OssDB",
      "resourceName": "viveksipgtest",
      "resourceType": "OssDB",
      "resourceLocation": "",
      "objectType": "DatasourceSet"
    },
    "policyInfo": {
      "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
      "policyVersion": "3.2",
      "policyParameters": {
        "dataStoreParametersList": [
          {
            "objectType": "AzureOperationalStoreParameters",
            "dataStoreType": "OperationalStore",
            "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"
          }
        ]
      }
    },
    "protectionStatus": {
      "status": "NotProtected"
    },
    "provisioningState": "Provisioned",
    "objectType": "BackupInstance"
  }
}

Определения

Имя	Описание
AzureOperationalStoreParameters	Параметры для Operational-Tier DataStore
BackupInstance	Экземпляр резервного копирования
BackupInstanceResource	BackupInstanceResource
BlobBackupDatasourceParameters	Параметры, используемые во время настройки резервного копирования BLOB-объектов
CloudError	CloudError
createdByType	Тип удостоверения, создавшего ресурс.
CurrentProtectionState	Указывает текущее состояние защиты ресурса.
Datasource	Источник данных
DatasourceSet	DatasourceSet
DataStoreTypes	тип хранилища данных; Рабочая/Хранилище/Архивная
Error	Ответ на ошибку управления ресурсами.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
InnerError	InnerError
KubernetesClusterBackupDatasourceParameters	Параметры для источника данных резервного копирования кластера Kubernetes
PolicyInfo	PolicyInfo
PolicyParameters	Параметры в политике
ProtectionStatusDetails	Сведения о состоянии защиты
SecretStoreBasedAuthCredentials	Учетные данные проверки подлинности на основе хранилища секретов.
SecretStoreResource	Класс, представляющий ресурс хранилища секретов.
SecretStoreType	Возвращает или задает тип хранилища секретов.
Status	Указывает состояние защиты ресурса.
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
UserFacingError	Объект ошибки, используемый слоями, имеющими доступ к локализованным содержимому и распространяющими его пользователю
ValidationType	Указывает тип проверки. В случае DeepValidation все проверки из API /validateForBackup будут выполняться снова.

AzureOperationalStoreParameters

Параметры для Operational-Tier DataStore

Имя	Тип	Описание
dataStoreType	DataStoreTypes	тип хранилища данных; Рабочая/Хранилище/Архивная
objectType	string: AzureOperationalStoreParameters	Тип конкретного объекта — используется для десериализации
resourceGroupId	string	Возвращает или задает URI группы ресурсов моментального снимка.

BackupInstance

Экземпляр резервного копирования

Имя	Тип	Описание
currentProtectionState	CurrentProtectionState	Указывает текущее состояние защиты ресурса.
dataSourceInfo	Datasource	Источник данных Возвращает или задает сведения об источнике данных.
dataSourceSetInfo	DatasourceSet	DatasourceSet Возвращает или задает сведения о наборе источников данных.
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	Учетные данные, используемые для проверки подлинности в поставщике источника данных.
friendlyName	string	Возвращает или задает понятное имя экземпляра резервной копии.
objectType	string
policyInfo	PolicyInfo	PolicyInfo Возвращает или задает сведения о политике.
protectionErrorDetails	UserFacingError	Указывает ошибку защиты ресурса.
protectionStatus	ProtectionStatusDetails	Сведения о состоянии защиты Указывает состояние защиты ресурса.
provisioningState	string	Указывает состояние подготовки ресурса, т. е. подготовку, обновление, успешное выполнение или сбой.
validationType	ValidationType	Указывает тип проверки. В случае DeepValidation все проверки из API /validateForBackup будут выполняться снова.

BackupInstanceResource

BackupInstanceResource

Имя	Тип	Описание
id	string	Идентификатор ресурса прокси-сервера представляет полный путь к ресурсу.
name	string	Имя ресурса прокси-сервера, связанное с ресурсом.
properties	BackupInstance	Свойства BackupInstanceResource
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
tags	object	Теги прокси-ресурса.
type	string	Тип прокси-ресурса представляет полный путь к пространству имен/ResourceType/ResourceType/...

BlobBackupDatasourceParameters

Параметры, используемые во время настройки резервного копирования BLOB-объектов

Имя	Тип	Описание
containersList	string[]	Список контейнеров для резервного копирования во время настройки резервного копирования BLOB-объектов
objectType	string: BlobBackupDatasourceParameters	Тип конкретного объекта , используемый для десериализации

CloudError

CloudError

Имя	Тип	Описание
error	Error	Ответ на ошибку управления ресурсами.

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

CurrentProtectionState

Указывает текущее состояние защиты ресурса.

Имя	Тип	Описание
BackupSchedulesSuspended	string
ConfiguringProtection	string
ConfiguringProtectionFailed	string
Invalid	string
NotProtected	string
ProtectionConfigured	string
ProtectionError	string
ProtectionStopped	string
RetentionSchedulesSuspended	string
SoftDeleted	string
SoftDeleting	string
UpdatingProtection	string

Datasource

Источник данных

Имя	Тип	Описание
datasourceType	string	DatasourceType ресурса.
objectType	string	Тип объекта Datasource, используемый для инициализации правого наследуемого типа
resourceID	string	Полный идентификатор ARM ресурса. Для ресурсов Azure это идентификатор ARM. Для ресурсов, отличных от Azure, это будет идентификатор, созданный службой резервного копирования через Fabric/Vault.
resourceLocation	string	Расположение источника данных.
resourceName	string	Уникальный идентификатор ресурса в контексте родительского элемента.
resourceType	string	Тип ресурса источника данных.
resourceUri	string	URI ресурса.

DatasourceSet

DatasourceSet

Имя	Тип	Описание
datasourceType	string	DatasourceType ресурса.
objectType	string	Тип объекта Datasource, используемый для инициализации правого наследуемого типа
resourceID	string	Полный идентификатор ARM ресурса. Для ресурсов Azure это идентификатор ARM. Для ресурсов, отличных от Azure, это будет идентификатор, созданный службой резервного копирования через Fabric/Vault.
resourceLocation	string	Расположение источника данных.
resourceName	string	Уникальный идентификатор ресурса в контексте родительского элемента.
resourceType	string	Тип ресурса источника данных.
resourceUri	string	URI ресурса.

DataStoreTypes

тип хранилища данных; Рабочая/Хранилище/Архивная

Имя	Тип	Описание
ArchiveStore	string
OperationalStore	string
VaultStore	string

Error

Ответ на ошибку управления ресурсами.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	Error[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

InnerError

InnerError

Имя	Тип	Описание
additionalInfo	object	Любые пары "Ключ-значение", которые могут быть предоставлены клиенту для получения дополнительных подробных сведений.
code	string	Уникальный код для этой ошибки
embeddedInnerError	InnerError	InnerError Внутренняя ошибка дочернего элемента, чтобы разрешить вложение.

KubernetesClusterBackupDatasourceParameters

Параметры для источника данных резервного копирования кластера Kubernetes

Имя	Тип	Описание
excludedNamespaces	string[]	Возвращает или задает свойство exclude namespaces. Это свойство задает пространства имен, которые должны быть исключены во время восстановления.
excludedResourceTypes	string[]	Возвращает или задает свойство exclude resource types. Это свойство задает типы ресурсов, которые будут исключены во время восстановления.
includeClusterScopeResources	boolean	Возвращает или задает свойство включить ресурсы кластера. Это свойство, если оно включено, будет включать ресурсы кластера область во время восстановления.
includedNamespaces	string[]	Возвращает или задает свойство include namespaces. Это свойство задает пространства имен, которые будут включены во время восстановления.
includedResourceTypes	string[]	Возвращает или задает свойство include resource types. Это свойство задает типы ресурсов, которые будут включены во время восстановления.
labelSelectors	string[]	Возвращает или задает свойство LabelSelectors. Это свойство задает ресурс с такими селекторами меток, которые будут включены во время восстановления.
objectType	string: KubernetesClusterBackupDatasourceParameters	Тип конкретного объекта , используемый для десериализации
snapshotVolumes	boolean	Возвращает или задает свойство тома snapshot. Это свойство, если оно включено, будет создавать моментальные снимки тома во время восстановления.

PolicyInfo

PolicyInfo

Имя	Тип	Описание
policyId	string
policyParameters	PolicyParameters	Параметры политики для экземпляра резервной копии
policyVersion	string

PolicyParameters

Параметры в политике

Имя	Тип	Описание
backupDatasourceParametersList	BackupDatasourceParameters[]: BlobBackupDatasourceParameters[] KubernetesClusterBackupDatasourceParameters[]	Возвращает или задает параметры источника данных резервной копии.
dataStoreParametersList	DataStoreParameters[]: AzureOperationalStoreParameters[]	Возвращает или задает параметры хранилища данных.

ProtectionStatusDetails

Сведения о состоянии защиты

Имя	Тип	Описание
errorDetails	UserFacingError	Указывает ошибку состояния защиты ресурса.
status	Status	Указывает состояние защиты ресурса.

SecretStoreBasedAuthCredentials

Учетные данные проверки подлинности на основе хранилища секретов.

Имя	Тип	Описание
objectType	string: SecretStoreBasedAuthCredentials	Тип конкретного объекта — используется для десериализации
secretStoreResource	SecretStoreResource	Ресурс хранилища секретов

SecretStoreResource

Класс, представляющий ресурс хранилища секретов.

Имя	Тип	Описание
secretStoreType	SecretStoreType	Возвращает или задает тип хранилища секретов.
uri	string	Универсальный код ресурса (URI) для получения ресурса
value	string	Возвращает или задает значение, хранящееся в ресурсе хранилища секретов.

SecretStoreType

Возвращает или задает тип хранилища секретов.

Имя	Тип	Описание
AzureKeyVault	string
Invalid	string

Status

Указывает состояние защиты ресурса.

Имя	Тип	Описание
ConfiguringProtection	string
ConfiguringProtectionFailed	string
ProtectionConfigured	string
ProtectionStopped	string
SoftDeleted	string
SoftDeleting	string

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое в последний раз изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, изменяющего ресурс в последний раз.

UserFacingError

Объект ошибки, используемый слоями, имеющими доступ к локализованным содержимому и распространяющими его пользователю

Имя	Тип	Описание
code	string	Уникальный код для этой ошибки
details	UserFacingError[]	Дополнительные связанные ошибки
innerError	InnerError	InnerError Внутренняя ошибка
isRetryable	boolean	Будет ли операция повторяться
isUserError	boolean	Указывает, вызвана ли операция ошибкой пользователя или службой
message	string
properties	object	Любые пары "ключ-значение", которые могут быть внедрены в объект ошибки
recommendedAction	string[]	Рекомендуемое действие локализовано.
target	string	Целевой объект ошибки.

ValidationType

Указывает тип проверки. В случае DeepValidation все проверки из API /validateForBackup будут выполняться снова.

Имя	Тип	Описание
DeepValidation	string
ShallowValidation	string