Move Collections - Create

Service:

Resource Mover

API Version:

2023-08-01

Crée ou met à jour une collection de déplacement.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
moveCollectionName	path	True	string	Nom de la collection Move.
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	ID d’abonnement.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
identity	Identity	Définit les propriétés MSI de la collection Move.
location	string	Emplacement géographique où réside la ressource.
properties	MoveCollectionProperties	Définit les propriétés de la collection de déplacement.
tags	object	Balises de ressource.

Réponses

Nom	Type	Description
200 OK	MoveCollection	Opération réussie
201 Created	MoveCollection	Succès
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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"
  }
}

Définitions

Nom	Description
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
createdByType	Type d’identité qui a créé la ressource.
Errors	Définit les erreurs de déplacement des ressources.
Identity	Définit les propriétés MSI de la collection Move.
MoveCollection	Définissez la collection de déplacement.
MoveCollectionProperties	Définit les propriétés de la collection de déplacement.
MoveResourceErrorBody	Réponse d’erreur du service Azure Migrate.
MoveType	Définit le MoveType.
ProvisioningState	Définit les états d’approvisionnement.
ResourceIdentityType	Type d’identité utilisé pour le service de déplacement de ressources.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

CloudError

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Corps d’erreur cloud.

CloudErrorBody

Réponse d’erreur du service.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
details	CloudErrorBody[]	Liste de détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Errors

Définit les erreurs de déplacement des ressources.

Nom	Type	Description
properties	MoveResourceErrorBody	Corps d’erreur de la ressource de déplacement.

Identity

Définit les propriétés MSI de la collection Move.

Nom	Type	Description
principalId	string	Obtient ou définit l’ID du principal.
tenantId	string	Obtient ou définit l’ID de locataire.
type	ResourceIdentityType	Type d’identité utilisé pour le service de déplacement de ressources.

MoveCollection

Définissez la collection de déplacement.

Nom	Type	Description
etag	string	Etag de la ressource.
id	string	ID de ressource complet pour la ressource.
identity	Identity	Définit les propriétés MSI de la collection Move.
location	string	Emplacement géographique où réside la ressource.
name	string	nom de la ressource.
properties	MoveCollectionProperties	Définit les propriétés de la collection de déplacement.
systemData	systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
tags	object	Balises de ressource.
type	string	Type de la ressource.

MoveCollectionProperties

Définit les propriétés de la collection de déplacement.

Nom	Type	Description
errors	Errors	Définit les erreurs de la collection de déplacement.
moveRegion	string	Obtient ou définit la région de déplacement qui indique la région où le déplacement régional vers zonale de machine virtuelle sera effectué.
moveType	MoveType	Définit le MoveType.
provisioningState	ProvisioningState	Définit les états d’approvisionnement.
sourceRegion	string	Obtient ou définit la région source.
targetRegion	string	Obtient ou définit la région cible.
version	string	Obtient ou définit la version de la collection de déplacement.

MoveResourceErrorBody

Réponse d’erreur du service Azure Migrate.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
details	MoveResourceErrorBody[]	Liste de détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

MoveType

Définit le MoveType.

Nom	Type	Description
RegionToRegion	string
RegionToZone	string

ProvisioningState

Définit les états d’approvisionnement.

Nom	Type	Description
Creating	string
Failed	string
Succeeded	string
Updating	string

ResourceIdentityType

Type d’identité utilisé pour le service de déplacement de ressources.

Nom	Type	Description
None	string
SystemAssigned	string
UserAssigned	string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.