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.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/startAccountMigration?api-version=2023-05-01
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
accountName
|
path |
True
|
string
|
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
Regex pattern: ^[a-z0-9]+$
|
|
resourceGroupName
|
path |
True
|
string
|
The name of the resource group within the user's subscription. The name is case insensitive.
Regex pattern: ^[-\w\._\(\)]+$
|
|
subscriptionId
|
path |
True
|
string
|
The ID of the target subscription.
|
|
api-version
|
query |
True
|
string
|
The API version to use for this operation.
|
Request Body
| Name |
Required |
Type |
Description |
|
properties.targetSkuName
|
True
|
SkuName
|
Target sku name for the account
|
|
name
|
|
string
|
current value is 'default' for customer initiated migration
|
|
type
|
|
string
|
SrpAccountMigrationType in ARM contract which is 'accountMigrations'
|
Responses
| Name |
Type |
Description |
|
200 OK
|
|
OK -- Returned when the request is just for validating the migration request, it does not actually initiate migration; applicable in cross region migration currently.
|
|
202 Accepted
|
|
Accepted -- Migration request accepted; operation will complete asynchronously.
Headers
Location: string
|
|
Other Status Codes
|
ErrorResponse
|
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
StorageAccountPostMigration
Sample request
POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/resource-group-name/providers/Microsoft.Storage/storageAccounts/accountname/startAccountMigration?api-version=2023-05-01
{
"properties": {
"targetSkuName": "Standard_ZRS"
}
}
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-05-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
from typing import Any, IO, Union
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-05-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
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/220ad9c6554fc7d6d10a89bdb441c1e3b36e3285/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-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
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-05-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
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Storage.Models;
using Azure.ResourceManager.Storage;
// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/StorageAccountPostMigration.json
// this example is just showing the usage of "StorageAccounts_CustomerInitiatedMigration" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this StorageAccountResource created on azure
// for more information of creating StorageAccountResource, please refer to the document of StorageAccountResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "resource-group-name";
string accountName = "accountname";
ResourceIdentifier storageAccountResourceId = StorageAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
StorageAccountResource storageAccount = client.GetStorageAccountResource(storageAccountResourceId);
// invoke the operation
StorageAccountMigrationData data = new StorageAccountMigrationData(StorageSkuName.StandardZrs);
await storageAccount.CustomerInitiatedMigrationAsync(WaitUntil.Completed, data);
Console.WriteLine($"Succeeded");
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://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9101/providers/Microsoft.Storage/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2022-09-01
Definitions
| Name |
Description |
|
ErrorResponse
|
An error response from the storage resource provider.
|
|
ErrorResponseBody
|
Error response body contract.
|
|
migrationStatus
|
Current status of migration
|
|
SkuName
|
The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.
|
|
StorageAccountMigration
|
The parameters or status associated with an ongoing or enqueued storage account migration in order to update its current SKU or region.
|
ErrorResponse
An error response from the storage resource provider.
| Name |
Type |
Description |
|
error
|
ErrorResponseBody
|
Azure Storage Resource Provider error response body.
|
ErrorResponseBody
Error response body contract.
| Name |
Type |
Description |
|
code
|
string
|
An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
|
|
message
|
string
|
A message describing the error, intended to be suitable for display in a user interface.
|
migrationStatus
Current status of migration
| Name |
Type |
Description |
|
Complete
|
string
|
|
|
Failed
|
string
|
|
|
InProgress
|
string
|
|
|
Invalid
|
string
|
|
|
SubmittedForConversion
|
string
|
|
SkuName
The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.
| Name |
Type |
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
The parameters or status associated with an ongoing or enqueued storage account migration in order to update its current SKU or region.
| Name |
Type |
Description |
|
id
|
string
|
Migration Resource Id
|
|
name
|
string
|
current value is 'default' for customer initiated migration
|
|
properties.migrationFailedDetailedReason
|
string
|
Reason for migration failure
|
|
properties.migrationFailedReason
|
string
|
Error code for migration failure
|
|
properties.migrationStatus
|
migrationStatus
|
Current status of migration
|
|
properties.targetSkuName
|
SkuName
|
Target sku name for the account
|
|
type
|
string
|
SrpAccountMigrationType in ARM contract which is 'accountMigrations'
|