Share via

MigrationConfigsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ServiceBusManagementClient's

<xref:migration_configs> attribute.

Inheritance
builtins.object
MigrationConfigsOperations

Constructor

MigrationConfigsOperations(*args, **kwargs)

Methods

begin_create_and_start_migration

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

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

Deletes a MigrationConfiguration.
get

Retrieves Migration Config.
list

Gets all migrationConfigurations.
revert

This operation reverts Migration.

begin_create_and_start_migration

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

begin_create_and_start_migration(resource_group_name: str, namespace_name: str, config_name: str | _models.MigrationConfigurationName, parameters: _models.MigrationConfigProperties, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.MigrationConfigProperties]

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
namespace_name
Required
str

The namespace name. Required.
config_name
Required
str or MigrationConfigurationName

The configuration name. Should always be "$default". "$default" Required.
parameters
Required
MigrationConfigProperties or IO

Parameters required to create Migration Configuration. Is either a MigrationConfigProperties type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[MigrationConfigProperties]

An instance of LROPoller that returns either MigrationConfigProperties or the result of cls(response)

Exceptions

Type Description
HttpResponseError

complete_migration

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.

complete_migration(resource_group_name: str, namespace_name: str, config_name: str | MigrationConfigurationName, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
namespace_name
Required
str

The namespace name. Required.
config_name
Required
str or MigrationConfigurationName

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

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Deletes a MigrationConfiguration.

delete(resource_group_name: str, namespace_name: str, config_name: str | MigrationConfigurationName, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
namespace_name
Required
str

The namespace name. Required.
config_name
Required
str or MigrationConfigurationName

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

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Retrieves Migration Config.

get(resource_group_name: str, namespace_name: str, config_name: str | MigrationConfigurationName, **kwargs: Any) -> MigrationConfigProperties

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
namespace_name
Required
str

The namespace name. Required.
config_name
Required
str or MigrationConfigurationName

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

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
MigrationConfigProperties

MigrationConfigProperties or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets all migrationConfigurations.

list(resource_group_name: str, namespace_name: str, **kwargs: Any) -> Iterable[MigrationConfigProperties]

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
namespace_name
Required
str

The namespace name. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[MigrationConfigProperties]

An iterator like instance of either MigrationConfigProperties or the result of cls(response)

Exceptions

Type Description
HttpResponseError

revert

This operation reverts Migration.

revert(resource_group_name: str, namespace_name: str, config_name: str | MigrationConfigurationName, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
namespace_name
Required
str

The namespace name. Required.
config_name
Required
str or MigrationConfigurationName

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

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.servicebus.v2021_01_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\servicebus\\v2021_01_01_preview\\models\\__init__.py'>