Move Collections - Initiate Move

Riferimento

Service:: Resource Mover

API Version:: 2023-08-01

Sposta il set di risorse incluso nel corpo della richiesta. L'operazione di spostamento viene attivata dopo che moveResources si trova in moveState 'MovePending' o 'MoveFailed', al completamento di moveResource moveState eseguire una transizione a CommitPending. Per consentire all'utente di eseguire il prerequisito dell'operazione, il client può chiamare l'operazione con la proprietà validateOnly impostata su true.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
moveCollectionName	path	True	string	Nome raccolta di spostamento.
resourceGroupName	path	True	string	Nome del gruppo di risorse.
subscriptionId	path	True	string	ID sottoscrizione.
api-version	query	True	string	Versione api client.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
moveResources	True	string[]	Ottiene o imposta l'elenco di ID risorsa, per impostazione predefinita accetta l'ID risorsa di spostamento, a meno che il tipo di input non venga cambiato tramite la proprietà moveResourceInputType.
moveResourceInputType		MoveResourceInputType	Definisce il tipo di input della risorsa di spostamento.
validateOnly		boolean	Ottiene o imposta un valore che indica se l'operazione deve eseguire solo i prerequisiti.

Risposte

Nome	Tipo	Descrizione
200 OK	OperationStatus	OK
202 Accepted		Accettato
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
AffectedMoveResource	Informazioni sull'errore dell'operazione personalizzata RP.
CloudError	Risposta di errore dal servizio.
CloudErrorBody	Risposta di errore dal servizio.
MoveErrorInfo	Informazioni di errore personalizzate di spostamento.
MoveResourceInputType	Definisce il tipo di input della risorsa di spostamento.
OperationErrorAdditionalInfo	Informazioni sull'errore dell'operazione.
OperationStatus	Risorsa REST dello stato dell'operazione.
OperationStatusError	Classe per gli errori di stato dell'operazione.
OperationStatusProperties	Classe per le proprietà dei risultati dell'operazione.
ResourceMoveRequest	Definisce il corpo della richiesta per l'operazione di spostamento delle risorse.

AffectedMoveResource

Informazioni sull'errore dell'operazione personalizzata RP.

Nome	Tipo	Descrizione
id	string	ID risorsa di spostamento interessato.
moveResources	AffectedMoveResource[]	Risorse di spostamento interessate.
sourceId	string	ID origine della risorsa di spostamento interessato.

CloudError

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	CloudErrorBody	Corpo dell'errore cloud.

CloudErrorBody

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, che deve essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in errore.

MoveErrorInfo

Informazioni di errore personalizzate di spostamento.

Nome	Tipo	Descrizione
moveResources	AffectedMoveResource[]	Risorse di spostamento interessate.

MoveResourceInputType

Definisce il tipo di input della risorsa di spostamento.

Nome	Tipo	Descrizione
MoveResourceId	string
MoveResourceSourceId	string

OperationErrorAdditionalInfo

Informazioni sull'errore dell'operazione.

Nome	Tipo	Descrizione
info	MoveErrorInfo	Informazioni sull'errore dell'operazione.
type	string	Tipo di errore.

OperationStatus

Risorsa REST dello stato dell'operazione.

Nome	Tipo	Descrizione
endTime	string	Ora di fine.
error	OperationStatusError	Errore che indica tutti i dettagli dell'errore per l'operazione.
id	string	ID risorsa.
name	string	Nome operazione.
properties	OperationStatusProperties	Dati personalizzati.
startTime	string	Ora di inizio.
status	string	Stato dell'operazione. Arm prevede che lo stato del terminale sia riuscito/Non riuscito/Annullato. Tutti gli altri valori implicano che l'operazione è ancora in esecuzione.

OperationStatusError

Classe per gli errori di stato dell'operazione.

Nome	Tipo	Descrizione
additionalInfo	OperationErrorAdditionalInfo[]	Informazioni aggiuntive.
code	string	Codice di errore.
details	OperationStatusError[]	Dettagli dell'errore.
message	string	Messaggio di errore.

OperationStatusProperties

Classe per le proprietà dei risultati dell'operazione.

ResourceMoveRequest

Definisce il corpo della richiesta per l'operazione di spostamento delle risorse.

Nome	Tipo	Descrizione
moveResourceInputType	MoveResourceInputType	Definisce il tipo di input della risorsa di spostamento.
moveResources	string[]	Ottiene o imposta l'elenco di ID risorsa, per impostazione predefinita accetta l'ID risorsa di spostamento, a meno che il tipo di input non venga cambiato tramite la proprietà moveResourceInputType.
validateOnly	boolean	Ottiene o imposta un valore che indica se l'operazione deve eseguire solo i prerequisiti.