Move Collections - List Move Collections By Resource Group

Service:

Resource Mover

Version d'API:

2023-08-01

Obtenez tous les regroupements de déplacement.
Obtenez tous les regroupements de déplacement dans le groupe de ressources.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
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.

Réponses

Nom	Type	Description
200 OK	MoveCollectionResultList	D’ACCORD.
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

MoveCollections_ListMoveCollectionsByResourceGroup

Exemple de requête

HTTP

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

Java

/**
 * Samples for MoveCollections ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2023-08-01/examples/
     * MoveCollections_ListMoveCollectionsByResourceGroup.json
     */
    /**
     * Sample code: MoveCollections_ListMoveCollectionsByResourceGroup.
     * 
     * @param manager Entry point to ResourceMoverManager.
     */
    public static void moveCollectionsListMoveCollectionsByResourceGroup(
        com.azure.resourcemanager.resourcemover.ResourceMoverManager manager) {
        manager.moveCollections().listByResourceGroup("rg1", 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

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_list_move_collections_by_resource_group.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.list_move_collections_by_resource_group(
        resource_group_name="rg1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2023-08-01/examples/MoveCollections_ListMoveCollectionsByResourceGroup.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/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_ListMoveCollectionsByResourceGroup.json
func ExampleMoveCollectionsClient_NewListMoveCollectionsByResourceGroupPager() {
	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)
	}
	pager := clientFactory.NewMoveCollectionsClient().NewListMoveCollectionsByResourceGroupPager("rg1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.MoveCollectionResultList = armresourcemover.MoveCollectionResultList{
		// 	Value: []*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{
		// 				MoveType: to.Ptr(armresourcemover.MoveTypeRegionToRegion),
		// 				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 Get all the Move Collections in the resource group.
 *
 * @summary Get all the Move Collections in the resource group.
 * x-ms-original-file: specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2023-08-01/examples/MoveCollections_ListMoveCollectionsByResourceGroup.json
 */
async function moveCollectionsListMoveCollectionsByResourceGroup() {
  const subscriptionId = process.env["RESOURCEMOVER_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["RESOURCEMOVER_RESOURCE_GROUP"] || "rg1";
  const credential = new DefaultAzureCredential();
  const client = new ResourceMoverServiceAPI(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.moveCollections.listMoveCollectionsByResourceGroup(
    resourceGroupName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.ResourceMover.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ResourceMover;

// Generated from example definition: specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2023-08-01/examples/MoveCollections_ListMoveCollectionsByResourceGroup.json
// this example is just showing the usage of "MoveCollections_ListMoveCollectionsByResourceGroup" 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 and iterate over the result
await foreach (MoverResourceSetResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Exemple de réponse

Code d’état:

200

{
  "value": [
    {
      "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"
      }
    }
  ]
}

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.
MoveCollectionResultList	Définit la collection de collections de déplacement.
MoveResourceErrorBody	Réponse d’erreur du service Azure Migrate.
MoveType	Définit 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

Object

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Corps de l’erreur cloud.

CloudErrorBody

Object

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 programme.
details	CloudErrorBody[]	Liste des 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

Énumération

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

Valeur	Description
Application
Key
ManagedIdentity
User

Errors

Object

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

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

Identity

Object

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

Object

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

Object

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

Nom	Type	Description
errors	Errors	Définit les erreurs de collecte de déplacement.
moveRegion	string	Obtient ou définit la région de déplacement qui indique la région où la machine virtuelle régionale vers le déplacement zonal sera effectuée.
moveType	MoveType	Définit 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.

MoveCollectionResultList

Object

Définit la collection de collections de déplacement.

Nom	Type	Description
nextLink	string	Obtient la valeur du lien suivant.
value	MoveCollection[]	Obtient la liste des regroupements de déplacement.

MoveResourceErrorBody

Object

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 programme.
details	MoveResourceErrorBody[]	Liste des 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

Énumération

Définit MoveType.

Valeur	Description
RegionToRegion
RegionToZone

ProvisioningState

Énumération

Définit les états d’approvisionnement.

Valeur	Description
Creating
Failed
Succeeded
Updating

ResourceIdentityType

Énumération

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

Valeur	Description
None
SystemAssigned
UserAssigned

systemData

Object

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

Nom	Type	Description
createdAt	string (date-time)	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 (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.