Backup Instances - Create Or Update

Service:

Data Protection

API Version:

2023-01-01

Skapa eller uppdatera en säkerhetskopieringsinstans i ett säkerhetskopieringsvalv

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
backupInstanceName	path	True	string	Namnet på säkerhetskopieringsinstansen.
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string uuid	ID för målprenumerationen. Värdet måste vara ett UUID.
vaultName	path	True	string	Namnet på säkerhetskopieringsvalvet.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
properties	BackupInstance	Egenskaper för BackupInstanceResource
tags	object	Proxyresurstaggar.

Svar

Name	Typ	Description
200 OK	BackupInstanceResource	OK
201 Created	BackupInstanceResource	Skapad
202 Accepted		Har godkänts Headers Location: string Azure-AsyncOperation: string
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto.

Exempel

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

Definitioner

Name	Description
AzureOperationalStoreParameters	Parametrar för Operational-Tier DataStore
BackupInstance	Säkerhetskopieringsinstans
BackupInstanceResource	BackupInstanceResource
BlobBackupDatasourceParameters	Parametrar som ska användas vid konfiguration av säkerhetskopiering av blobar
CloudError	CloudError
createdByType	Den typ av identitet som skapade resursen.
CurrentProtectionState	Anger resursens aktuella skyddstillstånd
Datasource	Datakälla
DatasourceSet	DatasourceSet
DataStoreTypes	typ av datalager. Drift/valv/arkiv
Error	Svar på resurshanteringsfel.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
InnerError	InnerError
KubernetesClusterBackupDatasourceParameters	Parametrar för Datasource för säkerhetskopiering av Kubernetes-kluster
PolicyInfo	PolicyInfo
PolicyParameters	Parametrar i princip
ProtectionStatusDetails	ProtectionStatusDetails
SecretStoreBasedAuthCredentials	Autentiseringsuppgifter baserade på hemlig lagring.
SecretStoreResource	Klass som representerar en hemlig butiksresurs.
SecretStoreType	Hämtar eller anger typen av hemligt arkiv
Status	Anger resursens skyddsstatus
systemData	Metadata som rör skapande och senaste ändring av resursen.
UserFacingError	Felobjekt som används av lager som har åtkomst till lokaliserat innehåll och sprida det till användaren
ValidationType	Anger typen av validering. Vid DeepValidation körs alla valideringar från /validateForBackup-API:et igen.

AzureOperationalStoreParameters

Parametrar för Operational-Tier DataStore

Name	Typ	Description
dataStoreType	DataStoreTypes	typ av datalager. Drift/valv/arkiv
objectType	string: AzureOperationalStoreParameters	Typ av specifikt objekt – används för deserialisering
resourceGroupId	string	Hämtar eller anger URI:n för ögonblicksbildresursgruppen.

BackupInstance

Säkerhetskopieringsinstans

Name	Typ	Description
currentProtectionState	CurrentProtectionState	Anger resursens aktuella skyddstillstånd
dataSourceInfo	Datasource	Datakälla Hämtar eller anger datakällans information.
dataSourceSetInfo	DatasourceSet	DatasourceSet Hämtar eller anger datakällans uppsättningsinformation.
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	Autentiseringsuppgifter som ska användas för att autentisera med datakällans provider.
friendlyName	string	Hämtar eller anger det egna namnet på säkerhetskopieringsinstansen.
objectType	string
policyInfo	PolicyInfo	PolicyInfo Hämtar eller anger principinformationen.
protectionErrorDetails	UserFacingError	Anger skyddsfelet för resursen
protectionStatus	ProtectionStatusDetails	ProtectionStatusDetails Anger resursens skyddsstatus
provisioningState	string	Anger etableringstillståndet för resursen, t.ex. etablering/uppdatering/Lyckades/Misslyckades
validationType	ValidationType	Anger typen av validering. Vid DeepValidation körs alla valideringar från /validateForBackup-API:et igen.

BackupInstanceResource

BackupInstanceResource

Name	Typ	Description
id	string	Proxyresurs-ID representerar den fullständiga sökvägen till resursen.
name	string	Proxyresursnamnet som är associerat med resursen.
properties	BackupInstance	Egenskaper för BackupInstanceResource
systemData	systemData	Metadata som rör skapande och senaste ändring av resursen.
tags	object	Proxyresurstaggar.
type	string	Proxyresurstyp representerar den fullständiga sökvägen för formuläret Namnområde/ResourceType/ResourceType/...

BlobBackupDatasourceParameters

Parametrar som ska användas vid konfiguration av säkerhetskopiering av blobar

Name	Typ	Description
containersList	string[]	Lista över containrar som ska säkerhetskopieras under konfigurationen av säkerhetskopiering av blobar
objectType	string: BlobBackupDatasourceParameters	Typ av det specifika objektet – används för avserialisering

CloudError

CloudError

Name	Typ	Description
error	Error	Svar på resurshanteringsfel.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CurrentProtectionState

Anger resursens aktuella skyddstillstånd

Name	Typ	Description
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

Datakälla

Name	Typ	Description
datasourceType	string	DatasourceType för resursen.
objectType	string	Typ av Datasource-objekt som används för att initiera rätt ärvd typ
resourceID	string	Fullständigt ARM-ID för resursen. För Azure-resurser är detta ARM-ID. För icke-Azure-resurser är detta det ID som skapas av säkerhetskopieringstjänsten via Infrastruktur/valv.
resourceLocation	string	Plats för datakällan.
resourceName	string	Unik identifierare för resursen i kontexten för överordnad.
resourceType	string	Resurstyp för datakälla.
resourceUri	string	Resursens URI.

DatasourceSet

DatasourceSet

Name	Typ	Description
datasourceType	string	DatasourceType för resursen.
objectType	string	Typ av Datasource-objekt som används för att initiera rätt ärvd typ
resourceID	string	Fullständigt ARM-ID för resursen. För Azure-resurser är detta ARM-ID. För icke-Azure-resurser är detta det ID som skapas av säkerhetskopieringstjänsten via Infrastruktur/valv.
resourceLocation	string	Plats för datakällan.
resourceName	string	Unik identifierare för resursen i kontexten för överordnad.
resourceType	string	Resurstyp för datakälla.
resourceUri	string	Resursens URI.

DataStoreTypes

typ av datalager. Drift/valv/arkiv

Name	Typ	Description
ArchiveStore	string
OperationalStore	string
VaultStore	string

Error

Svar på resurshanteringsfel.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	Error[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

InnerError

InnerError

Name	Typ	Description
additionalInfo	object	Alla nyckelvärdepar som kan tillhandahållas till klienten för ytterligare utförlig information.
code	string	Unik kod för det här felet
embeddedInnerError	InnerError	InnerError Underordnat inre fel, för att tillåta kapsling.

KubernetesClusterBackupDatasourceParameters

Parametrar för Datasource för säkerhetskopiering av Kubernetes-kluster

Name	Typ	Description
excludedNamespaces	string[]	Hämtar eller anger egenskapen exclude namespaces. Den här egenskapen anger vilka namnområden som ska undantas under återställningen.
excludedResourceTypes	string[]	Hämtar eller anger egenskapen exkludera resurstyper. Den här egenskapen anger vilka resurstyper som ska undantas under återställningen.
includeClusterScopeResources	boolean	Hämtar eller anger egenskapen inkludera klusterresurser. Den här egenskapen om den är aktiverad innehåller resurser för klusteromfång under återställningen.
includedNamespaces	string[]	Hämtar eller anger egenskapen include namespaces. Den här egenskapen anger vilka namnområden som ska inkluderas under återställningen.
includedResourceTypes	string[]	Hämtar eller anger egenskapen inkludera resurstyper. Den här egenskapen anger vilka resurstyper som ska inkluderas under återställningen.
labelSelectors	string[]	Hämtar eller anger egenskapen LabelSelectors. Den här egenskapen anger att resursen med sådana etikettväljare ska inkluderas under återställningen.
objectType	string: KubernetesClusterBackupDatasourceParameters	Typ av det specifika objektet – används för avserialisering
snapshotVolumes	boolean	Hämtar eller anger egenskapen för volymögonblicksbild. Om den här egenskapen är aktiverad tas ögonblicksbilder av volymen under återställningen.

PolicyInfo

PolicyInfo

Name	Typ	Description
policyId	string
policyParameters	PolicyParameters	Principparametrar för säkerhetskopieringsinstansen
policyVersion	string

PolicyParameters

Parametrar i princip

Name	Typ	Description
backupDatasourceParametersList	BackupDatasourceParameters[]: BlobBackupDatasourceParameters[] KubernetesClusterBackupDatasourceParameters[]	Hämtar eller anger parametrarna för säkerhetskopieringsdatakälla
dataStoreParametersList	DataStoreParameters[]: AzureOperationalStoreParameters[]	Hämtar eller anger DataStore-parametrarna

ProtectionStatusDetails

ProtectionStatusDetails

Name	Typ	Description
errorDetails	UserFacingError	Anger skyddsstatusfelet för resursen
status	Status	Anger resursens skyddsstatus

SecretStoreBasedAuthCredentials

Autentiseringsuppgifter baserade på hemlig lagring.

Name	Typ	Description
objectType	string: SecretStoreBasedAuthCredentials	Typ av specifikt objekt – används för deserialisering
secretStoreResource	SecretStoreResource	Hemlig lagringsresurs

SecretStoreResource

Klass som representerar en hemlig butiksresurs.

Name	Typ	Description
secretStoreType	SecretStoreType	Hämtar eller anger typen av hemligt arkiv
uri	string	Uri för att komma till resursen
value	string	Hämtar eller anger värde som lagras i en hemlig lagringsresurs

SecretStoreType

Hämtar eller anger typen av hemligt arkiv

Name	Typ	Description
AzureKeyVault	string
Invalid	string

Status

Anger resursens skyddsstatus

Name	Typ	Description
ConfiguringProtection	string
ConfiguringProtectionFailed	string
ProtectionConfigured	string
ProtectionStopped	string
SoftDeleted	string
SoftDeleting	string

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UserFacingError

Felobjekt som används av lager som har åtkomst till lokaliserat innehåll och sprida det till användaren

Name	Typ	Description
code	string	Unik kod för det här felet
details	UserFacingError[]	Ytterligare relaterade fel
innerError	InnerError	InnerError Inre fel
isRetryable	boolean	Om åtgärden ska kunna försöka igen eller inte
isUserError	boolean	Om åtgärden beror på ett användarfel eller ett tjänstfel
message	string
properties	object	Alla nyckelvärdepar som kan matas in i felobjekt
recommendedAction	string[]	RecommendedAction lokaliserad.
target	string	Målet för felet.

ValidationType

Anger typen av validering. Vid DeepValidation körs alla valideringar från /validateForBackup-API:et igen.

Name	Typ	Description
DeepValidation	string
ShallowValidation	string