MoveCollections interface

Package:

@azure/arm-resourcemover

Interface representing a MoveCollections.

Methods

beginBulkRemove(string, string, MoveCollectionsBulkRemoveOptionalParams)	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.
beginBulkRemoveAndWait(string, string, MoveCollectionsBulkRemoveOptionalParams)	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.
beginCommit(string, string, MoveCollectionsCommitOptionalParams)	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.
beginCommitAndWait(string, string, MoveCollectionsCommitOptionalParams)	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.
beginDelete(string, string, MoveCollectionsDeleteOptionalParams)	Deletes a move collection.
beginDeleteAndWait(string, string, MoveCollectionsDeleteOptionalParams)	Deletes a move collection.
beginDiscard(string, string, MoveCollectionsDiscardOptionalParams)	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.
beginDiscardAndWait(string, string, MoveCollectionsDiscardOptionalParams)	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.
beginInitiateMove(string, string, MoveCollectionsInitiateMoveOptionalParams)	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.
beginInitiateMoveAndWait(string, string, MoveCollectionsInitiateMoveOptionalParams)	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.
beginPrepare(string, string, MoveCollectionsPrepareOptionalParams)	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.
beginPrepareAndWait(string, string, MoveCollectionsPrepareOptionalParams)	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.
beginResolveDependencies(string, string, MoveCollectionsResolveDependenciesOptionalParams)	Computes, resolves and validate the dependencies of the moveResources in the move collection.
beginResolveDependenciesAndWait(string, string, MoveCollectionsResolveDependenciesOptionalParams)	Computes, resolves and validate the dependencies of the moveResources in the move collection.
create(string, string, MoveCollectionsCreateOptionalParams)	Creates or updates a move collection.
get(string, string, MoveCollectionsGetOptionalParams)	Gets the move collection.
listMoveCollectionsByResourceGroup(string, MoveCollectionsListMoveCollectionsByResourceGroupOptionalParams)	Get all the Move Collections in the resource group.
listMoveCollectionsBySubscription(MoveCollectionsListMoveCollectionsBySubscriptionOptionalParams)	Get all the Move Collections in the subscription.
listRequiredFor(string, string, string, MoveCollectionsListRequiredForOptionalParams)	List of the move resources for which an arm resource is required for.
update(string, string, MoveCollectionsUpdateOptionalParams)	Updates a move collection.

Method Details

beginBulkRemove(string, string, MoveCollectionsBulkRemoveOptionalParams)

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.

function beginBulkRemove(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsBulkRemoveOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>

Parameters

resourceGroupName

string

moveCollectionName

string

options

MoveCollectionsBulkRemoveOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>

beginBulkRemoveAndWait(string, string, MoveCollectionsBulkRemoveOptionalParams)

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.

function beginBulkRemoveAndWait(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsBulkRemoveOptionalParams): Promise<OperationStatus>

Parameters

resourceGroupName

string

moveCollectionName

string

options

MoveCollectionsBulkRemoveOptionalParams

The options parameters.

Returns

Promise<OperationStatus>

beginCommit(string, string, MoveCollectionsCommitOptionalParams)

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.

function beginCommit(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsCommitOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

options

MoveCollectionsCommitOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>

beginCommitAndWait(string, string, MoveCollectionsCommitOptionalParams)

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.

function beginCommitAndWait(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsCommitOptionalParams): Promise<OperationStatus>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

options

MoveCollectionsCommitOptionalParams

The options parameters.

Returns

Promise<OperationStatus>

beginDelete(string, string, MoveCollectionsDeleteOptionalParams)

Deletes a move collection.

function beginDelete(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

options

MoveCollectionsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>

beginDeleteAndWait(string, string, MoveCollectionsDeleteOptionalParams)

Deletes a move collection.

function beginDeleteAndWait(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsDeleteOptionalParams): Promise<OperationStatus>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

options

MoveCollectionsDeleteOptionalParams

The options parameters.

Returns

Promise<OperationStatus>

beginDiscard(string, string, MoveCollectionsDiscardOptionalParams)

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.

function beginDiscard(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsDiscardOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

options

MoveCollectionsDiscardOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>

beginDiscardAndWait(string, string, MoveCollectionsDiscardOptionalParams)

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.

function beginDiscardAndWait(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsDiscardOptionalParams): Promise<OperationStatus>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

options

MoveCollectionsDiscardOptionalParams

The options parameters.

Returns

Promise<OperationStatus>

beginInitiateMove(string, string, MoveCollectionsInitiateMoveOptionalParams)

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.

function beginInitiateMove(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsInitiateMoveOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

options

MoveCollectionsInitiateMoveOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>

beginInitiateMoveAndWait(string, string, MoveCollectionsInitiateMoveOptionalParams)

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.

function beginInitiateMoveAndWait(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsInitiateMoveOptionalParams): Promise<OperationStatus>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

options

MoveCollectionsInitiateMoveOptionalParams

The options parameters.

Returns

Promise<OperationStatus>

beginPrepare(string, string, MoveCollectionsPrepareOptionalParams)

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.

function beginPrepare(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsPrepareOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

options

MoveCollectionsPrepareOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>

beginPrepareAndWait(string, string, MoveCollectionsPrepareOptionalParams)

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.

function beginPrepareAndWait(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsPrepareOptionalParams): Promise<OperationStatus>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

options

MoveCollectionsPrepareOptionalParams

The options parameters.

Returns

Promise<OperationStatus>

beginResolveDependencies(string, string, MoveCollectionsResolveDependenciesOptionalParams)

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

function beginResolveDependencies(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsResolveDependenciesOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

options

MoveCollectionsResolveDependenciesOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>

beginResolveDependenciesAndWait(string, string, MoveCollectionsResolveDependenciesOptionalParams)

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

function beginResolveDependenciesAndWait(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsResolveDependenciesOptionalParams): Promise<OperationStatus>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

options

MoveCollectionsResolveDependenciesOptionalParams

The options parameters.

Returns

Promise<OperationStatus>

create(string, string, MoveCollectionsCreateOptionalParams)

Creates or updates a move collection.

function create(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsCreateOptionalParams): Promise<MoveCollection>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

options

MoveCollectionsCreateOptionalParams

The options parameters.

Returns

Promise<MoveCollection>

get(string, string, MoveCollectionsGetOptionalParams)

Gets the move collection.

function get(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsGetOptionalParams): Promise<MoveCollection>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

options

MoveCollectionsGetOptionalParams

The options parameters.

Returns

Promise<MoveCollection>

listMoveCollectionsByResourceGroup(string, MoveCollectionsListMoveCollectionsByResourceGroupOptionalParams)

Get all the Move Collections in the resource group.

function listMoveCollectionsByResourceGroup(resourceGroupName: string, options?: MoveCollectionsListMoveCollectionsByResourceGroupOptionalParams): PagedAsyncIterableIterator<MoveCollection, MoveCollection[], PageSettings>

Parameters

resourceGroupName

string

The Resource Group Name.

options

MoveCollectionsListMoveCollectionsByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MoveCollection, MoveCollection[], PageSettings>

listMoveCollectionsBySubscription(MoveCollectionsListMoveCollectionsBySubscriptionOptionalParams)

Get all the Move Collections in the subscription.

function listMoveCollectionsBySubscription(options?: MoveCollectionsListMoveCollectionsBySubscriptionOptionalParams): PagedAsyncIterableIterator<MoveCollection, MoveCollection[], PageSettings>

Parameters

options

MoveCollectionsListMoveCollectionsBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MoveCollection, MoveCollection[], PageSettings>

listRequiredFor(string, string, string, MoveCollectionsListRequiredForOptionalParams)

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

function listRequiredFor(resourceGroupName: string, moveCollectionName: string, sourceId: string, options?: MoveCollectionsListRequiredForOptionalParams): Promise<RequiredForResourcesCollection>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

sourceId

string

The sourceId for which the api is invoked.

options

MoveCollectionsListRequiredForOptionalParams

The options parameters.

Returns

Promise<RequiredForResourcesCollection>

update(string, string, MoveCollectionsUpdateOptionalParams)

Updates a move collection.

function update(resourceGroupName: string, moveCollectionName: string, options?: MoveCollectionsUpdateOptionalParams): Promise<MoveCollection>

Parameters

resourceGroupName

string

The Resource Group Name.

moveCollectionName

string

The Move Collection Name.

options

MoveCollectionsUpdateOptionalParams

The options parameters.

Returns

Promise<MoveCollection>