MigrationConfigsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:migration_configs> attribute.
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
|
The name of the resource group. The name is case insensitive. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
config_name
Required
|
The configuration name. Should always be $default. "$default" Required. |
|
parameters
Required
|
Parameters required to create Migration Configuration. Is either a MigrationConfigProperties type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns MigrationConfigProperties. The MigrationConfigProperties is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
config_name
Required
|
The configuration name. Should always be $default. "$default" Required. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
config_name
Required
|
The configuration name. Should always be $default. "$default" Required. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
config_name
Required
|
The configuration name. Should always be $default. "$default" Required. |
Returns
| Type | Description |
|---|---|
|
MigrationConfigProperties. The MigrationConfigProperties is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
list
Gets all migrationConfigurations.
list(resource_group_name: str, namespace_name: str, **kwargs: Any) -> ItemPaged[MigrationConfigProperties]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of MigrationConfigProperties |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
config_name
Required
|
The configuration name. Should always be $default. "$default" Required. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|