MigrationConfigs interface

Package:

@azure/arm-servicebus

Interface representing a MigrationConfigs.

Methods

beginCreateAndStartMigration(string, string, string, MigrationConfigProperties, MigrationConfigsCreateAndStartMigrationOptionalParams)	Creates Migration configuration and starts migration of entities from Standard to Premium namespace
beginCreateAndStartMigrationAndWait(string, string, string, MigrationConfigProperties, MigrationConfigsCreateAndStartMigrationOptionalParams)	Creates Migration configuration and starts migration of entities from Standard to Premium namespace
completeMigration(string, string, string, MigrationConfigsCompleteMigrationOptionalParams)	This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.
delete(string, string, string, MigrationConfigsDeleteOptionalParams)	Deletes a MigrationConfiguration
get(string, string, string, MigrationConfigsGetOptionalParams)	Retrieves Migration Config
list(string, string, MigrationConfigsListOptionalParams)	Gets all migrationConfigurations
revert(string, string, string, MigrationConfigsRevertOptionalParams)	This operation reverts Migration

Method Details

beginCreateAndStartMigration(string, string, string, MigrationConfigProperties, MigrationConfigsCreateAndStartMigrationOptionalParams)

Creates Migration configuration and starts migration of entities from Standard to Premium namespace

function beginCreateAndStartMigration(resourceGroupName: string, namespaceName: string, configName: string, parameters: MigrationConfigProperties, options?: MigrationConfigsCreateAndStartMigrationOptionalParams): Promise<PollerLike<PollOperationState<MigrationConfigProperties>, MigrationConfigProperties>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

configName

string

The configuration name. Should always be "$default".

parameters

MigrationConfigProperties

Parameters required to create Migration Configuration

options

MigrationConfigsCreateAndStartMigrationOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<MigrationConfigProperties>, MigrationConfigProperties>>

beginCreateAndStartMigrationAndWait(string, string, string, MigrationConfigProperties, MigrationConfigsCreateAndStartMigrationOptionalParams)

Creates Migration configuration and starts migration of entities from Standard to Premium namespace

function beginCreateAndStartMigrationAndWait(resourceGroupName: string, namespaceName: string, configName: string, parameters: MigrationConfigProperties, options?: MigrationConfigsCreateAndStartMigrationOptionalParams): Promise<MigrationConfigProperties>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

configName

string

The configuration name. Should always be "$default".

parameters

MigrationConfigProperties

Parameters required to create Migration Configuration

options

MigrationConfigsCreateAndStartMigrationOptionalParams

The options parameters.

Returns

Promise<MigrationConfigProperties>

completeMigration(string, string, string, MigrationConfigsCompleteMigrationOptionalParams)

This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.

function completeMigration(resourceGroupName: string, namespaceName: string, configName: string, options?: MigrationConfigsCompleteMigrationOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

configName

string

The configuration name. Should always be "$default".

options

MigrationConfigsCompleteMigrationOptionalParams

The options parameters.

Returns

Promise<void>

delete(string, string, string, MigrationConfigsDeleteOptionalParams)

Deletes a MigrationConfiguration

function delete(resourceGroupName: string, namespaceName: string, configName: string, options?: MigrationConfigsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

configName

string

The configuration name. Should always be "$default".

options

MigrationConfigsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, MigrationConfigsGetOptionalParams)

Retrieves Migration Config

function get(resourceGroupName: string, namespaceName: string, configName: string, options?: MigrationConfigsGetOptionalParams): Promise<MigrationConfigProperties>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

configName

string

The configuration name. Should always be "$default".

options

MigrationConfigsGetOptionalParams

The options parameters.

Returns

Promise<MigrationConfigProperties>

list(string, string, MigrationConfigsListOptionalParams)

Gets all migrationConfigurations

function list(resourceGroupName: string, namespaceName: string, options?: MigrationConfigsListOptionalParams): PagedAsyncIterableIterator<MigrationConfigProperties, MigrationConfigProperties[], PageSettings>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

options

MigrationConfigsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MigrationConfigProperties, MigrationConfigProperties[], PageSettings>

revert(string, string, string, MigrationConfigsRevertOptionalParams)

This operation reverts Migration

function revert(resourceGroupName: string, namespaceName: string, configName: string, options?: MigrationConfigsRevertOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

configName

string

The configuration name. Should always be "$default".

options

MigrationConfigsRevertOptionalParams

The options parameters.

Returns

Promise<void>