Share via

StorageMovers interface

  • Reference
Package:
@azure/arm-storagemover

Interface representing a StorageMovers.

Methods

beginDelete(string, string, StorageMoversDeleteOptionalParams)

Deletes a Storage Mover resource.
beginDeleteAndWait(string, string, StorageMoversDeleteOptionalParams)

Deletes a Storage Mover resource.
createOrUpdate(string, string, StorageMover, StorageMoversCreateOrUpdateOptionalParams)

Creates or updates a top-level Storage Mover resource.
get(string, string, StorageMoversGetOptionalParams)

Gets a Storage Mover resource.
list(string, StorageMoversListOptionalParams)

Lists all Storage Movers in a resource group.
listBySubscription(StorageMoversListBySubscriptionOptionalParams)

Lists all Storage Movers in a subscription.
update(string, string, StorageMoverUpdateParameters, StorageMoversUpdateOptionalParams)

Updates properties for a Storage Mover resource. Properties not specified in the request body will be unchanged.

Method Details

beginDelete(string, string, StorageMoversDeleteOptionalParams)

Deletes a Storage Mover resource.

function beginDelete(resourceGroupName: string, storageMoverName: string, options?: StorageMoversDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageMoverName

string

The name of the Storage Mover resource.

options
StorageMoversDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, StorageMoversDeleteOptionalParams)

Deletes a Storage Mover resource.

function beginDeleteAndWait(resourceGroupName: string, storageMoverName: string, options?: StorageMoversDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageMoverName

string

The name of the Storage Mover resource.

options
StorageMoversDeleteOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, StorageMover, StorageMoversCreateOrUpdateOptionalParams)

Creates or updates a top-level Storage Mover resource.

function createOrUpdate(resourceGroupName: string, storageMoverName: string, storageMover: StorageMover, options?: StorageMoversCreateOrUpdateOptionalParams): Promise<StorageMover>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageMoverName

string

The name of the Storage Mover resource.

storageMover
StorageMover

The Storage Mover resource, which is a container for a group of Agents, Projects, and Endpoints.

options
StorageMoversCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<StorageMover>

get(string, string, StorageMoversGetOptionalParams)

Gets a Storage Mover resource.

function get(resourceGroupName: string, storageMoverName: string, options?: StorageMoversGetOptionalParams): Promise<StorageMover>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageMoverName

string

The name of the Storage Mover resource.

options
StorageMoversGetOptionalParams

The options parameters.

Returns

Promise<StorageMover>

list(string, StorageMoversListOptionalParams)

Lists all Storage Movers in a resource group.

function list(resourceGroupName: string, options?: StorageMoversListOptionalParams): PagedAsyncIterableIterator<StorageMover, StorageMover[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options
StorageMoversListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<StorageMover, StorageMover[], PageSettings>

listBySubscription(StorageMoversListBySubscriptionOptionalParams)

Lists all Storage Movers in a subscription.

function listBySubscription(options?: StorageMoversListBySubscriptionOptionalParams): PagedAsyncIterableIterator<StorageMover, StorageMover[], PageSettings>

Parameters

options
StorageMoversListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<StorageMover, StorageMover[], PageSettings>

update(string, string, StorageMoverUpdateParameters, StorageMoversUpdateOptionalParams)

Updates properties for a Storage Mover resource. Properties not specified in the request body will be unchanged.

function update(resourceGroupName: string, storageMoverName: string, storageMover: StorageMoverUpdateParameters, options?: StorageMoversUpdateOptionalParams): Promise<StorageMover>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageMoverName

string

The name of the Storage Mover resource.

storageMover
StorageMoverUpdateParameters

The Storage Mover resource.

options
StorageMoversUpdateOptionalParams

The options parameters.

Returns

Promise<StorageMover>