Sync backup instance again in case of failure
This action will retry last failed operation and will bring backup instance to valid state
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/sync?api-version=2024-04-01
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
backupInstanceName
|
path |
True
|
string
|
The name of the backup instance.
|
|
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.
|
Request Body
| Name |
Type |
Description |
|
syncType
|
SyncType
|
Field indicating sync type e.g. to sync only in case of failure or in all cases
|
Responses
| Name |
Type |
Description |
|
200 OK
|
|
OK
|
|
202 Accepted
|
|
The operation will be completed asynchronously.
Headers
- Location: string
- Azure-AsyncOperation: string
- Retry-After: integer
|
|
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
Sync BackupInstance
Sample request
POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/backupInstances/testbi/sync?api-version=2024-04-01
{
"syncType": "Default"
}
import com.azure.resourcemanager.dataprotection.models.SyncBackupInstanceRequest;
import com.azure.resourcemanager.dataprotection.models.SyncType;
/**
* Samples for BackupInstances SyncBackupInstance.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/
* BackupInstanceOperations/SyncBackupInstance.json
*/
/**
* Sample code: Sync BackupInstance.
*
* @param manager Entry point to DataProtectionManager.
*/
public static void syncBackupInstance(com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
manager.backupInstances().syncBackupInstance("testrg", "testvault", "testbi",
new SyncBackupInstanceRequest().withSyncType(SyncType.DEFAULT), 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 typing import Any, IO, Union
from azure.identity import DefaultAzureCredential
from azure.mgmt.dataprotection import DataProtectionMgmtClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-dataprotection
# USAGE
python sync_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",
)
client.backup_instances.begin_sync_backup_instance(
resource_group_name="testrg",
vault_name="testvault",
backup_instance_name="testbi",
parameters={"syncType": "Default"},
).result()
# x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/SyncBackupInstance.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/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dataprotection/armdataprotection/v3"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/SyncBackupInstance.json
func ExampleBackupInstancesClient_BeginSyncBackupInstance() {
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().BeginSyncBackupInstance(ctx, "testrg", "testvault", "testbi", armdataprotection.SyncBackupInstanceRequest{
SyncType: to.Ptr(armdataprotection.SyncTypeDefault),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %v", err)
}
}
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 Sync backup instance again in case of failure
This action will retry last failed operation and will bring backup instance to valid state
*
* @summary Sync backup instance again in case of failure
This action will retry last failed operation and will bring backup instance to valid state
* x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/SyncBackupInstance.json
*/
async function syncBackupInstance() {
const subscriptionId =
process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "04cf684a-d41f-4550-9f70-7708a3a2283b";
const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "testrg";
const vaultName = "testvault";
const backupInstanceName = "testbi";
const parameters = { syncType: "Default" };
const credential = new DefaultAzureCredential();
const client = new DataProtectionClient(credential, subscriptionId);
const result = await client.backupInstances.beginSyncBackupInstanceAndWait(
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
Location: https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2024-04-01
Azure-AsyncOperation: https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2024-04-01
Retry-After: 60
Definitions
CloudError
CloudError
| Name |
Type |
Description |
|
error
|
Error
|
The resource management error response.
|
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.
|
SyncBackupInstanceRequest
Sync BackupInstance Request
| Name |
Type |
Description |
|
syncType
|
SyncType
|
Field indicating sync type e.g. to sync only in case of failure or in all cases
|
SyncType
Field indicating sync type e.g. to sync only in case of failure or in all cases
| Name |
Type |
Description |
|
Default
|
string
|
|
|
ForceResync
|
string
|
|