Storage Accounts - Customer Initiated Migration

Service:

Storage Resource Provider

API Version:

2023-01-01

Żądanie migracji konta można wyzwolić dla konta magazynu, aby zmienić jego poziom nadmiarowości. Migracja aktualizuje konto magazynu strefowo nadmiarowego do konta strefowo nadmiarowego lub odwrotnie, aby zapewnić lepszą niezawodność i dostępność. Magazyn strefowo nadmiarowy (ZRS) replikuje konto magazynu synchronicznie w trzech strefach dostępności platformy Azure w regionie podstawowym.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/startAccountMigration?api-version=2023-01-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
accountName	path	True	string	Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties.targetSkuName	True	SkuName	Nazwa docelowej jednostki SKU dla konta
name		string	bieżąca wartość to "default" dla migracji zainicjowanej przez klienta
type		string	SrpAccountMigrationType w kontrakcie arm, który jest "accountMigrations"

Odpowiedzi

Nazwa	Typ	Opis
200 OK		OK — zwracany, gdy żądanie dotyczy tylko weryfikacji żądania migracji, w rzeczywistości nie inicjuje migracji; dotyczy obecnie migracji między regionami.
202 Accepted		Zaakceptowane — zaakceptowane żądanie migracji; operacja zostanie ukończona asynchronicznie. Headers Location: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

StorageAccountPostMigration

Sample Request

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/resource-group-name/providers/Microsoft.Storage/storageAccounts/accountname/startAccountMigration?api-version=2023-01-01

{
  "properties": {
    "targetSkuName": "Standard_ZRS"
  }
}

Java

import com.azure.resourcemanager.storage.fluent.models.StorageAccountMigrationInner;
import com.azure.resourcemanager.storage.models.SkuName;

/** Samples for StorageAccounts CustomerInitiatedMigration. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountPostMigration.
     * json
     */
    /**
     * Sample code: StorageAccountPostMigration.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void storageAccountPostMigration(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getStorageAccounts().customerInitiatedMigration(
            "resource-group-name", "accountname",
            new StorageAccountMigrationInner().withTargetSkuName(SkuName.STANDARD_ZRS),
            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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python storage_account_post_migration.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 = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    client.storage_accounts.begin_customer_initiated_migration(
        resource_group_name="resource-group-name",
        account_name="accountname",
        parameters={"properties": {"targetSkuName": "Standard_ZRS"}},
    ).result()


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountPostMigration.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 armstorage_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/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountPostMigration.json
func ExampleAccountsClient_BeginCustomerInitiatedMigration() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAccountsClient().BeginCustomerInitiatedMigration(ctx, "resource-group-name", "accountname", armstorage.AccountMigration{
		StorageAccountMigrationDetails: &armstorage.AccountMigrationProperties{
			TargetSKUName: to.Ptr(armstorage.SKUNameStandardZRS),
		},
	}, 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

JavaScript

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

/**
 * This sample demonstrates how to Account Migration request can be triggered for a storage account to change its redundancy level. The migration updates the non-zonal redundant storage account to a zonal redundant account or vice-versa in order to have better reliability and availability. Zone-redundant storage (ZRS) replicates your storage account synchronously across three Azure availability zones in the primary region.
 *
 * @summary Account Migration request can be triggered for a storage account to change its redundancy level. The migration updates the non-zonal redundant storage account to a zonal redundant account or vice-versa in order to have better reliability and availability. Zone-redundant storage (ZRS) replicates your storage account synchronously across three Azure availability zones in the primary region.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountPostMigration.json
 */
async function storageAccountPostMigration() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "resource-group-name";
  const accountName = "accountname";
  const parameters = { targetSkuName: "Standard_ZRS" };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.storageAccounts.beginCustomerInitiatedMigrationAndWait(
    resourceGroupName,
    accountName,
    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:

200

Status code:

202

location: https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9101/providers/Microsoft.Storage/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2022-09-01

Definicje

Nazwa	Opis
ErrorResponse	Odpowiedź o błędzie od dostawcy zasobów magazynu.
ErrorResponseBody	Kontrakt treści odpowiedzi na błąd.
migrationStatus	Bieżący stan migracji
SkuName	Nazwa jednostki SKU. Wymagane do utworzenia konta; opcjonalnie do aktualizacji. Pamiętaj, że w starszych wersjach nazwa jednostki SKU nosiła nazwę accountType.
StorageAccountMigration	Parametry lub stan skojarzony z trwającą lub w kolejce migracją konta magazynu w celu zaktualizowania bieżącej jednostki SKU lub regionu.

ErrorResponse

Odpowiedź o błędzie od dostawcy zasobów magazynu.

Nazwa	Typ	Opis
error	ErrorResponseBody	Treść odpowiedzi dostawcy zasobów usługi Azure Storage.

ErrorResponseBody

Kontrakt treści odpowiedzi na błąd.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

migrationStatus

Bieżący stan migracji

Nazwa	Typ	Opis
Complete	string
Failed	string
InProgress	string
Invalid	string
SubmittedForConversion	string

SkuName

Nazwa jednostki SKU. Wymagane do utworzenia konta; opcjonalnie do aktualizacji. Pamiętaj, że w starszych wersjach nazwa jednostki SKU nosiła nazwę accountType.

Nazwa	Typ	Opis
Premium_LRS	string
Premium_ZRS	string
Standard_GRS	string
Standard_GZRS	string
Standard_LRS	string
Standard_RAGRS	string
Standard_RAGZRS	string
Standard_ZRS	string

StorageAccountMigration

Parametry lub stan skojarzony z trwającą lub w kolejce migracją konta magazynu w celu zaktualizowania bieżącej jednostki SKU lub regionu.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu migracji
name	string	bieżąca wartość to "default" dla migracji zainicjowanej przez klienta
properties.migrationFailedDetailedReason	string	Przyczyna niepowodzenia migracji
properties.migrationFailedReason	string	Kod błędu niepowodzenia migracji
properties.migrationStatus	migrationStatus	Bieżący stan migracji
properties.targetSkuName	SkuName	Nazwa docelowej jednostki SKU dla konta
type	string	SrpAccountMigrationType w kontrakcie arm, który jest "accountMigrations"