MoveCollections Interface

Package:

com.azure.resourcemanager.resourcemover.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-resourcemover:1.2.0

public interface MoveCollections

Resource collection API of MoveCollections.

Method Summary

Modifier and Type	Method and Description
abstract OperationStatus	bulkRemove(String resourceGroupName, String moveCollectionName) Removes the set of move resources included in the request body from move collection.
abstract OperationStatus	bulkRemove(String resourceGroupName, String moveCollectionName, BulkRemoveRequest body, Context context) Removes the set of move resources included in the request body from move collection.
abstract OperationStatus	commit(String resourceGroupName, String moveCollectionName) Commits the set of resources included in the request body.
abstract OperationStatus	commit(String resourceGroupName, String moveCollectionName, CommitRequest body, Context context) Commits the set of resources included in the request body.
abstract Blank	define(String name) Begins definition for a new MoveCollection resource.
abstract OperationStatus	delete(String resourceGroupName, String moveCollectionName, Context context) Deletes a move collection.
abstract OperationStatus	deleteById(String id) Deletes a move collection.
abstract OperationStatus	deleteByIdWithResponse(String id, Context context) Deletes a move collection.
abstract OperationStatus	deleteByResourceGroup(String resourceGroupName, String moveCollectionName) Deletes a move collection.
abstract OperationStatus	discard(String resourceGroupName, String moveCollectionName) Discards the set of resources included in the request body.
abstract OperationStatus	discard(String resourceGroupName, String moveCollectionName, DiscardRequest body, Context context) Discards the set of resources included in the request body.
abstract MoveCollection	getById(String id) Gets the move collection.
abstract Response<MoveCollection>	getByIdWithResponse(String id, Context context) Gets the move collection.
abstract MoveCollection	getByResourceGroup(String resourceGroupName, String moveCollectionName) Gets the move collection.
abstract Response<MoveCollection>	getByResourceGroupWithResponse(String resourceGroupName, String moveCollectionName, Context context) Gets the move collection.
abstract OperationStatus	initiateMove(String resourceGroupName, String moveCollectionName) Moves the set of resources included in the request body.
abstract OperationStatus	initiateMove(String resourceGroupName, String moveCollectionName, ResourceMoveRequest body, Context context) Moves the set of resources included in the request body.
abstract PagedIterable<MoveCollection>	list() Get all Move Collections.
abstract PagedIterable<MoveCollection>	list(Context context) Get all Move Collections.
abstract PagedIterable<MoveCollection>	listByResourceGroup(String resourceGroupName) Get all Move Collections.
abstract PagedIterable<MoveCollection>	listByResourceGroup(String resourceGroupName, Context context) Get all Move Collections.
abstract RequiredForResourcesCollection	listRequiredFor(String resourceGroupName, String moveCollectionName, String sourceId) List of the move resources for which an arm resource is required for.
abstract Response<RequiredForResourcesCollection>	listRequiredForWithResponse(String resourceGroupName, String moveCollectionName, String sourceId, Context context) List of the move resources for which an arm resource is required for.
abstract OperationStatus	prepare(String resourceGroupName, String moveCollectionName) Initiates prepare for the set of resources included in the request body.
abstract OperationStatus	prepare(String resourceGroupName, String moveCollectionName, PrepareRequest body, Context context) Initiates prepare for the set of resources included in the request body.
abstract OperationStatus	resolveDependencies(String resourceGroupName, String moveCollectionName) Computes, resolves and validate the dependencies of the moveResources in the move collection.
abstract OperationStatus	resolveDependencies(String resourceGroupName, String moveCollectionName, Context context) Computes, resolves and validate the dependencies of the moveResources in the move collection.

Method Details

bulkRemove

public abstract OperationStatus bulkRemove(String resourceGroupName, String moveCollectionName)

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.

Parameters:

resourceGroupName - The resourceGroupName parameter.

moveCollectionName - The moveCollectionName parameter.

Returns:

operation status REST resource.

bulkRemove

public abstract OperationStatus bulkRemove(String resourceGroupName, String moveCollectionName, BulkRemoveRequest body, Context context)

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.

Parameters:

resourceGroupName - The resourceGroupName parameter.

moveCollectionName - The moveCollectionName parameter.

body - The body parameter.

context - The context to associate with this operation.

Returns:

operation status REST resource.

commit

public abstract OperationStatus commit(String resourceGroupName, String moveCollectionName)

Commits the set of resources included in the request body. The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

Returns:

operation status REST resource.

commit

public abstract OperationStatus commit(String resourceGroupName, String moveCollectionName, CommitRequest body, Context context)

Commits the set of resources included in the request body. The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

body - The body parameter.

context - The context to associate with this operation.

Returns:

operation status REST resource.

define

public abstract MoveCollection.DefinitionStages.Blank define(String name)

Begins definition for a new MoveCollection resource.

Parameters:

name - resource name.

Returns:

the first stage of the new MoveCollection definition.

delete

public abstract OperationStatus delete(String resourceGroupName, String moveCollectionName, Context context)

Deletes a move collection.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

context - The context to associate with this operation.

Returns:

operation status REST resource.

deleteById

public abstract OperationStatus deleteById(String id)

Deletes a move collection.

Parameters:

id - the resource ID.

Returns:

operation status REST resource.

deleteByIdWithResponse

public abstract OperationStatus deleteByIdWithResponse(String id, Context context)

Deletes a move collection.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

operation status REST resource.

deleteByResourceGroup

public abstract OperationStatus deleteByResourceGroup(String resourceGroupName, String moveCollectionName)

Deletes a move collection.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

Returns:

operation status REST resource.

discard

public abstract OperationStatus discard(String resourceGroupName, String moveCollectionName)

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.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

Returns:

operation status REST resource.

discard

public abstract OperationStatus discard(String resourceGroupName, String moveCollectionName, DiscardRequest body, Context context)

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.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

body - The body parameter.

context - The context to associate with this operation.

Returns:

operation status REST resource.

getById

public abstract MoveCollection getById(String id)

Gets the move collection.

Parameters:

id - the resource ID.

Returns:

the move collection along with Response<T>.

getByIdWithResponse

public abstract Response<MoveCollection> getByIdWithResponse(String id, Context context)

Gets the move collection.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the move collection along with Response<T>.

getByResourceGroup

public abstract MoveCollection getByResourceGroup(String resourceGroupName, String moveCollectionName)

Gets the move collection.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

Returns:

the move collection.

getByResourceGroupWithResponse

public abstract Response<MoveCollection> getByResourceGroupWithResponse(String resourceGroupName, String moveCollectionName, Context context)

Gets the move collection.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

context - The context to associate with this operation.

Returns:

the move collection along with Response<T>.

initiateMove

public abstract OperationStatus initiateMove(String resourceGroupName, String moveCollectionName)

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.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

Returns:

operation status REST resource.

initiateMove

public abstract OperationStatus initiateMove(String resourceGroupName, String moveCollectionName, ResourceMoveRequest body, Context context)

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.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

body - The body parameter.

context - The context to associate with this operation.

Returns:

operation status REST resource.

list

public abstract PagedIterable<MoveCollection> list()

Get all Move Collections. Get all the Move Collections in the subscription.

Returns:

all the Move Collections in the subscription as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<MoveCollection> list(Context context)

Get all Move Collections. Get all the Move Collections in the subscription.

Parameters:

context - The context to associate with this operation.

Returns:

all the Move Collections in the subscription as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<MoveCollection> listByResourceGroup(String resourceGroupName)

Get all Move Collections. Get all the Move Collections in the resource group.

Parameters:

resourceGroupName - The Resource Group Name.

Returns:

all the Move Collections in the resource group as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<MoveCollection> listByResourceGroup(String resourceGroupName, Context context)

Get all Move Collections. Get all the Move Collections in the resource group.

Parameters:

resourceGroupName - The Resource Group Name.

context - The context to associate with this operation.

Returns:

all the Move Collections in the resource group as paginated response with PagedIterable<T>.

listRequiredFor

public abstract RequiredForResourcesCollection listRequiredFor(String resourceGroupName, String moveCollectionName, String sourceId)

List of the move resources for which an arm resource is required for.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

sourceId - The sourceId for which the api is invoked.

Returns:

required for resources collection.

listRequiredForWithResponse

public abstract Response<RequiredForResourcesCollection> listRequiredForWithResponse(String resourceGroupName, String moveCollectionName, String sourceId, Context context)

List of the move resources for which an arm resource is required for.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

sourceId - The sourceId for which the api is invoked.

context - The context to associate with this operation.

Returns:

required for resources collection along with Response<T>.

prepare

public abstract OperationStatus prepare(String resourceGroupName, String moveCollectionName)

Initiates prepare for the set of resources included in the request body. The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', 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.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

Returns:

operation status REST resource.

prepare

public abstract OperationStatus prepare(String resourceGroupName, String moveCollectionName, PrepareRequest body, Context context)

Initiates prepare for the set of resources included in the request body. The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', 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.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

body - The body parameter.

context - The context to associate with this operation.

Returns:

operation status REST resource.

resolveDependencies

public abstract OperationStatus resolveDependencies(String resourceGroupName, String moveCollectionName)

Computes, resolves and validate the dependencies of the moveResources in the move collection.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

Returns:

operation status REST resource.

resolveDependencies

public abstract OperationStatus resolveDependencies(String resourceGroupName, String moveCollectionName, Context context)

Computes, resolves and validate the dependencies of the moveResources in the move collection.

Parameters:

resourceGroupName - The Resource Group Name.

moveCollectionName - The Move Collection Name.

context - The context to associate with this operation.

Returns:

operation status REST resource.