Backup Instances - Create Or Update

Service:

Data Protection

API Version:

2023-01-01

Criar ou atualizar uma instância de cópia de segurança num cofre de cópias de segurança

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
backupInstanceName	path	True	string	O nome da instância de cópia de segurança.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string uuid	O ID da subscrição de destino. O valor tem de ser um UUID.
vaultName	path	True	string	O nome do cofre de cópias de segurança.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
properties	BackupInstance	Propriedades backupInstanceResource
tags	object	Etiquetas de Recursos de Proxy.

Respostas

Name	Tipo	Description
200 OK	BackupInstanceResource	OK
201 Created	BackupInstanceResource	Criado
202 Accepted		Aceite Headers Location: string Azure-AsyncOperation: string
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador.

Exemplos

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

Definições

Name	Description
AzureOperationalStoreParameters	Parâmetros para Operational-Tier DataStore
BackupInstance	Instância de Cópia de Segurança
BackupInstanceResource	BackupInstanceResource
BlobBackupDatasourceParameters	Parâmetros a utilizar durante a configuração da cópia de segurança de blobs
CloudError	CloudError
createdByType	O tipo de identidade que criou o recurso.
CurrentProtectionState	Especifica o estado de proteção atual do recurso
Datasource	Origem de dados
DatasourceSet	Conjunto de Origens de Dados
DataStoreTypes	tipo de arquivo de dados; Operacional/Cofre/Arquivo
Error	A resposta ao erro de gestão de recursos.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
InnerError	InnerError
KubernetesClusterBackupDatasourceParameters	Parâmetros para a Origem de Dados de Cópia de Segurança do Cluster do Kubernetes
PolicyInfo	PolicyInfo
PolicyParameters	Parâmetros na Política
ProtectionStatusDetails	ProtectionStatusDetails
SecretStoreBasedAuthCredentials	Credenciais de autenticação baseadas em arquivo secreto.
SecretStoreResource	Classe que representa um recurso de arquivo secreto.
SecretStoreType	Obtém ou define o tipo de arquivo de segredos
Status	Especifica o estado de proteção do recurso
systemData	Metadados relativos à criação e última modificação do recurso.
UserFacingError	Objeto de erro utilizado por camadas que têm acesso a conteúdo localizado e propaga-o para o utilizador
ValidationType	Especifica o tipo de validação. No caso do DeepValidation, todas as validações da API /validateForBackup serão executadas novamente.

AzureOperationalStoreParameters

Parâmetros para Operational-Tier DataStore

Name	Tipo	Description
dataStoreType	DataStoreTypes	tipo de arquivo de dados; Operacional/Cofre/Arquivo
objectType	string: AzureOperationalStoreParameters	Tipo do objeto específico - utilizado para anular a serialização
resourceGroupId	string	Obtém ou define o Uri do Grupo de Recursos de Instantâneo.

BackupInstance

Instância de Cópia de Segurança

Name	Tipo	Description
currentProtectionState	CurrentProtectionState	Especifica o estado de proteção atual do recurso
dataSourceInfo	Datasource	Origem de dados Obtém ou define as informações da origem de dados.
dataSourceSetInfo	DatasourceSet	Conjunto de Origens de Dados Obtém ou define as informações do conjunto de origens de dados.
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	Credenciais a utilizar para autenticar com o fornecedor de origem de dados.
friendlyName	string	Obtém ou define o nome amigável da Instância de Cópia de Segurança.
objectType	string
policyInfo	PolicyInfo	PolicyInfo Obtém ou define as informações da política.
protectionErrorDetails	UserFacingError	Especifica o erro de proteção do recurso
protectionStatus	ProtectionStatusDetails	ProtectionStatusDetails Especifica o estado de proteção do recurso
provisioningState	string	Especifica o estado de aprovisionamento do recurso, ou seja, aprovisionamento/atualização/Com êxito/Falha
validationType	ValidationType	Especifica o tipo de validação. No caso do DeepValidation, todas as validações da API /validateForBackup serão executadas novamente.

BackupInstanceResource

BackupInstanceResource

Name	Tipo	Description
id	string	O ID de Recurso do Proxy representa o caminho completo para o recurso.
name	string	Nome do Recurso de Proxy associado ao recurso.
properties	BackupInstance	Propriedades backupInstanceResource
systemData	systemData	Metadados relativos à criação e última modificação do recurso.
tags	object	Etiquetas de Recursos de Proxy.
type	string	O Tipo de recurso proxy representa o caminho completo do formulário Espaço de Nomes/ResourceType/ResourceType/...

BlobBackupDatasourceParameters

Parâmetros a utilizar durante a configuração da cópia de segurança de blobs

Name	Tipo	Description
containersList	string[]	Lista de contentores a criar cópias de segurança durante a configuração da cópia de segurança de blobs
objectType	string: BlobBackupDatasourceParameters	Tipo do objeto específico - utilizado para anular a serialização

CloudError

CloudError

Name	Tipo	Description
error	Error	A resposta ao erro de gestão de recursos.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CurrentProtectionState

Especifica o estado de proteção atual do recurso

Name	Tipo	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

Origem de dados

Name	Tipo	Description
datasourceType	string	DatasourceType do recurso.
objectType	string	Tipo de objeto Datasource, utilizado para inicializar o tipo herdado certo
resourceID	string	ID do ARM completo do recurso. Para recursos do Azure, este é o ID do ARM. Para recursos não azure, este será o ID criado pelo serviço de cópia de segurança através do Fabric/Vault.
resourceLocation	string	Localização da origem de dados.
resourceName	string	Identificador exclusivo do recurso no contexto do principal.
resourceType	string	Tipo de Recurso de Origem de Dados.
resourceUri	string	Uri do recurso.

DatasourceSet

Conjunto de Origens de Dados

Name	Tipo	Description
datasourceType	string	DatasourceType do recurso.
objectType	string	Tipo de objeto Datasource, utilizado para inicializar o tipo herdado certo
resourceID	string	ID do ARM completo do recurso. Para recursos do Azure, este é o ID do ARM. Para recursos não azure, este será o ID criado pelo serviço de cópia de segurança através do Fabric/Vault.
resourceLocation	string	Localização da origem de dados.
resourceName	string	Identificador exclusivo do recurso no contexto do principal.
resourceType	string	Tipo de Recurso de Origem de Dados.
resourceUri	string	Uri do recurso.

DataStoreTypes

tipo de arquivo de dados; Operacional/Cofre/Arquivo

Name	Tipo	Description
ArchiveStore	string
OperationalStore	string
VaultStore	string

Error

A resposta ao erro de gestão de recursos.

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

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

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

InnerError

InnerError

Name	Tipo	Description
additionalInfo	object	Todos os pares chave de valor que podem ser fornecidos ao cliente para obter informações verbosas adicionais.
code	string	Código exclusivo para este erro
embeddedInnerError	InnerError	InnerError Erro Interno subordinado, para permitir o Aninhamento.

KubernetesClusterBackupDatasourceParameters

Parâmetros para a Origem de Dados de Cópia de Segurança do Cluster do Kubernetes

Name	Tipo	Description
excludedNamespaces	string[]	Obtém ou define a propriedade excluir espaços de nomes. Esta propriedade define os espaços de nomes a serem excluídos durante o restauro.
excludedResourceTypes	string[]	Obtém ou define a propriedade excluir tipos de recursos. Esta propriedade define os tipos de recursos a serem excluídos durante o restauro.
includeClusterScopeResources	boolean	Obtém ou define a propriedade incluir recursos de cluster. Esta propriedade, se ativada, incluirá recursos de âmbito de cluster durante o restauro.
includedNamespaces	string[]	Obtém ou define a propriedade incluir espaços de nomes. Esta propriedade define os espaços de nomes a serem incluídos durante o restauro.
includedResourceTypes	string[]	Obtém ou define a propriedade incluir tipos de recursos. Esta propriedade define os tipos de recursos a serem incluídos durante o restauro.
labelSelectors	string[]	Obtém ou define a propriedade LabelSelectors. Esta propriedade define o recurso com esses seletores de etiquetas para serem incluídos durante o restauro.
objectType	string: KubernetesClusterBackupDatasourceParameters	Tipo do objeto específico - utilizado para anular a serialização
snapshotVolumes	boolean	Obtém ou define a propriedade de instantâneo de volume. Esta propriedade, se ativada, irá tirar instantâneos de volume durante o restauro.

PolicyInfo

PolicyInfo

Name	Tipo	Description
policyId	string
policyParameters	PolicyParameters	Parâmetros de política para a instância de cópia de segurança
policyVersion	string

PolicyParameters

Parâmetros na Política

Name	Tipo	Description
backupDatasourceParametersList	BackupDatasourceParameters[]: BlobBackupDatasourceParameters[] KubernetesClusterBackupDatasourceParameters[]	Obtém ou define os Parâmetros da Origem de Dados de Cópia de Segurança
dataStoreParametersList	DataStoreParameters[]: AzureOperationalStoreParameters[]	Obtém ou define os Parâmetros do DataStore

ProtectionStatusDetails

ProtectionStatusDetails

Name	Tipo	Description
errorDetails	UserFacingError	Especifica o erro de estado de proteção do recurso
status	Status	Especifica o estado de proteção do recurso

SecretStoreBasedAuthCredentials

Credenciais de autenticação baseadas em arquivo secreto.

Name	Tipo	Description
objectType	string: SecretStoreBasedAuthCredentials	Tipo do objeto específico - utilizado para anular a serialização
secretStoreResource	SecretStoreResource	Recurso de arquivo secreto

SecretStoreResource

Classe que representa um recurso de arquivo secreto.

Name	Tipo	Description
secretStoreType	SecretStoreType	Obtém ou define o tipo de arquivo secreto
uri	string	Uri para aceder ao recurso
value	string	Obtém ou define o valor armazenado no recurso do arquivo de segredos

SecretStoreType

Obtém ou define o tipo de arquivo de segredos

Name	Tipo	Description
AzureKeyVault	string
Invalid	string

Status

Especifica o estado de proteção do recurso

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

systemData

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

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

UserFacingError

Objeto de erro utilizado por camadas que têm acesso a conteúdo localizado e propaga-o para o utilizador

Name	Tipo	Description
code	string	Código exclusivo para este erro
details	UserFacingError[]	Erros Relacionados Adicionais
innerError	InnerError	InnerError Erro Interno
isRetryable	boolean	Se a operação será ou não reativada
isUserError	boolean	Se a operação se deve a um erro de utilizador ou erro de serviço
message	string
properties	object	Todos os pares de valores chave que podem ser injetados dentro do objeto de erro
recommendedAction	string[]	RecommendedAction localizado.
target	string	Destino do erro.

ValidationType

Especifica o tipo de validação. No caso do DeepValidation, todas as validações da API /validateForBackup serão executadas novamente.

Name	Tipo	Description
DeepValidation	string
ShallowValidation	string