Storage Accounts - Customer Initiated Migration

Service:

Storage Resource Provider

API Version:

2023-01-01

O pedido de Migração de Conta pode ser acionado para que uma conta de armazenamento altere o respetivo nível de redundância. A migração atualiza a conta de armazenamento redundante não zonal para uma conta zonarredundante ou vice-versa para ter uma melhor fiabilidade e disponibilidade. O armazenamento com redundância entre zonas (ZRS) replica a sua conta de armazenamento de forma síncrona em três zonas de disponibilidade do Azure na região primária.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string	O nome da conta de armazenamento no grupo de recursos especificado. Os nomes das contas de armazenamento têm de ter entre 3 e 24 carateres de comprimento e utilizar apenas números e letras minúsculas. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	O nome do grupo de recursos na subscrição do utilizador. O nome não é sensível a maiúsculas e minúsculas. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.targetSkuName	True	SkuName	Nome do SKU de destino para a conta
name		string	o valor atual é "predefinido" para a migração iniciada pelo cliente
type		string	SrpAccountMigrationType no contrato do ARM que é "accountMigrations"

Respostas

Name	Tipo	Description
200 OK		OK - Devolvido quando o pedido é apenas para validar o pedido de migração, não inicia efetivamente a migração; atualmente, aplicável na migração entre regiões.
202 Accepted		Aceite - Pedido de migração aceite; A operação será concluída de forma assíncrona. Headers Location: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

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

Definições

Name	Description
ErrorResponse	Uma resposta de erro do fornecedor de recursos de armazenamento.
ErrorResponseBody	Contrato do corpo da resposta do erro.
migrationStatus	Estado atual da migração
SkuName	O nome do SKU. Necessário para a criação da conta; opcional para atualização. Tenha em atenção que em versões mais antigas, o nome do SKU chamava-se accountType.
StorageAccountMigration	Os parâmetros ou o estado associados a uma migração de conta de armazenamento em curso ou em fila para atualizar o SKU ou região atual.

ErrorResponse

Uma resposta de erro do fornecedor de recursos de armazenamento.

Name	Tipo	Description
error	ErrorResponseBody	Corpo de resposta do erro do Fornecedor de Recursos de Armazenamento do Azure.

ErrorResponseBody

Contrato do corpo da resposta do erro.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador.

migrationStatus

Estado atual da migração

Name	Tipo	Description
Complete	string
Failed	string
InProgress	string
Invalid	string
SubmittedForConversion	string

SkuName

O nome do SKU. Necessário para a criação da conta; opcional para atualização. Tenha em atenção que em versões mais antigas, o nome do SKU chamava-se accountType.

Name	Tipo	Description
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

Os parâmetros ou o estado associados a uma migração de conta de armazenamento em curso ou em fila para atualizar o SKU ou região atual.

Name	Tipo	Description
id	string	ID do Recurso de Migração
name	string	o valor atual é "predefinido" para a migração iniciada pelo cliente
properties.migrationFailedDetailedReason	string	Motivo da falha de migração
properties.migrationFailedReason	string	Código de erro para a falha de migração
properties.migrationStatus	migrationStatus	Estado atual da migração
properties.targetSkuName	SkuName	Nome do SKU de destino para a conta
type	string	SrpAccountMigrationType no contrato do ARM que é "accountMigrations"