Backups - Get Volume Restore Status

Service:

Azure NetApp Files

API Version:

2021-10-01

Получение состояния восстановления тома
Получение состояния восстановления тома

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/restoreStatus?api-version=2021-10-01

Параметры URI

Name	In	Required	Type	Description
accountName	path	True	string	Имя учетной записи NetApp
poolName	path	True	string	Имя пула емкости Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$
resourceGroupName	path	True	string	Имя группы ресурсов. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют Microsoft Azure подписке. Идентификатор подписки формирует часть URI для каждого вызова службы.
volumeName	path	True	string	Имя тома Regex pattern: ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$
api-version	query	True	string	Версия API, используемая для этой операции.

Ответы

Name	Type	Description
200 OK	restoreStatus	ОК
Other Status Codes		Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Flow OAuth2 Azure Active Directory

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

Scopes

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

Volumes_RestoreStatus

Sample Request

HTTP

GET https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/restoreStatus?api-version=2021-10-01

Java

import com.azure.core.util.Context;

/** Samples for Backups GetVolumeRestoreStatus. */
public final class Main {
    /*
     * x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-10-01/examples/Volumes_RestoreStatus.json
     */
    /**
     * Sample code: Volumes_RestoreStatus.
     *
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void volumesRestoreStatus(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        manager.backups().getVolumeRestoreStatusWithResponse("myRG", "account1", "pool1", "volume1", Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Go

package armnetapp_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/netapp/armnetapp"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-10-01/examples/Volumes_RestoreStatus.json
func ExampleBackupsClient_GetVolumeRestoreStatus() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armnetapp.NewBackupsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetVolumeRestoreStatus(ctx,
		"myRG",
		"account1",
		"pool1",
		"volume1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

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

/**
 * This sample demonstrates how to Get the status of the restore for a volume
 *
 * @summary Get the status of the restore for a volume
 * x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-10-01/examples/Volumes_RestoreStatus.json
 */
async function volumesRestoreStatus() {
  const subscriptionId = "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9";
  const resourceGroupName = "myRG";
  const accountName = "account1";
  const poolName = "pool1";
  const volumeName = "volume1";
  const credential = new DefaultAzureCredential();
  const client = new NetAppManagementClient(credential, subscriptionId);
  const result = await client.backups.getVolumeRestoreStatus(
    resourceGroupName,
    accountName,
    poolName,
    volumeName
  );
  console.log(result);
}

volumesRestoreStatus().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "healthy": true,
  "relationshipStatus": "Idle",
  "mirrorState": "Uninitialized",
  "unhealthyReason": "",
  "errorMessage": "",
  "totalTransferBytes": 100000
}

Определения

MirrorState	Состояние репликации
RelationshipStatus	Состояние зеркальной связи
restoreStatus	Состояние восстановления

MirrorState

Состояние репликации

Name	Type	Description
Broken	string
Mirrored	string
Uninitialized	string

RelationshipStatus

Состояние зеркальной связи

Name	Type	Description
Idle	string
Transferring	string

restoreStatus

Состояние восстановления

Name	Type	Description
errorMessage	string	Отображает сообщение об ошибке, если восстановление находится в состоянии ошибки
healthy	boolean	Восстановление состояния работоспособности
mirrorState	MirrorState	Состояние восстановления
relationshipStatus	RelationshipStatus	Состояние отношения restore SnapMirror
totalTransferBytes	integer	Отображает общее количество переданных байтов
unhealthyReason	string	Причина неработоспособного восстановления