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	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
vaultName	path	True	string	バックアップ コンテナーの名前。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties	BackupInstance	BackupInstanceResource プロパティ
tags	object	プロキシ リソース タグ。

応答

名前	型	説明
200 OK	BackupInstanceResource	OK
201 Created	BackupInstanceResource	作成済み
202 Accepted		同意 Headers Location: string Azure-AsyncOperation: string
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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 データストアのパラメーター
BackupInstance	バックアップ インスタンス
BackupInstanceResource	BackupInstanceResource
BlobBackupDatasourceParameters	BLOB のバックアップの構成中に使用するパラメーター
CloudError	CloudError
createdByType	リソースを作成した ID の種類。
CurrentProtectionState	リソースの現在の保護状態を指定します
Datasource	データソース
DatasourceSet	DatasourceSet
DataStoreTypes	データストアの種類。Operational/Vault/Archive
Error	リソース管理エラー応答。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
InnerError	InnerError
KubernetesClusterBackupDatasourceParameters	Kubernetes クラスター バックアップ データソースのパラメーター
PolicyInfo	PolicyInfo
PolicyParameters	ポリシーのパラメーター
ProtectionStatusDetails	保護の状態の詳細
SecretStoreBasedAuthCredentials	シークレット ストア ベースの認証資格情報。
SecretStoreResource	シークレット ストア リソースを表すクラス。
SecretStoreType	シークレット ストアの種類を取得または設定します
Status	リソースの保護状態を指定します
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserFacingError	ローカライズされたコンテンツにアクセスし、ユーザーに伝達するレイヤーで使用されるエラー オブジェクト
ValidationType	検証の種類を指定します。 DeepValidation の場合、/validateForBackup API のすべての検証が再度実行されます。

AzureOperationalStoreParameters

Operational-Tier データストアのパラメーター

名前	型	説明
dataStoreType	DataStoreTypes	データストアの種類。Operational/Vault/Archive
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 の場合、/validateForBackup API のすべての検証が再度実行されます。

BackupInstanceResource

BackupInstanceResource

名前	型	説明
id	string	プロキシ リソース ID は、リソースへの完全なパスを表します。
name	string	リソースに関連付けられているプロキシ リソース名。
properties	BackupInstance	BackupInstanceResource プロパティ
systemData	systemData	リソースの作成と最後の変更に関連するメタデータ。
tags	object	プロキシ リソース タグ。
type	string	プロキシ リソースの種類は、Namespace/ResourceType/ResourceType/..フォームの完全なパスを表します。

BlobBackupDatasourceParameters

BLOB のバックアップの構成中に使用するパラメーター

名前	型	説明
containersList	string[]	BLOB のバックアップの構成中にバックアップするコンテナーの一覧
objectType	string: BlobBackupDatasourceParameters	特定のオブジェクトの型 - 逆シリアル化に使用されます

CloudError

CloudError

名前	型	説明
error	Error	リソース管理エラー応答。

createdByType

リソースを作成した ID の種類。

名前	型	説明
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 ID。 Azure リソースの場合、これは ARM ID です。 Azure 以外のリソースの場合、これは Fabric/Vault を介してバックアップ サービスによって作成された ID になります。
resourceLocation	string	データソースの場所。
resourceName	string	親のコンテキスト内のリソースの一意識別子。
resourceType	string	データソースのリソースの種類。
resourceUri	string	リソースの URI。

DatasourceSet

DatasourceSet

名前	型	説明
datasourceType	string	リソースの DatasourceType。
objectType	string	右の継承された型を初期化するために使用される Datasource オブジェクトの型
resourceID	string	リソースの完全な ARM ID。 Azure リソースの場合、これは ARM ID です。 Azure 以外のリソースの場合、これは Fabric/Vault を介してバックアップ サービスによって作成された ID になります。
resourceLocation	string	データソースの場所。
resourceName	string	親のコンテキスト内のリソースの一意識別子。
resourceType	string	データソースのリソースの種類。
resourceUri	string	リソースの URI。

DataStoreTypes

データストアの種類。Operational/Vault/Archive

名前	型	説明
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[]	名前空間の除外プロパティを取得または設定します。 このプロパティは、復元時に除外する名前空間を設定します。
excludedResourceTypes	string[]	リソースの種類を除外するプロパティを取得または設定します。 このプロパティは、復元中に除外するリソースの種類を設定します。
includeClusterScopeResources	boolean	インクルード クラスター リソース プロパティを取得または設定します。 このプロパティを有効にすると、復元中にクラスター スコープ リソースが含まれます。
includedNamespaces	string[]	include namespaces プロパティを取得または設定します。 このプロパティは、復元時に含める名前空間を設定します。
includedResourceTypes	string[]	インクルード リソースの種類プロパティを取得または設定します。 このプロパティは、復元時に含めるリソースの種類を設定します。
labelSelectors	string[]	LabelSelectors プロパティを取得または設定します。 このプロパティは、復元時に含めるラベル セレクターを含むリソースを設定します。
objectType	string: KubernetesClusterBackupDatasourceParameters	特定のオブジェクトの型 - 逆シリアル化に使用されます
snapshotVolumes	boolean	ボリューム スナップショット プロパティを取得または設定します。 このプロパティを有効にすると、復元中にボリューム スナップショットが取得されます。

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	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UserFacingError

ローカライズされたコンテンツにアクセスし、ユーザーに伝達するレイヤーで使用されるエラー オブジェクト

名前	型	説明
code	string	このエラーの一意のコード
details	UserFacingError[]	その他の関連エラー
innerError	InnerError	InnerError 内部エラー
isRetryable	boolean	操作が再試行可能かどうか
isUserError	boolean	操作がユーザー エラーまたはサービス エラーによるものかどうか
message	string
properties	object	エラー オブジェクト内に挿入できるキー値のペア
recommendedAction	string[]	RecommendedAction がローカライズされました。
target	string	エラーのターゲット。

ValidationType

検証の種類を指定します。 DeepValidation の場合、/validateForBackup API のすべての検証が再度実行されます。

名前	型	説明
DeepValidation	string
ShallowValidation	string