Backup Instances - List

Reference

Service:: Data Protection

API Version:: 2023-01-01

Gets a backup instances belonging to a backup vault

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
vaultName	path	True	string	The name of the backup vault.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	BackupInstanceResourceList	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

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	impersonate your user account.

Examples

List BackupInstances in a Vault

Sample request

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

/** Samples for BackupInstances List. */
public final class Main {
    /*
     * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ListBackupInstances.json
     */
    /**
     * Sample code: List BackupInstances in a Vault.
     *
     * @param manager Entry point to DataProtectionManager.
     */
    public static void listBackupInstancesInAVault(
        com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager.backupInstances().list("000pikumar", "PratikPrivatePreviewVault1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python list_backup_instances.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.list(
        resource_group_name="000pikumar",
        vault_name="PratikPrivatePreviewVault1",
    )
    for item in response:
        print(item)


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

package armdataprotection_test

import (
	"context"
	"log"

	"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/ListBackupInstances.json
func ExampleBackupInstancesClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewBackupInstancesClient().NewListPager("000pikumar", "PratikPrivatePreviewVault1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.BackupInstanceResourceList = armdataprotection.BackupInstanceResourceList{
		// 	Value: []*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"),
		// 					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

const { DataProtectionClient } = require("@azure/arm-dataprotection");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a backup instances belonging to a backup vault
 *
 * @summary Gets a backup instances belonging to a backup vault
 * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ListBackupInstances.json
 */
async function listBackupInstancesInAVault() {
  const subscriptionId =
    process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "04cf684a-d41f-4550-9f70-7708a3a2283b";
  const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "000pikumar";
  const vaultName = "PratikPrivatePreviewVault1";
  const credential = new DefaultAzureCredential();
  const client = new DataProtectionClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.backupInstances.list(resourceGroupName, vaultName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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:: 200

{
  "value": [
    {
      "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"
        },
        "protectionStatus": {
          "status": "NotProtected"
        },
        "provisioningState": "Provisioning",
        "objectType": "BackupInstance"
      }
    }
  ]
}

Definitions

Name	Description
AzureOperationalStoreParameters	Parameters for Operational-Tier DataStore
BackupInstance	Backup Instance
BackupInstanceResource	BackupInstanceResource
BackupInstanceResourceList	BackupInstanceResourceList
BlobBackupDatasourceParameters	Parameters to be used during configuration of backup of blobs
CloudError	CloudError
createdByType	The type of identity that created the resource.
CurrentProtectionState	Specifies the current protection state of the resource
Datasource	Datasource
DatasourceSet	DatasourceSet
DataStoreTypes	type of datastore; Operational/Vault/Archive
Error	The resource management error response.
ErrorAdditionalInfo	The resource management error additional info.
InnerError	InnerError
KubernetesClusterBackupDatasourceParameters	Parameters for Kubernetes Cluster Backup Datasource
PolicyInfo	PolicyInfo
PolicyParameters	Parameters in Policy
ProtectionStatusDetails	ProtectionStatusDetails
SecretStoreBasedAuthCredentials	Secret store based authentication credentials.
SecretStoreResource	Class representing a secret store resource.
SecretStoreType	Gets or sets the type of secret store
Status	Specifies the protection status of the resource
systemData	Metadata pertaining to creation and last modification of the resource.
UserFacingError	Error object used by layers that have access to localized content, and propagate that to user
ValidationType	Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.

AzureOperationalStoreParameters

Parameters for Operational-Tier DataStore

Name	Type	Description
dataStoreType	DataStoreTypes	type of datastore; Operational/Vault/Archive
objectType	string: AzureOperationalStoreParameters	Type of the specific object - used for deserializing
resourceGroupId	string	Gets or sets the Snapshot Resource Group Uri.

BackupInstance

Backup Instance

Name	Type	Description
currentProtectionState	CurrentProtectionState	Specifies the current protection state of the resource
dataSourceInfo	Datasource	Datasource Gets or sets the data source information.
dataSourceSetInfo	DatasourceSet	DatasourceSet Gets or sets the data source set information.
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	Credentials to use to authenticate with data source provider.
friendlyName	string	Gets or sets the Backup Instance friendly name.
objectType	string
policyInfo	PolicyInfo	PolicyInfo Gets or sets the policy information.
protectionErrorDetails	UserFacingError	Specifies the protection error of the resource
protectionStatus	ProtectionStatusDetails	ProtectionStatusDetails Specifies the protection status of the resource
provisioningState	string	Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed
validationType	ValidationType	Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.

BackupInstanceResource

Name	Type	Description
id	string	Proxy Resource Id represents the complete path to the resource.
name	string	Proxy Resource name associated with the resource.
properties	BackupInstance	BackupInstanceResource properties
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
tags	object	Proxy Resource tags.
type	string	Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

BackupInstanceResourceList

Name	Type	Description
nextLink	string	The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value	BackupInstanceResource[]	List of resources.

BlobBackupDatasourceParameters

Parameters to be used during configuration of backup of blobs

Name	Type	Description
containersList	string[]	List of containers to be backed up during configuration of backup of blobs
objectType	string: BlobBackupDatasourceParameters	Type of the specific object - used for deserializing

CloudError

Name	Type	Description
error	Error	The resource management error response.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CurrentProtectionState

Specifies the current protection state of the resource

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

Name	Type	Description
datasourceType	string	DatasourceType of the resource.
objectType	string	Type of Datasource object, used to initialize the right inherited type
resourceID	string	Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.
resourceLocation	string	Location of datasource.
resourceName	string	Unique identifier of the resource in the context of parent.
resourceType	string	Resource Type of Datasource.
resourceUri	string	Uri of the resource.

DatasourceSet

Name	Type	Description
datasourceType	string	DatasourceType of the resource.
objectType	string	Type of Datasource object, used to initialize the right inherited type
resourceID	string	Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.
resourceLocation	string	Location of datasource.
resourceName	string	Unique identifier of the resource in the context of parent.
resourceType	string	Resource Type of Datasource.
resourceUri	string	Uri of the resource.

DataStoreTypes

type of datastore; Operational/Vault/Archive

Name	Type	Description
ArchiveStore	string
OperationalStore	string
VaultStore	string

Error

The resource management error response.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	Error[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

InnerError

Name	Type	Description
additionalInfo	object	Any Key value pairs that can be provided to the client for additional verbose information.
code	string	Unique code for this error
embeddedInnerError	InnerError	InnerError Child Inner Error, to allow Nesting.

KubernetesClusterBackupDatasourceParameters

Parameters for Kubernetes Cluster Backup Datasource

Name	Type	Description
excludedNamespaces	string[]	Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore.
excludedResourceTypes	string[]	Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore.
includeClusterScopeResources	boolean	Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore.
includedNamespaces	string[]	Gets or sets the include namespaces property. This property sets the namespaces to be included during restore.
includedResourceTypes	string[]	Gets or sets the include resource types property. This property sets the resource types to be included during restore.
labelSelectors	string[]	Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore.
objectType	string: KubernetesClusterBackupDatasourceParameters	Type of the specific object - used for deserializing
snapshotVolumes	boolean	Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during restore.

PolicyInfo

Name	Type	Description
policyId	string
policyParameters	PolicyParameters	Policy parameters for the backup instance
policyVersion	string

PolicyParameters

Parameters in Policy

Name	Type	Description
backupDatasourceParametersList	BackupDatasourceParameters[]: BlobBackupDatasourceParameters[] KubernetesClusterBackupDatasourceParameters[]	Gets or sets the Backup Data Source Parameters
dataStoreParametersList	DataStoreParameters[]: AzureOperationalStoreParameters[]	Gets or sets the DataStore Parameters

ProtectionStatusDetails

Name	Type	Description
errorDetails	UserFacingError	Specifies the protection status error of the resource
status	Status	Specifies the protection status of the resource

SecretStoreBasedAuthCredentials

Secret store based authentication credentials.

Name	Type	Description
objectType	string: SecretStoreBasedAuthCredentials	Type of the specific object - used for deserializing
secretStoreResource	SecretStoreResource	Secret store resource

SecretStoreResource

Class representing a secret store resource.

Name	Type	Description
secretStoreType	SecretStoreType	Gets or sets the type of secret store
uri	string	Uri to get to the resource
value	string	Gets or sets value stored in secret store resource

SecretStoreType

Gets or sets the type of secret store

Name	Type	Description
AzureKeyVault	string
Invalid	string

Status

Specifies the protection status of the resource

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

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserFacingError

Error object used by layers that have access to localized content, and propagate that to user

Name	Type	Description
code	string	Unique code for this error
details	UserFacingError[]	Additional related Errors
innerError	InnerError	InnerError Inner Error
isRetryable	boolean	Whether the operation will be retryable or not
isUserError	boolean	Whether the operation is due to a user error or service error
message	string
properties	object	Any key value pairs that can be injected inside error object
recommendedAction	string[]	RecommendedAction � localized.
target	string	Target of the error.

ValidationType

Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.

Name	Type	Description
DeepValidation	string
ShallowValidation	string

Share via

Backup Instances - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List BackupInstances in a Vault

Sample request

Sample response

Definitions

AzureOperationalStoreParameters

BackupInstance

BackupInstanceResource

BackupInstanceResourceList

BlobBackupDatasourceParameters

CloudError

createdByType

CurrentProtectionState

Datasource

DatasourceSet

DataStoreTypes

Error

ErrorAdditionalInfo

InnerError

KubernetesClusterBackupDatasourceParameters

PolicyInfo

PolicyParameters

ProtectionStatusDetails

SecretStoreBasedAuthCredentials

SecretStoreResource

SecretStoreType

Status

systemData

UserFacingError

ValidationType

Additional resources