Move Collections - Initiate Move

リファレンス

Service:: Resource Mover

API Version:: 2023-08-01

要求本文に含まれるリソースのセットを移動します。移動操作は、moveResources が moveState 'MovePending' または 'MoveFailed' 内にある後にトリガーされます。正常に完了すると、moveResource moveState は CommitPending に遷移します。ユーザーが操作の前提条件を満たすのを支援するために、クライアントは validateOnly プロパティを true に設定して操作を呼び出すことができます。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/initiateMove?api-version=2023-08-01

URI パラメーター

名前	/	必須	型	説明
moveCollectionName	path	True	string	コレクション名の移動。
resourceGroupName	path	True	string	リソースグループ名。
subscriptionId	path	True	string	サブスクリプション ID。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	必須	型	説明
moveResources	True	string[]	リソース ID の一覧を取得または設定します。既定では、moveResourceInputType プロパティを使用して入力の種類が切り替えされていない限り、移動リソース ID を受け入れます。
moveResourceInputType		MoveResourceInputType	移動リソースの入力の種類を定義します。
validateOnly		boolean	操作が前提条件のみを実行する必要があるかどうかを示す値を取得または設定します。

応答

名前	型	説明
200 OK	OperationStatus	OK
202 Accepted		同意
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

MoveCollections_InitiateMove

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/moveCollections/movecollection1/initiateMove?api-version=2023-08-01

{
  "validateOnly": false,
  "moveResources": [
    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1"
  ]
}

import com.azure.resourcemanager.resourcemover.models.ResourceMoveRequest;
import java.util.Arrays;

/** Samples for MoveCollections InitiateMove. */
public final class Main {
    /*
     * x-ms-original-file: specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2023-08-01/examples/MoveCollections_InitiateMove.json
     */
    /**
     * Sample code: MoveCollections_InitiateMove.
     *
     * @param manager Entry point to ResourceMoverManager.
     */
    public static void moveCollectionsInitiateMove(
        com.azure.resourcemanager.resourcemover.ResourceMoverManager manager) {
        manager
            .moveCollections()
            .initiateMove(
                "rg1",
                "movecollection1",
                new ResourceMoveRequest()
                    .withValidateOnly(false)
                    .withMoveResources(
                        Arrays
                            .asList(
                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1")),
                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 azure.identity import DefaultAzureCredential
from azure.mgmt.resourcemover import ResourceMoverServiceAPI

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resourcemover
# USAGE
    python move_collections_initiate_move.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 = ResourceMoverServiceAPI(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.move_collections.begin_initiate_move(
        resource_group_name="rg1",
        move_collection_name="movecollection1",
    ).result()
    print(response)


# x-ms-original-file: specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2023-08-01/examples/MoveCollections_InitiateMove.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 armresourcemover_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/resourcemover/armresourcemover"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/3066a973f4baf2e2bf072a013b585a820bb10146/specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2023-08-01/examples/MoveCollections_InitiateMove.json
func ExampleMoveCollectionsClient_BeginInitiateMove() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armresourcemover.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewMoveCollectionsClient().BeginInitiateMove(ctx, "rg1", "movecollection1", &armresourcemover.MoveCollectionsClientBeginInitiateMoveOptions{Body: &armresourcemover.ResourceMoveRequest{
		MoveResources: []*string{
			to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1")},
		ValidateOnly: to.Ptr(false),
	},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.OperationStatus = armresourcemover.OperationStatus{
	// 	Name: to.Ptr("1e4193c3-206e-4916-b124-1da16175eb0e"),
	// 	EndTime: to.Ptr("6/17/2020 6:45:56 AM"),
	// 	ID: to.Ptr("/subscriptions/e80eb9fa-c996-4435-aa32-5af6f3d3077c/resourceGroups/RegionMoveRG-southcentralus-southeastasia/providers/Microsoft.Migrate/MoveCollections/MoveCollection-southcentralus-southeastasia/operations/1e4193c3-206e-4916-b124-1da16175eb0e"),
	// 	Properties: map[string]any{
	// 	},
	// 	StartTime: to.Ptr("6/17/2020 6:45:55 AM"),
	// 	Status: to.Ptr("Succeeded"),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

/**
 * This sample demonstrates how to Moves the set of resources included in the request body. The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
 *
 * @summary Moves the set of resources included in the request body. The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
 * x-ms-original-file: specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2023-08-01/examples/MoveCollections_InitiateMove.json
 */
async function moveCollectionsInitiateMove() {
  const subscriptionId = process.env["RESOURCEMOVER_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["RESOURCEMOVER_RESOURCE_GROUP"] || "rg1";
  const moveCollectionName = "movecollection1";
  const body = {
    moveResources: [
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1",
    ],
    validateOnly: false,
  };
  const options = { body };
  const credential = new DefaultAzureCredential();
  const client = new ResourceMoverServiceAPI(credential, subscriptionId);
  const result = await client.moveCollections.beginInitiateMoveAndWait(
    resourceGroupName,
    moveCollectionName,
    options
  );
  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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.ResourceMover;
using Azure.ResourceManager.ResourceMover.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2023-08-01/examples/MoveCollections_InitiateMove.json
// this example is just showing the usage of "MoveCollections_InitiateMove" 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 MoverResourceSetResource created on azure
// for more information of creating MoverResourceSetResource, please refer to the document of MoverResourceSetResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string moverResourceSetName = "movecollection1";
ResourceIdentifier moverResourceSetResourceId = MoverResourceSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, moverResourceSetName);
MoverResourceSetResource moverResourceSet = client.GetMoverResourceSetResource(moverResourceSetResourceId);

// invoke the operation
MoverResourceMoveContent content = new MoverResourceMoveContent(new ResourceIdentifier[]
{
new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1")
})
{
    ValidateOnly = false,
};
ArmOperation<MoverOperationStatus> lro = await moverResourceSet.InitiateMoveAsync(WaitUntil.Completed, content: content);
MoverOperationStatus result = lro.Value;

Console.WriteLine($"Succeeded: {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

{
  "id": "/subscriptions/e80eb9fa-c996-4435-aa32-5af6f3d3077c/resourceGroups/RegionMoveRG-southcentralus-southeastasia/providers/Microsoft.Migrate/MoveCollections/MoveCollection-southcentralus-southeastasia/operations/1e4193c3-206e-4916-b124-1da16175eb0e",
  "name": "1e4193c3-206e-4916-b124-1da16175eb0e",
  "status": "Succeeded",
  "startTime": "6/17/2020 6:45:55 AM",
  "endTime": "6/17/2020 6:45:56 AM",
  "error": null,
  "properties": {}
}

Status code:: 202

Location: https://some.endpoint.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1?api-version=2022-11-01

定義

名前	説明
AffectedMoveResource	RP カスタム操作エラー情報。
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
MoveErrorInfo	カスタムエラー情報の移動。
MoveResourceInputType	移動リソースの入力の種類を定義します。
OperationErrorAdditionalInfo	操作エラー情報。
OperationStatus	操作状態 REST リソース。
OperationStatusError	操作状態エラーのクラス。
OperationStatusProperties	操作結果のプロパティのクラス。
ResourceMoveRequest	リソース移動操作の要求本文を定義します。

AffectedMoveResource

RP カスタム操作エラー情報。

名前	型	説明
id	string	影響を受ける移動リソース ID。
moveResources	AffectedMoveResource[]	影響を受ける移動リソース。
sourceId	string	影響を受ける移動リソースソース ID。

CloudError

サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	クラウドエラー本文。

CloudErrorBody

サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムによって使用されることを意図しています。
details	CloudErrorBody[]	エラーに関するその他の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

MoveErrorInfo

カスタムエラー情報の移動。

名前	型	説明
moveResources	AffectedMoveResource[]	影響を受ける移動リソース。

MoveResourceInputType

移動リソースの入力の種類を定義します。

名前	型	説明
MoveResourceId	string
MoveResourceSourceId	string

OperationErrorAdditionalInfo

操作エラー情報。

名前	型	説明
info	MoveErrorInfo	操作エラー情報。
type	string	エラーの種類。

OperationStatus

操作状態 REST リソース。

名前	型	説明
endTime	string	終了時刻。
error	OperationStatusError	操作のすべてのエラーの詳細を示すエラー。
id	string	リソース ID。
name	string	操作の名前。
properties	OperationStatusProperties	カスタムデータ。
startTime	string	開始時刻。
status	string	操作の状態。 ARM は、ターミナルの状態が Succeeded/Failed/Canceled のいずれかであることを想定しています。その他のすべての値は、操作がまだ実行されていることを意味します。

OperationStatusError

操作状態エラーのクラス。

名前	型	説明
additionalInfo	OperationErrorAdditionalInfo[]	追加情報。
code	string	エラーコード。
details	OperationStatusError[]	エラーの詳細です。
message	string	エラーメッセージ。

OperationStatusProperties

操作結果のプロパティのクラス。

ResourceMoveRequest

リソース移動操作の要求本文を定義します。

名前	型	説明
moveResourceInputType	MoveResourceInputType	移動リソースの入力の種類を定義します。
moveResources	string[]	リソース ID の一覧を取得または設定します。既定では、moveResourceInputType プロパティを使用して入力の種類が切り替えされていない限り、移動リソース ID を受け入れます。
validateOnly	boolean	操作が前提条件のみを実行する必要があるかどうかを示す値を取得または設定します。