Move Collections - Bulk Remove

Serviço:

Resource Mover

Versão da API:

2023-08-01

Remove o conjunto de recursos de movimentação incluídos no corpo da solicitação da coleção de movimentação. A orquestração é feita por serviço. Para ajudar o usuário a pré-requisitos da operação, o cliente pode chamar a operação com a propriedade validateOnly definida como true.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
moveCollectionName	path	True	string
resourceGroupName	path	True	string
subscriptionId	path	True	string	A ID da assinatura.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
moveResourceInputType	MoveResourceInputType	Define o tipo de entrada de recurso de movimentação.
moveResources	string[]	Obtém ou define a lista de IDs de recurso, por padrão, ele aceita mover ids de recurso, a menos que o tipo de entrada seja alternado por meio da propriedade moveResourceInputType.
validateOnly	boolean	Obtém ou define um valor que indica se a operação precisa executar apenas o pré-requisito.

Respostas

Nome	Tipo	Description
200 OK	OperationStatus	OKEY
202 Accepted		Aceitado
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

MoveCollections_BulkRemove

Solicitação de exemplo

HTTP

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

{
  "validateOnly": false,
  "moveResources": [
    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1"
  ]
}

Java

import com.azure.resourcemanager.resourcemover.models.BulkRemoveRequest;
import java.util.Arrays;

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

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_bulk_remove.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_bulk_remove(
        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_BulkRemove.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_BulkRemove.json
func ExampleMoveCollectionsClient_BeginBulkRemove() {
	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().BeginBulkRemove(ctx, "rg1", "movecollection1", &armresourcemover.MoveCollectionsClientBeginBulkRemoveOptions{Body: &armresourcemover.BulkRemoveRequest{
		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

JavaScript

const { ResourceMoverServiceAPI } = require("@azure/arm-resourcemover");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Removes the set of move resources included in the request body from move collection. The orchestration is done by service. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
 *
 * @summary Removes the set of move resources included in the request body from move collection. The orchestration is done by service. 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_BulkRemove.json
 */
async function moveCollectionsBulkRemove() {
  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.beginBulkRemoveAndWait(
    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 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.ResourceMover;

// Generated from example definition: specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2023-08-01/examples/MoveCollections_BulkRemove.json
// this example is just showing the usage of "MoveCollections_BulkRemove" 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
MoverBulkRemoveContent content = new MoverBulkRemoveContent
{
    ValidateOnly = false,
    MoverResources = { new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1") },
};
ArmOperation<MoverOperationStatus> lro = await moverResourceSet.BulkRemoveAsync(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

Resposta de exemplo

Código de status:

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

Código de status:

202

Location: https://some.endpoint.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1?api-version=2022-11-01

Definições

Nome	Description
AffectedMoveResource	As informações de erro da operação personalizada rp.
BulkRemoveRequest	Define o corpo da solicitação para a remoção em massa da operação de movimentação de recursos.
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
MoveErrorInfo	As informações de erro personalizadas de movimentação.
MoveResourceInputType	Define o tipo de entrada de recurso de movimentação.
OperationErrorAdditionalInfo	As informações de erro da operação.
OperationStatus	Recurso REST de status da operação.
OperationStatusError	Classe para erros de status da operação.
OperationStatusProperties	Classe para propriedades de resultado da operação.

AffectedMoveResource

Objeto

As informações de erro da operação personalizada rp.

Nome	Tipo	Description
id	string	A ID do recurso de movimentação afetada.
moveResources	AffectedMoveResource[]	Os recursos de movimentação afetados.
sourceId	string	A ID de origem do recurso de movimentação afetada.

BulkRemoveRequest

Objeto

Define o corpo da solicitação para a remoção em massa da operação de movimentação de recursos.

Nome	Tipo	Description
moveResourceInputType	MoveResourceInputType	Define o tipo de entrada de recurso de movimentação.
moveResources	string[]	Obtém ou define a lista de IDs de recurso, por padrão, ele aceita mover ids de recurso, a menos que o tipo de entrada seja alternado por meio da propriedade moveResourceInputType.
validateOnly	boolean	Obtém ou define um valor que indica se a operação precisa executar apenas o pré-requisito.

CloudError

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	CloudErrorBody	Corpo do erro de nuvem.

CloudErrorBody

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

MoveErrorInfo

Objeto

As informações de erro personalizadas de movimentação.

Nome	Tipo	Description
moveResources	AffectedMoveResource[]	Os recursos de movimentação afetados.

MoveResourceInputType

Enumeração

Define o tipo de entrada de recurso de movimentação.

Valor	Description
MoveResourceId
MoveResourceSourceId

OperationErrorAdditionalInfo

Objeto

As informações de erro da operação.

Nome	Tipo	Description
info	MoveErrorInfo	As informações de erro da operação.
type	string	O tipo de erro.

OperationStatus

Objeto

Recurso REST de status da operação.

Nome	Tipo	Description
endTime	string	Hora de término.
error	OperationStatusError	Erro ao indicar todos os detalhes do erro para a operação.
id	string	ID do recurso.
name	string	Nome da operação.
properties	OperationStatusProperties	Dados personalizados.
startTime	string	Hora de início.
status	string	Status da operação. O ARM espera que o status do terminal seja de êxito/ com falha/cancelado. Todos os outros valores implicam que a operação ainda está em execução.

OperationStatusError

Objeto

Classe para erros de status da operação.

Nome	Tipo	Description
additionalInfo	OperationErrorAdditionalInfo[]	As informações adicionais.
code	string	O código de erro.
details	OperationStatusError[]	Os detalhes do erro.
message	string	A mensagem de erro.

OperationStatusProperties

Objeto

Classe para propriedades de resultado da operação.