Move Collections - Create

Service:

Resource Mover

API Version:

2023-08-01

이동 컬렉션을 만들거나 업데이트합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
moveCollectionName	path	True	string	이동 컬렉션 이름입니다.
resourceGroupName	path	True	string	리소스 그룹 이름입니다.
subscriptionId	path	True	string	구독 ID입니다.
api-version	query	True	string	클라이언트 API 버전.

요청 본문

Name	형식	Description
identity	Identity	이동 컬렉션의 MSI 속성을 정의합니다.
location	string	리소스가 있는 지리적 위치입니다.
properties	MoveCollectionProperties	이동 컬렉션 속성을 정의합니다.
tags	object	리소스 태그.

응답

Name	형식	Description
200 OK	MoveCollection	성공
201 Created	MoveCollection	Success
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

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	사용자 계정 가장

예제

MoveCollections_Create

Sample Request

HTTP

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

{
  "location": "eastus2",
  "properties": {
    "sourceRegion": "eastus",
    "targetRegion": "westus",
    "moveType": "RegionToRegion"
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

Java

import com.azure.resourcemanager.resourcemover.models.Identity;
import com.azure.resourcemanager.resourcemover.models.MoveCollectionProperties;
import com.azure.resourcemanager.resourcemover.models.MoveType;
import com.azure.resourcemanager.resourcemover.models.ResourceIdentityType;

/** Samples for MoveCollections Create. */
public final class Main {
    /*
     * x-ms-original-file: specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2023-08-01/examples/MoveCollections_Create.json
     */
    /**
     * Sample code: MoveCollections_Create.
     *
     * @param manager Entry point to ResourceMoverManager.
     */
    public static void moveCollectionsCreate(com.azure.resourcemanager.resourcemover.ResourceMoverManager manager) {
        manager
            .moveCollections()
            .define("movecollection1")
            .withRegion("eastus2")
            .withExistingResourceGroup("rg1")
            .withIdentity(new Identity().withType(ResourceIdentityType.SYSTEM_ASSIGNED))
            .withProperties(
                new MoveCollectionProperties()
                    .withSourceRegion("eastus")
                    .withTargetRegion("westus")
                    .withMoveType(MoveType.REGION_TO_REGION))
            .create();
    }
}

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.resourcemover import ResourceMoverServiceAPI

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resourcemover
# USAGE
    python move_collections_create.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.create(
        resource_group_name="rg1",
        move_collection_name="movecollection1",
    )
    print(response)


# x-ms-original-file: specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2023-08-01/examples/MoveCollections_Create.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 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_Create.json
func ExampleMoveCollectionsClient_Create() {
	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)
	}
	res, err := clientFactory.NewMoveCollectionsClient().Create(ctx, "rg1", "movecollection1", &armresourcemover.MoveCollectionsClientCreateOptions{Body: &armresourcemover.MoveCollection{
		Identity: &armresourcemover.Identity{
			Type: to.Ptr(armresourcemover.ResourceIdentityTypeSystemAssigned),
		},
		Location: to.Ptr("eastus2"),
		Properties: &armresourcemover.MoveCollectionProperties{
			MoveType:     to.Ptr(armresourcemover.MoveTypeRegionToRegion),
			SourceRegion: to.Ptr("eastus"),
			TargetRegion: to.Ptr("westus"),
		},
	},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %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.MoveCollection = armresourcemover.MoveCollection{
	// 	Name: to.Ptr("movecollection1"),
	// 	Type: to.Ptr("Microsoft.Migrate/MoveCollections"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1"),
	// 	Identity: &armresourcemover.Identity{
	// 		Type: to.Ptr(armresourcemover.ResourceIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("7488fa50-1c8e-42c4-a117-38c8d05d8b72"),
	// 		TenantID: to.Ptr("cc7e5736-dbba-4059-a621-664eab9c1d80"),
	// 	},
	// 	Location: to.Ptr("United States"),
	// 	Properties: &armresourcemover.MoveCollectionProperties{
	// 		ProvisioningState: to.Ptr(armresourcemover.ProvisioningStateSucceeded),
	// 		SourceRegion: to.Ptr("eastus"),
	// 		TargetRegion: to.Ptr("westus"),
	// 		Version: to.Ptr("V1"),
	// 	},
	// 	SystemData: &armresourcemover.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-29T15:06:54.275Z"); return t}()),
	// 		CreatedBy: to.Ptr("user@microsoft.com"),
	// 		CreatedByType: to.Ptr(armresourcemover.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-29T15:06:54.275Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user@microsoft.com"),
	// 		LastModifiedByType: to.Ptr(armresourcemover.CreatedByTypeUser),
	// 	},
	// }
}

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 { ResourceMoverServiceAPI } = require("@azure/arm-resourcemover");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a move collection.
 *
 * @summary Creates or updates a move collection.
 * x-ms-original-file: specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2023-08-01/examples/MoveCollections_Create.json
 */
async function moveCollectionsCreate() {
  const subscriptionId = process.env["RESOURCEMOVER_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["RESOURCEMOVER_RESOURCE_GROUP"] || "rg1";
  const moveCollectionName = "movecollection1";
  const body = {
    identity: { type: "SystemAssigned" },
    location: "eastus2",
    properties: {
      moveType: "RegionToRegion",
      sourceRegion: "eastus",
      targetRegion: "westus",
    },
  };
  const options = { body };
  const credential = new DefaultAzureCredential();
  const client = new ResourceMoverServiceAPI(credential, subscriptionId);
  const result = await client.moveCollections.create(
    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

dotnet

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_Create.json
// this example is just showing the usage of "MoveCollections_Create" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this MoverResourceSetResource
MoverResourceSetCollection collection = resourceGroupResource.GetMoverResourceSets();

// invoke the operation
string moverResourceSetName = "movecollection1";
MoverResourceSetData data = new MoverResourceSetData(new AzureLocation("eastus2"))
{
    Identity = new ManagedServiceIdentity("SystemAssigned"),
    Properties = new MoverResourceSetProperties()
    {
        SourceLocation = new AzureLocation("eastus"),
        TargetLocation = new AzureLocation("westus"),
        MoveType = MoveType.RegionToRegion,
    },
};
ArmOperation<MoverResourceSetResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, moverResourceSetName, data);
MoverResourceSetResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MoverResourceSetData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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:

201

{
  "name": "movecollection1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1",
  "type": "Microsoft.Migrate/MoveCollections",
  "location": "United States",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "7488fa50-1c8e-42c4-a117-38c8d05d8b72",
    "tenantId": "cc7e5736-dbba-4059-a621-664eab9c1d80"
  },
  "properties": {
    "sourceRegion": "eastus",
    "targetRegion": "westus",
    "provisioningState": "Succeeded",
    "version": "V1",
    "moveType": "RegionToRegion"
  },
  "systemData": {
    "createdBy": "user@microsoft.com",
    "createdByType": "User",
    "createdAt": "2021-08-29T15:06:54.2757906Z",
    "lastModifiedBy": "user@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-29T15:06:54.2757906Z"
  }
}

Status code:

200

{
  "name": "movecollection1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1",
  "type": "Microsoft.Migrate/MoveCollections",
  "location": "United States",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "7488fa50-1c8e-42c4-a117-38c8d05d8b72",
    "tenantId": "cc7e5736-dbba-4059-a621-664eab9c1d80"
  },
  "properties": {
    "sourceRegion": "eastus",
    "targetRegion": "westus",
    "provisioningState": "Succeeded",
    "version": "V1"
  },
  "systemData": {
    "createdBy": "user@microsoft.com",
    "createdByType": "User",
    "createdAt": "2021-08-29T15:06:54.2757906Z",
    "lastModifiedBy": "user@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-29T15:06:54.2757906Z"
  }
}

정의

Name	Description
CloudError	서비스의 오류 응답입니다.
CloudErrorBody	서비스의 오류 응답입니다.
createdByType	리소스를 만든 ID 유형입니다.
Errors	리소스 이동 오류를 정의합니다.
Identity	이동 컬렉션의 MSI 속성을 정의합니다.
MoveCollection	이동 컬렉션을 정의합니다.
MoveCollectionProperties	이동 컬렉션 속성을 정의합니다.
MoveResourceErrorBody	Azure Migrate 서비스의 오류 응답입니다.
MoveType	MoveType을 정의합니다.
ProvisioningState	프로비전 상태를 정의합니다.
ResourceIdentityType	리소스 이동기 서비스에 사용되는 ID 유형입니다.
systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

CloudError

서비스의 오류 응답입니다.

Name	형식	Description
error	CloudErrorBody	클라우드 오류 본문.

CloudErrorBody

서비스의 오류 응답입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
details	CloudErrorBody[]	오류에 대한 추가 세부 정보 목록입니다.
message	string	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.
target	string	특정 오류의 대상입니다. 예를 들어 오류에 있는 속성의 이름입니다.

createdByType

리소스를 만든 ID 유형입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Errors

리소스 이동 오류를 정의합니다.

Name	형식	Description
properties	MoveResourceErrorBody	리소스 이동 오류 본문입니다.

Identity

이동 컬렉션의 MSI 속성을 정의합니다.

Name	형식	Description
principalId	string	보안 주체 ID를 가져오거나 설정합니다.
tenantId	string	테넌트 ID를 가져오거나 설정합니다.
type	ResourceIdentityType	리소스 이동기 서비스에 사용되는 ID 유형입니다.

MoveCollection

이동 컬렉션을 정의합니다.

Name	형식	Description
etag	string	리소스의 etag입니다.
id	string	리소스에 대한 정규화된 리소스 ID입니다.
identity	Identity	이동 컬렉션의 MSI 속성을 정의합니다.
location	string	리소스가 있는 지리적 위치입니다.
name	string	리소스의 이름입니다.
properties	MoveCollectionProperties	이동 컬렉션 속성을 정의합니다.
systemData	systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
tags	object	리소스 태그.
type	string	리소스 형식입니다.

MoveCollectionProperties

이동 컬렉션 속성을 정의합니다.

Name	형식	Description
errors	Errors	이동 컬렉션 오류를 정의합니다.
moveRegion	string	VM 지역 간 이동이 수행될 지역을 나타내는 이동 지역을 가져오거나 설정합니다.
moveType	MoveType	MoveType을 정의합니다.
provisioningState	ProvisioningState	프로비전 상태를 정의합니다.
sourceRegion	string	원본 지역을 가져오거나 설정합니다.
targetRegion	string	대상 지역을 가져오거나 설정합니다.
version	string	이동 컬렉션의 버전을 가져오거나 설정합니다.

MoveResourceErrorBody

Azure Migrate 서비스의 오류 응답입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
details	MoveResourceErrorBody[]	오류에 대한 추가 세부 정보 목록입니다.
message	string	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.
target	string	특정 오류의 대상입니다. 예를 들어 오류에 있는 속성의 이름입니다.

MoveType

MoveType을 정의합니다.

Name	형식	Description
RegionToRegion	string
RegionToZone	string

ProvisioningState

프로비전 상태를 정의합니다.

Name	형식	Description
Creating	string
Failed	string
Succeeded	string
Updating	string

ResourceIdentityType

리소스 이동기 서비스에 사용되는 ID 유형입니다.

Name	형식	Description
None	string
SystemAssigned	string
UserAssigned	string

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID 유형입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.