Move Collections - Discard

Servicio:

Resource Mover

Versión de la API:

2023-08-01

Descarta el conjunto de recursos incluidos en el cuerpo de la solicitud. La operación de descarte se desencadena en moveResources en moveState 'CommitPending' o 'DiscardFailed', en una finalización correcta de moveResource moveState realiza una transición a MovePending. Para ayudar al usuario a requisitos previos de la operación, el cliente puede llamar a la operación con la propiedad validateOnly establecida en true.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
moveCollectionName	path	True	string	Nombre de la colección move.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Identificador de suscripción.
api-version	query	True	string	Versión de api de cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
moveResources	True	string[]	Obtiene o establece la lista de identificadores de recurso, de forma predeterminada acepta mover el identificador de recurso a menos que el tipo de entrada se cambie a través de la propiedad moveResourceInputType.
moveResourceInputType		MoveResourceInputType	Define el tipo de entrada de recurso de movimiento.
validateOnly		boolean	Obtiene o establece un valor que indica si la operación solo debe ejecutarse como requisito previo.

Respuestas

Nombre	Tipo	Description
200 OK	OperationStatus	De acuerdo
202 Accepted		Aceptado
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

MoveCollections_Discard

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/moveCollections/movecollection1/discard?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.DiscardRequest;
import java.util.Arrays;

/**
 * Samples for MoveCollections Discard.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2023-08-01/examples/MoveCollections_Discard
     * .json
     */
    /**
     * Sample code: MoveCollections_Discard.
     * 
     * @param manager Entry point to ResourceMoverManager.
     */
    public static void moveCollectionsDiscard(com.azure.resourcemanager.resourcemover.ResourceMoverManager manager) {
        manager.moveCollections().discard("rg1", "movecollection1",
            new DiscardRequest().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_discard.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_discard(
        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_Discard.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_Discard.json
func ExampleMoveCollectionsClient_BeginDiscard() {
	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().BeginDiscard(ctx, "rg1", "movecollection1", &armresourcemover.MoveCollectionsClientBeginDiscardOptions{Body: &armresourcemover.DiscardRequest{
		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 Discards the set of resources included in the request body. The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
 *
 * @summary Discards the set of resources included in the request body. The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. 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_Discard.json
 */
async function moveCollectionsDiscard() {
  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.beginDiscardAndWait(
    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_Discard.json
// this example is just showing the usage of "MoveCollections_Discard" 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
MoverDiscardContent content = new MoverDiscardContent(new ResourceIdentifier[] { new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1") })
{
    ValidateOnly = false,
};
ArmOperation<MoverOperationStatus> lro = await moverResourceSet.DiscardAsync(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

Respuesta de muestra

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

Definiciones

Nombre	Description
AffectedMoveResource	Información de error de la operación personalizada de RP.
CloudError	Respuesta de error del servicio.
CloudErrorBody	Respuesta de error del servicio.
DiscardRequest	Define el cuerpo de la solicitud para la operación de descarte.
MoveErrorInfo	Información de error personalizada de movimiento.
MoveResourceInputType	Define el tipo de entrada de recurso de movimiento.
OperationErrorAdditionalInfo	Información de error de la operación.
OperationStatus	Recurso REST de estado de la operación.
OperationStatusError	Clase para errores de estado de operación.
OperationStatusProperties	Clase para las propiedades del resultado de la operación.

AffectedMoveResource

Object

Información de error de la operación personalizada de RP.

Nombre	Tipo	Description
id	string	Identificador de recurso de movimiento afectado.
moveResources	AffectedMoveResource[]	Los recursos de movimiento afectados.
sourceId	string	Identificador de origen del recurso de movimiento afectado.

CloudError

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
error	CloudErrorBody	Cuerpo del error en la nube.

CloudErrorBody

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

DiscardRequest

Object

Define el cuerpo de la solicitud para la operación de descarte.

Nombre	Tipo	Description
moveResourceInputType	MoveResourceInputType	Define el tipo de entrada de recurso de movimiento.
moveResources	string[]	Obtiene o establece la lista de identificadores de recurso, de forma predeterminada acepta mover el identificador de recurso a menos que el tipo de entrada se cambie a través de la propiedad moveResourceInputType.
validateOnly	boolean	Obtiene o establece un valor que indica si la operación solo debe ejecutarse como requisito previo.

MoveErrorInfo

Object

Información de error personalizada de movimiento.

Nombre	Tipo	Description
moveResources	AffectedMoveResource[]	Los recursos de movimiento afectados.

MoveResourceInputType

Enumeración

Define el tipo de entrada de recurso de movimiento.

Valor	Description
MoveResourceId
MoveResourceSourceId

OperationErrorAdditionalInfo

Object

Información de error de la operación.

Nombre	Tipo	Description
info	MoveErrorInfo	Información de error de la operación.
type	string	Tipo de error.

OperationStatus

Object

Recurso REST de estado de la operación.

Nombre	Tipo	Description
endTime	string	Hora de finalización.
error	OperationStatusError	Error que indica todos los detalles del error para la operación.
id	string	Identificador de recurso.
name	string	Nombre de la operación.
properties	OperationStatusProperties	Datos personalizados.
startTime	string	Hora de comienzo.
status	string	Estado de la operación. ARM espera que el estado del terminal sea correcto, con errores o cancelados. Todos los demás valores implican que la operación todavía se está ejecutando.

OperationStatusError

Object

Clase para errores de estado de operación.

Nombre	Tipo	Description
additionalInfo	OperationErrorAdditionalInfo[]	Información adicional.
code	string	Código de error.
details	OperationStatusError[]	Detalles del error.
message	string	Mensaje de error.

OperationStatusProperties

Object

Clase para las propiedades del resultado de la operación.