Backup Instances - Create Or Update

Service:: Data Protection

API Version:: 2025-09-01

Create or update a backup instance in a backup vault

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

URI Parameters

Name	In	Required	Type	Description
backupInstanceName	path	True	string	The name of the BackupInstanceResource
resourceGroupName	path	True	string minLength: 1 maxLength: 90	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 minLength: 2 maxLength: 50 pattern: ^[A-Za-z][-A-Za-z0-9]*[A-Za-z0-9]$	The name of the backup vault.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Header

Name	Required	Type	Description
x-ms-authorization-auxiliary		string

Request Body

Name	Type	Description
properties	BackupInstance	BackupInstanceResource properties
tags	object	Proxy Resource tags.

Responses

Name	Type	Description
200 OK	BackupInstanceResource	Resource 'BackupInstanceResource' update operation succeeded
201 Created	BackupInstanceResource	Resource 'BackupInstanceResource' create operation succeeded Headers Location: string Retry-After: integer
202 Accepted		Resource operation accepted. Headers Azure-AsyncOperation: string Location: string
Other Status Codes	CloudError	An unexpected error response.

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

Create BackupInstance

Create BackupInstance to perform critical operation With MUA

Create BackupInstance With ADLSBlobBackupDatasourceParameters

Create BackupInstance With KubernetesClusterBackupDatasourceParameters

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=2025-09-01

{
  "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",
    "identityDetails": {
      "useSystemAssignedIdentity": false,
      "userAssignedIdentityArmUrl": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourcegroups/rg-name/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testUami"
    },
    "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"
  }
}

Sample response

Status code:: 200

{
  "name": "harshitbi2",
  "type": "Microsoft.DataProtection/backupVaults/backupInstances",
  "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
  "properties": {
    "dataSourceInfo": {
      "datasourceType": "OssDB",
      "objectType": "Datasource",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
      "resourceLocation": "",
      "resourceName": "testdb",
      "resourceType": "OssDB",
      "resourceUri": ""
    },
    "dataSourceSetInfo": {
      "datasourceType": "OssDB",
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
      "resourceLocation": "",
      "resourceName": "viveksipgtest",
      "resourceType": "OssDB",
      "resourceUri": ""
    },
    "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"
          }
        ]
      },
      "policyVersion": "3.2"
    },
    "protectionStatus": {
      "status": "NotProtected"
    },
    "provisioningState": "Provisioned"
  }
}

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=2025-09-01
Retry-After: 60

{
  "name": "harshitbi2",
  "type": "Microsoft.DataProtection/backupVaults/backupInstances",
  "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
  "properties": {
    "dataSourceInfo": {
      "datasourceType": "OssDB",
      "objectType": "Datasource",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
      "resourceLocation": "",
      "resourceName": "testdb",
      "resourceType": "OssDB",
      "resourceUri": ""
    },
    "dataSourceSetInfo": {
      "datasourceType": "OssDB",
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
      "resourceLocation": "",
      "resourceName": "viveksipgtest",
      "resourceType": "OssDB",
      "resourceUri": ""
    },
    "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"
          }
        ]
      },
      "policyVersion": "3.2"
    },
    "protectionStatus": {
      "status": "NotProtected"
    },
    "provisioningState": "Provisioning"
  }
}

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=2025-09-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=2025-09-01
Retry-After: 60

Create BackupInstance to perform critical operation With MUA

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=2025-09-01

{
  "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"
          }
        ]
      }
    },
    "resourceGuardOperationRequests": [
      "/subscriptions/38304e13-357e-405e-9e9a-220351dcce8c/resourcegroups/ankurResourceGuard1/providers/Microsoft.DataProtection/resourceGuards/ResourceGuard38-1/dppModifyPolicy/default"
    ],
    "validationType": "ShallowValidation"
  }
}

Sample response

Status code:: 200

{
  "name": "harshitbi2",
  "type": "Microsoft.DataProtection/backupVaults/backupInstances",
  "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
  "properties": {
    "dataSourceInfo": {
      "datasourceType": "OssDB",
      "objectType": "Datasource",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
      "resourceLocation": "",
      "resourceName": "testdb",
      "resourceType": "OssDB",
      "resourceUri": ""
    },
    "dataSourceSetInfo": {
      "datasourceType": "OssDB",
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
      "resourceLocation": "",
      "resourceName": "viveksipgtest",
      "resourceType": "OssDB",
      "resourceUri": ""
    },
    "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"
          }
        ]
      },
      "policyVersion": "3.2"
    },
    "protectionStatus": {
      "status": "NotProtected"
    },
    "provisioningState": "Provisioned"
  }
}

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=2025-09-01
Retry-After: 60

{
  "name": "harshitbi2",
  "type": "Microsoft.DataProtection/backupVaults/backupInstances",
  "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
  "properties": {
    "dataSourceInfo": {
      "datasourceType": "OssDB",
      "objectType": "Datasource",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
      "resourceLocation": "",
      "resourceName": "testdb",
      "resourceType": "OssDB",
      "resourceUri": ""
    },
    "dataSourceSetInfo": {
      "datasourceType": "OssDB",
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
      "resourceLocation": "",
      "resourceName": "viveksipgtest",
      "resourceType": "OssDB",
      "resourceUri": ""
    },
    "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"
          }
        ]
      },
      "policyVersion": "3.2"
    },
    "protectionStatus": {
      "status": "NotProtected"
    },
    "provisioningState": "Provisioning"
  }
}

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=2025-09-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=2025-09-01
Retry-After: 60

Create BackupInstance With ADLSBlobBackupDatasourceParameters

Sample request

HTTP

PUT https://management.azure.com/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.DataProtection/backupVaults/adlsvault/backupInstances/adlsstorageaccount-adlsstorageaccount-19a76f8a-c176-4f7d-819e-95157e2b0071?api-version=2025-09-01

{
  "properties": {
    "dataSourceInfo": {
      "datasourceType": "Microsoft.Storage/storageAccounts/adlsBlobServices",
      "objectType": "Datasource",
      "resourceID": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.Storage/storageAccounts/adlsstorageaccount",
      "resourceLocation": "centraluseuap",
      "resourceName": "adlsstorageaccount",
      "resourceType": "microsoft.storage/storageAccounts",
      "resourceUri": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.Storage/storageAccounts/adlsstorageaccount"
    },
    "dataSourceSetInfo": {
      "datasourceType": "Microsoft.Storage/storageAccounts/adlsBlobServices",
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.Storage/storageAccounts/adlsstorageaccount",
      "resourceLocation": "centraluseuap",
      "resourceName": "adlsstorageaccount",
      "resourceType": "microsoft.storage/storageAccounts",
      "resourceUri": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.Storage/storageAccounts/adlsstorageaccount"
    },
    "friendlyName": "adlsstorageaccount\\adlsbackupinstance",
    "objectType": "BackupInstance",
    "policyInfo": {
      "policyId": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.DataProtection/backupVaults/adlsvault/backupPolicies/adlspolicy",
      "policyParameters": {
        "backupDatasourceParametersList": [
          {
            "containersList": [
              "container1"
            ],
            "objectType": "AdlsBlobBackupDatasourceParameters"
          }
        ]
      }
    }
  }
}

Sample response

Status code:: 200

{
  "name": "19a76f8a-c176-4f7d-819e-95157e2b0077",
  "type": "Microsoft.DataProtection/backupVaults/backupInstances",
  "id": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.DataProtection/backupVaults/adlsvault/backupInstances/19a76f8a-c176-4f7d-819e-95157e2b0077",
  "properties": {
    "dataSourceInfo": {
      "datasourceType": "Microsoft.Storage/storageAccounts/adlsBlobServices",
      "objectType": "Datasource",
      "resourceID": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.Storage/storageAccounts/adlsstorageaccount",
      "resourceLocation": "centraluseuap",
      "resourceName": "adlsstorageaccount",
      "resourceType": "microsoft.storage/storageAccounts",
      "resourceUri": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.Storage/storageAccounts/adlsstorageaccount"
    },
    "dataSourceSetInfo": {
      "datasourceType": "Microsoft.Storage/storageAccounts/adlsBlobServices",
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.Storage/storageAccounts/adlsstorageaccount",
      "resourceLocation": "centraluseuap",
      "resourceName": "adlsstorageaccount",
      "resourceType": "microsoft.storage/storageAccounts",
      "resourceUri": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.Storage/storageAccounts/adlsstorageaccount"
    },
    "friendlyName": "adlsstorageaccount\\adlsbackupinstance",
    "objectType": "BackupInstance",
    "policyInfo": {
      "policyId": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.DataProtection/backupVaults/adlsvault/backupPolicies/adlspolicy",
      "policyParameters": {
        "backupDatasourceParametersList": [
          {
            "containersList": [
              "container1"
            ],
            "objectType": "AdlsBlobBackupDatasourceParameters"
          }
        ]
      }
    },
    "protectionStatus": {
      "status": "NotProtected"
    },
    "provisioningState": "Provisioned"
  }
}

Status code:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/54707983-993e-43de-8d94-074451394eda/resourcegroups/adlsrg/providers/Microsoft.Resources/deployments/ConfigureProtection-2097/operationStatuses/08584622124860116406?api-version=2022-12-01&t=638749912006014742&c=MIIHhzCCBm-gAwIBAgITfAaTiaklTwdb3CiPmAAABpOJqTANBgkqhkiG9w0BAQsFADBEMRMwEQYKCZImiZPyLGQBGRYDR0JMMRMwEQYKCZImiZPyLGQBGRYDQU1FMRgwFgYDVQQDEw9BTUUgSW5mcmEgQ0EgMDUw
Retry-After: 60

{
  "name": "19a76f8a-c176-4f7d-819e-95157e2b0077",
  "type": "Microsoft.DataProtection/backupVaults/backupInstances",
  "id": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.DataProtection/backupVaults/adlsvault/backupInstances/19a76f8a-c176-4f7d-819e-95157e2b0077",
  "properties": {
    "dataSourceInfo": {
      "datasourceType": "Microsoft.Storage/storageAccounts/adlsBlobServices",
      "objectType": "Datasource",
      "resourceID": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.Storage/storageAccounts/adlsstorageaccount",
      "resourceLocation": "centraluseuap",
      "resourceName": "adlsstorageaccount",
      "resourceType": "microsoft.storage/storageAccounts",
      "resourceUri": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.Storage/storageAccounts/adlsstorageaccount"
    },
    "dataSourceSetInfo": {
      "datasourceType": "Microsoft.Storage/storageAccounts/adlsBlobServices",
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.Storage/storageAccounts/adlsstorageaccount",
      "resourceLocation": "centraluseuap",
      "resourceName": "adlsstorageaccount",
      "resourceType": "microsoft.storage/storageAccounts",
      "resourceUri": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.Storage/storageAccounts/adlsstorageaccount"
    },
    "friendlyName": "adlsstorageaccount\\adlsbackupinstance",
    "objectType": "BackupInstance",
    "policyInfo": {
      "policyId": "/subscriptions/54707983-993e-43de-8d94-074451394eda/resourceGroups/adlsrg/providers/Microsoft.DataProtection/backupVaults/adlsvault/backupPolicies/adlspolicy",
      "policyParameters": {
        "backupDatasourceParametersList": [
          {
            "containersList": [],
            "objectType": "AdlsBlobBackupDatasourceParameters"
          }
        ]
      }
    },
    "protectionStatus": {
      "status": "NotProtected"
    },
    "provisioningState": "Provisioning"
  }
}

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/54707983-993e-43de-8d94-074451394eda/resourcegroups/adlsrg/providers/Microsoft.Resources/deployments/ConfigureProtection-2097/operationStatuses/08584622124860116406?api-version=2022-12-01&t=638749912006014742&c=MIIHhzCCBm-gAwIBAgITfAaTiaklTwdb3CiPmAAABpOJqTANBgkqhkiG9w0BAQsFADBEMRMwEQYKCZImiZPyLGQBGRYDR0JMMRMwEQYKCZImiZPyLGQBGRYDQU1FMRgwFgYDVQQDEw9BTUUgSW5mcmEgQ0EgMDUw
Location: https://management.azure.com/subscriptions/54707983-993e-43de-8d94-074451394eda/resourcegroups/adlsrg/providers/Microsoft.DataProtection/backupVaults/adlsvault/backupInstances/adlsstorageaccount-adlsstorageaccount-19a76f8a-c176-4f7d-819e-95157e2b0071/operationStatuses/08584622124860116406?api-version=2022-12-01&t=638749912006014742&c=MIIHhzCCBm-gAwIBAgITfAaTiaklTwdb3CiPmAAABpOJqTANBgkqhkiG9w0BAQsFADBEMRMwEQYKCZImiZPyLGQBGRYDR0JMMRMwEQYKCZImiZPyLGQBGRYDQU1FMRgwFgYDVQQDEw9BTUUgSW5mcmEgQ0EgMDUw
Retry-After: 60

Create BackupInstance With KubernetesClusterBackupDatasourceParameters

Sample request

HTTP

PUT https://management.azure.com/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.DataProtection/backupVaults/aksvault/backupInstances/aksbi?api-version=2025-09-01

{
  "properties": {
    "dataSourceInfo": {
      "datasourceType": "Microsoft.ContainerService/managedclusters",
      "objectType": "Datasource",
      "resourceID": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.ContainerService/managedClusters/akscluster",
      "resourceLocation": "eastus2euap",
      "resourceName": "akscluster",
      "resourceType": "Microsoft.ContainerService/managedclusters",
      "resourceUri": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.ContainerService/managedClusters/akscluster"
    },
    "dataSourceSetInfo": {
      "datasourceType": "Microsoft.ContainerService/managedclusters",
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.ContainerService/managedClusters/akscluster",
      "resourceLocation": "eastus2euap",
      "resourceName": "akscluster",
      "resourceType": "Microsoft.ContainerService/managedclusters",
      "resourceUri": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.ContainerService/managedClusters/akscluster"
    },
    "friendlyName": "aksbi",
    "objectType": "BackupInstance",
    "policyInfo": {
      "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourcegroups/aksrg/providers/Microsoft.DataProtection/BackupVaults/aksvault/backupPolicies/akspolicy",
      "policyParameters": {
        "backupDatasourceParametersList": [
          {
            "excludedNamespaces": [
              "kube-system"
            ],
            "excludedResourceTypes": [
              "v1/Secret"
            ],
            "includeClusterScopeResources": true,
            "includedNamespaces": [
              "test"
            ],
            "includedResourceTypes": [],
            "includedVolumeTypes": [
              "AzureDisk",
              "AzureFileShareSMB"
            ],
            "labelSelectors": [],
            "objectType": "KubernetesClusterBackupDatasourceParameters",
            "snapshotVolumes": true
          }
        ],
        "dataStoreParametersList": [
          {
            "dataStoreType": "OperationalStore",
            "objectType": "AzureOperationalStoreParameters",
            "resourceGroupId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg"
          }
        ]
      }
    }
  }
}

Sample response

Status code:: 200

{
  "name": "aksbi",
  "type": "Microsoft.DataProtection/backupVaults/backupInstances",
  "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.DataProtection/backupVaults/aksvault/backupInstances/aksbi",
  "properties": {
    "dataSourceInfo": {
      "datasourceType": "Microsoft.ContainerService/managedclusters",
      "objectType": "Datasource",
      "resourceID": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.ContainerService/managedClusters/akscluster",
      "resourceLocation": "eastus2euap",
      "resourceName": "akscluster",
      "resourceType": "Microsoft.ContainerService/managedclusters",
      "resourceUri": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.ContainerService/managedClusters/akscluster"
    },
    "dataSourceSetInfo": {
      "datasourceType": "Microsoft.ContainerService/managedclusters",
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.ContainerService/managedClusters/akscluster",
      "resourceLocation": "eastus2euap",
      "resourceType": "Microsoft.ContainerService/managedclusters"
    },
    "friendlyName": "aksbi",
    "objectType": "BackupInstance",
    "policyInfo": {
      "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.DataProtection/backupVaults/aksvault/backupPolicies/akspolicy",
      "policyParameters": {
        "backupDatasourceParametersList": [
          {
            "excludedNamespaces": [
              "kube-system"
            ],
            "excludedResourceTypes": [
              "v1/Secret"
            ],
            "includeClusterScopeResources": true,
            "includedNamespaces": [
              "test"
            ],
            "includedResourceTypes": [],
            "includedVolumeTypes": [
              "AzureDisk",
              "AzureFileShareSMB"
            ],
            "labelSelectors": [],
            "objectType": "KubernetesClusterBackupDatasourceParameters",
            "snapshotVolumes": true
          }
        ],
        "dataStoreParametersList": [
          {
            "dataStoreType": "OperationalStore",
            "objectType": "AzureOperationalStoreParameters",
            "resourceGroupId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg"
          }
        ]
      }
    },
    "protectionStatus": {
      "status": "NotProtected"
    },
    "provisioningState": "Provisioned"
  }
}

Status code:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.DataProtection/backupVaults/aksvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2025-09-01
Retry-After: 60

{
  "name": "aksbi",
  "type": "Microsoft.DataProtection/backupVaults/backupInstances",
  "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.DataProtection/backupVaults/aksvault/backupInstances/aksbi",
  "properties": {
    "dataSourceInfo": {
      "datasourceType": "Microsoft.ContainerService/managedclusters",
      "objectType": "Datasource",
      "resourceID": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.ContainerService/managedClusters/akscluster",
      "resourceLocation": "eastus2euap",
      "resourceName": "akscluster",
      "resourceType": "Microsoft.ContainerService/managedclusters",
      "resourceUri": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.ContainerService/managedClusters/akscluster"
    },
    "dataSourceSetInfo": {
      "datasourceType": "Microsoft.ContainerService/managedclusters",
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.ContainerService/managedClusters/akscluster",
      "resourceLocation": "eastus2euap",
      "resourceType": "Microsoft.ContainerService/managedclusters"
    },
    "friendlyName": "aksbi",
    "objectType": "BackupInstance",
    "policyInfo": {
      "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.DataProtection/backupVaults/aksvault/backupPolicies/akspolicy",
      "policyParameters": {
        "backupDatasourceParametersList": [
          {
            "excludedNamespaces": [
              "kube-system"
            ],
            "excludedResourceTypes": [
              "v1/Secret"
            ],
            "includeClusterScopeResources": true,
            "includedNamespaces": [
              "test"
            ],
            "includedResourceTypes": [],
            "includedVolumeTypes": [
              "AzureDisk",
              "AzureFileShareSMB"
            ],
            "labelSelectors": [],
            "objectType": "KubernetesClusterBackupDatasourceParameters",
            "snapshotVolumes": true
          }
        ],
        "dataStoreParametersList": [
          {
            "dataStoreType": "OperationalStore",
            "objectType": "AzureOperationalStoreParameters",
            "resourceGroupId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg"
          }
        ]
      }
    },
    "protectionStatus": {
      "status": "NotProtected"
    },
    "provisioningState": "Provisioning"
  }
}

Status code:: 202

Azure-AsyncOperation: https://management.windowsazure.com/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.DataProtection/backupVaults/aksvault/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2025-09-01
Location: https://management.windowsazure.com/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/aksrg/providers/Microsoft.DataProtection/backupVaults/aksvault/backupInstances/aksbi/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2025-09-01
Retry-After: 60

Definitions

Name	Description
AdlsBlobBackupDatasourceParameters	Parameters to be used during configuration of backup of azure data lake storage account blobs
AKSVolumeTypes
AzureOperationalStoreParameters	Parameters for Operational-Tier DataStore
BackupInstance	Backup Instance
BackupInstanceResource	BackupInstance Resource
BlobBackupDatasourceParameters	Parameters to be used during configuration of backup of blobs
CloudError	An error response from Azure Backup.
createdByType	The type of identity that created the resource.
CurrentProtectionState	Specifies the current protection state of the resource
Datasource	Datasource to be backed up
DatasourceSet	DatasourceSet details of datasource to be backed up
DataStoreTypes	type of datastore; Operational/Vault/Archive
DefaultResourceProperties	Default source properties
Error	The resource management error response.
ErrorAdditionalInfo	The resource management error additional info.
IdentityDetails
InnerError	Inner Error
KubernetesClusterBackupDatasourceParameters	Parameters for Kubernetes Cluster Backup Datasource
NamespacedNameResource	Class to refer resources which contains namespace and name
PolicyInfo	Policy Info in backupInstance
PolicyParameters	Parameters in Policy
ProtectionStatusDetails	Protection status details
ResourcePropertiesObjectType	Type of the specific object - used for deserializing
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.

AdlsBlobBackupDatasourceParameters

Object

Parameters to be used during configuration of backup of azure data lake storage account blobs

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

AKSVolumeTypes

Enumeration

Value	Description
AzureDisk
AzureFileShareSMB

AzureOperationalStoreParameters

Object

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

Object

Backup Instance

Name	Type	Description
currentProtectionState	CurrentProtectionState	Specifies the current protection state of the resource
dataSourceInfo	Datasource	Gets or sets the data source information.
dataSourceSetInfo	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.
identityDetails	IdentityDetails	Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
objectType	string
policyInfo	PolicyInfo	Gets or sets the policy information.
protectionErrorDetails	UserFacingError	Specifies the protection error of the resource
protectionStatus	ProtectionStatusDetails	Specifies the protection status of the resource
provisioningState	string	Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
validationType	ValidationType	Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.

BackupInstanceResource

Object

BackupInstance Resource

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	BackupInstance	BackupInstanceResource properties
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Proxy Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

BlobBackupDatasourceParameters

Object

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

Object

An error response from Azure Backup.

Name	Type	Description
error	Error	The resource management error response.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

CurrentProtectionState

Enumeration

Specifies the current protection state of the resource

Value	Description
Invalid
NotProtected
ConfiguringProtection
ProtectionConfigured
BackupSchedulesSuspended
RetentionSchedulesSuspended
ProtectionStopped
ProtectionError
ConfiguringProtectionFailed
SoftDeleting
SoftDeleted
UpdatingProtection

Datasource

Object

Datasource to be backed up

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.
resourceProperties	BaseResourceProperties: DefaultResourceProperties	Properties specific to data source
resourceType	string	Resource Type of Datasource.
resourceUri	string	Uri of the resource.

DatasourceSet

Object

DatasourceSet details of datasource to be backed up

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.
resourceProperties	BaseResourceProperties: DefaultResourceProperties	Properties specific to data source set
resourceType	string	Resource Type of Datasource.
resourceUri	string	Uri of the resource.

DataStoreTypes

Enumeration

type of datastore; Operational/Vault/Archive

Value	Description
OperationalStore
VaultStore
ArchiveStore

DefaultResourceProperties

Object

Default source properties

Name	Type	Description
objectType	string: DefaultResourceProperties	Type of the specific object - used for deserializing

Error

Object

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

Object

The resource management error additional info.

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

IdentityDetails

Object

Name	Type	Description
useSystemAssignedIdentity	boolean	Specifies if the BI is protected by System Identity.
userAssignedIdentityArmUrl	string	ARM URL for User Assigned Identity.

InnerError

Object

Inner Error

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	Child Inner Error, to allow Nesting.

KubernetesClusterBackupDatasourceParameters

Object

Parameters for Kubernetes Cluster Backup Datasource

Name	Type	Description
backupHookReferences	NamespacedNameResource[]	Gets or sets the backup hook references. This property sets the hook reference to be executed during backup.
excludedNamespaces	string[]	Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup.
excludedResourceTypes	string[]	Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup.
includeClusterScopeResources	boolean	Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup.
includedNamespaces	string[]	Gets or sets the include namespaces property. This property sets the namespaces to be included during backup.
includedResourceTypes	string[]	Gets or sets the include resource types property. This property sets the resource types to be included during backup.
includedVolumeTypes	AKSVolumeTypes[]	Gets or sets the include volume types property. This property sets the volume types to be included during backup.
labelSelectors	string[]	Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup.
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 backup.

NamespacedNameResource

Object

Class to refer resources which contains namespace and name

Name	Type	Description
name	string	Name of the resource
namespace	string	Namespace in which the resource exists

PolicyInfo

Object

Policy Info in backupInstance

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

PolicyParameters

Object

Parameters in Policy

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

ProtectionStatusDetails

Object

Protection status details

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

ResourcePropertiesObjectType

Enumeration

Type of the specific object - used for deserializing

Value	Description
DefaultResourceProperties

SecretStoreBasedAuthCredentials

Object

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

Object

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

Enumeration

Gets or sets the type of secret store

Value	Description
Invalid
AzureKeyVault

Status

Enumeration

Specifies the protection status of the resource

Value	Description
ConfiguringProtection
ConfiguringProtectionFailed
ProtectionConfigured
ProtectionStopped
SoftDeleted
SoftDeleting

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	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

Object

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

Enumeration

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

Value	Description
ShallowValidation
DeepValidation

Share via

Backup Instances - Create Or Update

URI Parameters

Request Header

Request Body

Responses

Security

azure_auth

Scopes

Examples

Create BackupInstance

Sample request

Sample response

Create BackupInstance to perform critical operation With MUA

Sample request

Sample response

Create BackupInstance With ADLSBlobBackupDatasourceParameters

Sample request

Sample response

Create BackupInstance With KubernetesClusterBackupDatasourceParameters

Sample request

Sample response

Definitions

AdlsBlobBackupDatasourceParameters

AKSVolumeTypes

AzureOperationalStoreParameters

BackupInstance

BackupInstanceResource

BlobBackupDatasourceParameters

CloudError

createdByType

CurrentProtectionState

Datasource

DatasourceSet

DataStoreTypes

DefaultResourceProperties

Error

ErrorAdditionalInfo

IdentityDetails

InnerError

KubernetesClusterBackupDatasourceParameters

NamespacedNameResource

PolicyInfo

PolicyParameters

ProtectionStatusDetails

ResourcePropertiesObjectType

SecretStoreBasedAuthCredentials

SecretStoreResource

SecretStoreType

Status

systemData

UserFacingError

ValidationType