Move Collections - List Move Collections By Resource Group

Service:

Resource Mover

API Version:

2023-08-01

Pobierz wszystkie kolekcje przenoszenia.
Pobierz wszystkie kolekcje przenoszenia w grupie zasobów.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Identyfikator subskrypcji.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	MoveCollectionResultList	OK.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

MoveCollections_ListMoveCollectionsByResourceGroup

Sample Request

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 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_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

Sample Response

Status code:

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

Definicje

Nazwa	Opis
CloudError	Odpowiedź błędu z usługi.
CloudErrorBody	Odpowiedź błędu z usługi.
createdByType	Typ tożsamości, która utworzyła zasób.
Errors	Definiuje błędy zasobu przenoszenia.
Identity	Definiuje właściwości msi kolekcji przenoszenia.
MoveCollection	Zdefiniuj kolekcję przenoszenia.
MoveCollectionProperties	Definiuje właściwości kolekcji przenoszenia.
MoveCollectionResultList	Definiuje kolekcję kolekcji przenoszenia.
MoveResourceErrorBody	Odpowiedź na błąd z usługi Azure Migrate.
MoveType	Definiuje typ przenoszenia.
ProvisioningState	Definiuje stany aprowizacji.
ResourceIdentityType	Typ tożsamości używany dla usługi mover zasobu.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

CloudError

Odpowiedź błędu z usługi.

Nazwa	Typ	Opis
error	CloudErrorBody	Treść błędu chmury.

CloudErrorBody

Odpowiedź błędu z usługi.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

Errors

Definiuje błędy zasobu przenoszenia.

Nazwa	Typ	Opis
properties	MoveResourceErrorBody	Treść błędu przenoszenia zasobu.

Identity

Definiuje właściwości msi kolekcji przenoszenia.

Nazwa	Typ	Opis
principalId	string	Pobiera lub ustawia identyfikator podmiotu zabezpieczeń.
tenantId	string	Pobiera lub ustawia identyfikator dzierżawy.
type	ResourceIdentityType	Typ tożsamości używany dla usługi mover zasobu.

MoveCollection

Zdefiniuj kolekcję przenoszenia.

Nazwa	Typ	Opis
etag	string	Element etag zasobu.
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu.
identity	Identity	Definiuje właściwości msi kolekcji przenoszenia.
location	string	Lokalizacja geograficzna, w której znajduje się zasób.
name	string	Nazwa zasobu
properties	MoveCollectionProperties	Definiuje właściwości kolekcji przenoszenia.
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

MoveCollectionProperties

Definiuje właściwości kolekcji przenoszenia.

Nazwa	Typ	Opis
errors	Errors	Definiuje błędy kolekcji przenoszenia.
moveRegion	string	Pobiera lub ustawia region przenoszenia, który wskazuje region, w którym zostanie przeprowadzona migracja regionalna maszyny wirtualnej do strefowej.
moveType	MoveType	Definiuje typ przenoszenia.
provisioningState	ProvisioningState	Definiuje stany aprowizacji.
sourceRegion	string	Pobiera lub ustawia region źródłowy.
targetRegion	string	Pobiera lub ustawia region docelowy.
version	string	Pobiera lub ustawia wersję kolekcji przenoszenia.

MoveCollectionResultList

Definiuje kolekcję kolekcji przenoszenia.

Nazwa	Typ	Opis
nextLink	string	Pobiera wartość następnego linku.
value	MoveCollection[]	Pobiera listę kolekcji przenoszenia.

MoveResourceErrorBody

Odpowiedź na błąd z usługi Azure Migrate.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	MoveResourceErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

MoveType

Definiuje typ przenoszenia.

Nazwa	Typ	Opis
RegionToRegion	string
RegionToZone	string

ProvisioningState

Definiuje stany aprowizacji.

Nazwa	Typ	Opis
Creating	string
Failed	string
Succeeded	string
Updating	string

ResourceIdentityType

Typ tożsamości używany dla usługi mover zasobu.

Nazwa	Typ	Opis
None	string
SystemAssigned	string
UserAssigned	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.