azure.mgmt.datamigration.operations module¶

class azure.mgmt.datamigration.operations.DatabaseMigrationsSqlDbOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataMigrationManagementClient’s database_migrations_sql_db attribute.

begin_cancel(resource_group_name: str, sql_db_instance_name: str, target_db_name: str, parameters: _models.MigrationOperationInput, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶

begin_cancel(resource_group_name: str, sql_db_instance_name: str, target_db_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Stop on going migration for the database.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_db_instance_name (str) – Required.
target_db_name (str) – The name of the target database. Required.
parameters (MigrationOperationInput or IO) – Required migration operation ID for which cancel will be initiated. Is either a model type or a IO type. Required.

Keyword Arguments

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

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_create_or_update(resource_group_name: str, sql_db_instance_name: str, target_db_name: str, parameters: _models.DatabaseMigrationSqlDb, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DatabaseMigrationSqlDb][source]¶

begin_create_or_update(resource_group_name: str, sql_db_instance_name: str, target_db_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DatabaseMigrationSqlDb]

Create or Update Database Migration resource.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_db_instance_name (str) – Required.
target_db_name (str) – The name of the target database. Required.
parameters (DatabaseMigrationSqlDb or IO) – Details of Sql Db migration resource. Is either a model type or a IO type. Required.

Keyword Arguments

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

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

Return type

LROPoller[DatabaseMigrationSqlDb]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, sql_db_instance_name: str, target_db_name: str, force: Optional[bool] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete Database Migration resource.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_db_instance_name (str) – Required.
target_db_name (str) – The name of the target database. Required.
force (bool) – Optional force delete boolean. If this is provided as true, migration will be deleted even if active. Default value is None.

Keyword Arguments

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

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, sql_db_instance_name: str, target_db_name: str, migration_operation_id: Optional[str] = None, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.DatabaseMigrationSqlDb[source]¶

Retrieve the Database Migration resource.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_db_instance_name (str) – Required.
target_db_name (str) – The name of the target database. Required.
migration_operation_id (str) – Optional migration operation ID. If this is provided, then details of migration operation for that ID are retrieved. If not provided (default), then details related to most recent or current operation are retrieved. Default value is None.
expand (str) – Complete migration details be included in the response. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseMigrationSqlDb or the result of cls(response)

Return type

DatabaseMigrationSqlDb

Raises

HttpResponseError –

models = <module 'azure.mgmt.datamigration.models' from '/mnt/vss/_work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datamigration/models/__init__.py'>¶

class azure.mgmt.datamigration.operations.DatabaseMigrationsSqlMiOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataMigrationManagementClient’s database_migrations_sql_mi attribute.

begin_cancel(resource_group_name: str, managed_instance_name: str, target_db_name: str, parameters: _models.MigrationOperationInput, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶

begin_cancel(resource_group_name: str, managed_instance_name: str, target_db_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Stop in-progress database migration to SQL Managed Instance.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
managed_instance_name (str) – Required.
target_db_name (str) – The name of the target database. Required.
parameters (MigrationOperationInput or IO) – Required migration operation ID for which cancel will be initiated. Is either a model type or a IO type. Required.

Keyword Arguments

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

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_create_or_update(resource_group_name: str, managed_instance_name: str, target_db_name: str, parameters: _models.DatabaseMigrationSqlMi, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DatabaseMigrationSqlMi][source]¶

begin_create_or_update(resource_group_name: str, managed_instance_name: str, target_db_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DatabaseMigrationSqlMi]

Create a new database migration to a given SQL Managed Instance.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
managed_instance_name (str) – Required.
target_db_name (str) – The name of the target database. Required.
parameters (DatabaseMigrationSqlMi or IO) – Details of SqlMigrationService resource. Is either a model type or a IO type. Required.

Keyword Arguments

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

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

Return type

LROPoller[DatabaseMigrationSqlMi]

Raises

HttpResponseError –

begin_cutover(resource_group_name: str, managed_instance_name: str, target_db_name: str, parameters: _models.MigrationOperationInput, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶

begin_cutover(resource_group_name: str, managed_instance_name: str, target_db_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Initiate cutover for in-progress online database migration to SQL Managed Instance.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
managed_instance_name (str) – Required.
target_db_name (str) – The name of the target database. Required.
parameters (MigrationOperationInput or IO) – Required migration operation ID for which cutover will be initiated. Is either a model type or a IO type. Required.

Keyword Arguments

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

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, managed_instance_name: str, target_db_name: str, migration_operation_id: Optional[str] = None, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.DatabaseMigrationSqlMi[source]¶

Retrieve the specified database migration for a given SQL Managed Instance.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
managed_instance_name (str) – Required.
target_db_name (str) – The name of the target database. Required.
migration_operation_id (str) – Optional migration operation ID. If this is provided, then details of migration operation for that ID are retrieved. If not provided (default), then details related to most recent or current operation are retrieved. Default value is None.
expand (str) – Complete migration details be included in the response. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseMigrationSqlMi or the result of cls(response)

Return type

DatabaseMigrationSqlMi

Raises

HttpResponseError –

models = <module 'azure.mgmt.datamigration.models' from '/mnt/vss/_work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datamigration/models/__init__.py'>¶

class azure.mgmt.datamigration.operations.DatabaseMigrationsSqlVmOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataMigrationManagementClient’s database_migrations_sql_vm attribute.

begin_cancel(resource_group_name: str, sql_virtual_machine_name: str, target_db_name: str, parameters: _models.MigrationOperationInput, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶

begin_cancel(resource_group_name: str, sql_virtual_machine_name: str, target_db_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Stop in-progress database migration to SQL VM.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_name (str) – Required.
target_db_name (str) – The name of the target database. Required.
parameters (MigrationOperationInput or IO) – Is either a model type or a IO type. Required.

Keyword Arguments

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

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_create_or_update(resource_group_name: str, sql_virtual_machine_name: str, target_db_name: str, parameters: _models.DatabaseMigrationSqlVm, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DatabaseMigrationSqlVm][source]¶

begin_create_or_update(resource_group_name: str, sql_virtual_machine_name: str, target_db_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DatabaseMigrationSqlVm]

Create a new database migration to a given SQL VM.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_name (str) – Required.
target_db_name (str) – The name of the target database. Required.
parameters (DatabaseMigrationSqlVm or IO) – Details of SqlMigrationService resource. Is either a model type or a IO type. Required.

Keyword Arguments

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

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

Return type

LROPoller[DatabaseMigrationSqlVm]

Raises

HttpResponseError –

begin_cutover(resource_group_name: str, sql_virtual_machine_name: str, target_db_name: str, parameters: _models.MigrationOperationInput, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶

begin_cutover(resource_group_name: str, sql_virtual_machine_name: str, target_db_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Initiate cutover for in-progress online database migration to SQL VM.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_name (str) – Required.
target_db_name (str) – The name of the target database. Required.
parameters (MigrationOperationInput or IO) – Is either a model type or a IO type. Required.

Keyword Arguments

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

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, sql_virtual_machine_name: str, target_db_name: str, migration_operation_id: Optional[str] = None, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.DatabaseMigrationSqlVm[source]¶

Retrieve the specified database migration for a given SQL VM.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_virtual_machine_name (str) – Required.
target_db_name (str) – The name of the target database. Required.
migration_operation_id (str) – Optional migration operation ID. If this is provided, then details of migration operation for that ID are retrieved. If not provided (default), then details related to most recent or current operation are retrieved. Default value is None.
expand (str) – Complete migration details be included in the response. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseMigrationSqlVm or the result of cls(response)

Return type

DatabaseMigrationSqlVm

Raises

HttpResponseError –

models = <module 'azure.mgmt.datamigration.models' from '/mnt/vss/_work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datamigration/models/__init__.py'>¶

class azure.mgmt.datamigration.operations.FilesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataMigrationManagementClient’s files attribute.

create_or_update(group_name: str, service_name: str, project_name: str, file_name: str, parameters: _models.ProjectFile, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProjectFile[source]¶

create_or_update(group_name: str, service_name: str, project_name: str, file_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProjectFile

Create a file resource.

The PUT method creates a new file or updates an existing one.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
file_name (str) – Name of the File. Required.
parameters (ProjectFile or IO) – Information about the file. Is either a model type or a IO type. Required.

Keyword Arguments

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

Returns

ProjectFile or the result of cls(response)

Return type

Raises

HttpResponseError –

delete(group_name: str, service_name: str, project_name: str, file_name: str, **kwargs: Any) → None [source]¶

Delete file.

This method deletes a file.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
file_name (str) – Name of the File. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(group_name: str, service_name: str, project_name: str, file_name: str, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.ProjectFile[source]¶

Get file information.

The files resource is a nested, proxy-only resource representing a file stored under the project resource. This method retrieves information about a file.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
file_name (str) – Name of the File. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ProjectFile or the result of cls(response)

Return type

Raises

HttpResponseError –

list(group_name: str, service_name: str, project_name: str, **kwargs: Any) → Iterable[azure.mgmt.datamigration.models._models_py3.ProjectFile][source]¶

Get files in a project.

The project resource is a nested resource representing a stored migration project. This method returns a list of files owned by a project resource.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ProjectFile]

Raises

HttpResponseError –

read(group_name: str, service_name: str, project_name: str, file_name: str, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.FileStorageInfo[source]¶

Request storage information for downloading the file content.

This method is used for requesting storage information using which contents of the file can be downloaded.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
file_name (str) – Name of the File. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

FileStorageInfo or the result of cls(response)

Return type

FileStorageInfo

Raises

HttpResponseError –

read_write(group_name: str, service_name: str, project_name: str, file_name: str, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.FileStorageInfo[source]¶

Request information for reading and writing file content.

This method is used for requesting information for reading and writing the file content.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
file_name (str) – Name of the File. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

FileStorageInfo or the result of cls(response)

Return type

FileStorageInfo

Raises

HttpResponseError –

update(group_name: str, service_name: str, project_name: str, file_name: str, parameters: _models.ProjectFile, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProjectFile[source]¶

update(group_name: str, service_name: str, project_name: str, file_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProjectFile

Update a file.

This method updates an existing file.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
file_name (str) – Name of the File. Required.
parameters (ProjectFile or IO) – Information about the file. Is either a model type or a IO type. Required.

Keyword Arguments

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

Returns

ProjectFile or the result of cls(response)

Return type

Raises

HttpResponseError –

models = <module 'azure.mgmt.datamigration.models' from '/mnt/vss/_work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datamigration/models/__init__.py'>¶

class azure.mgmt.datamigration.operations.Operations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataMigrationManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.datamigration.models._models_py3.OperationsDefinition][source]¶

Lists all of the available SQL Migration REST API operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either OperationsDefinition or the result of cls(response)
Return type: ItemPaged[OperationsDefinition]
Raises: HttpResponseError –

models = <module 'azure.mgmt.datamigration.models' from '/mnt/vss/_work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datamigration/models/__init__.py'>¶

class azure.mgmt.datamigration.operations.ProjectsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataMigrationManagementClient’s projects attribute.

create_or_update(group_name: str, service_name: str, project_name: str, parameters: _models.Project, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Project[source]¶

create_or_update(group_name: str, service_name: str, project_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Project

Create or update project.

The project resource is a nested resource representing a stored migration project. The PUT method creates a new project or updates an existing one.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
parameters (Project or IO) – Information about the project. Is either a model type or a IO type. Required.

Keyword Arguments

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

Returns

Project or the result of cls(response)

Return type

Raises

HttpResponseError –

delete(group_name: str, service_name: str, project_name: str, delete_running_tasks: Optional[bool] = None, **kwargs: Any) → None [source]¶

Delete project.

The project resource is a nested resource representing a stored migration project. The DELETE method deletes a project.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
delete_running_tasks (bool) – Delete the resource even if it contains running tasks. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(group_name: str, service_name: str, project_name: str, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.Project[source]¶

Get project information.

The project resource is a nested resource representing a stored migration project. The GET method retrieves information about a project.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Project or the result of cls(response)

Return type

Raises

HttpResponseError –

list(group_name: str, service_name: str, **kwargs: Any) → Iterable[azure.mgmt.datamigration.models._models_py3.Project][source]¶

Get projects in a service.

The project resource is a nested resource representing a stored migration project. This method returns a list of projects owned by a service resource.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Project]

Raises

HttpResponseError –

update(group_name: str, service_name: str, project_name: str, parameters: _models.Project, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Project[source]¶

update(group_name: str, service_name: str, project_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Project

Update project.

The project resource is a nested resource representing a stored migration project. The PATCH method updates an existing project.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
parameters (Project or IO) – Information about the project. Is either a model type or a IO type. Required.

Keyword Arguments

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

Returns

Project or the result of cls(response)

Return type

Raises

HttpResponseError –

models = <module 'azure.mgmt.datamigration.models' from '/mnt/vss/_work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datamigration/models/__init__.py'>¶

class azure.mgmt.datamigration.operations.ResourceSkusOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataMigrationManagementClient’s resource_skus attribute.

list_skus(**kwargs: Any) → Iterable[azure.mgmt.datamigration.models._models_py3.ResourceSku][source]¶

Get supported SKUs.

The skus action returns the list of SKUs that DMS supports.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ResourceSku or the result of cls(response)
Return type: ItemPaged[ResourceSku]
Raises: HttpResponseError –

models = <module 'azure.mgmt.datamigration.models' from '/mnt/vss/_work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datamigration/models/__init__.py'>¶

class azure.mgmt.datamigration.operations.ServiceTasksOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataMigrationManagementClient’s service_tasks attribute.

cancel(group_name: str, service_name: str, task_name: str, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.ProjectTask[source]¶

Cancel a service task.

The service tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. This method cancels a service task if it’s currently queued or running.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
task_name (str) – Name of the Task. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ProjectTask or the result of cls(response)

Return type

Raises

HttpResponseError –

create_or_update(group_name: str, service_name: str, task_name: str, parameters: _models.ProjectTask, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProjectTask[source]¶

create_or_update(group_name: str, service_name: str, task_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProjectTask

Create or update service task.

The service tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new service task or updates an existing one, although since service tasks have no mutable custom properties, there is little reason to update an existing one.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
task_name (str) – Name of the Task. Required.
parameters (ProjectTask or IO) – Information about the task. Is either a model type or a IO type. Required.

Keyword Arguments

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

Returns

ProjectTask or the result of cls(response)

Return type

Raises

HttpResponseError –

delete(group_name: str, service_name: str, task_name: str, delete_running_tasks: Optional[bool] = None, **kwargs: Any) → None [source]¶

Delete service task.

The service tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The DELETE method deletes a service task, canceling it first if it’s running.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
task_name (str) – Name of the Task. Required.
delete_running_tasks (bool) – Delete the resource even if it contains running tasks. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(group_name: str, service_name: str, task_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.ProjectTask[source]¶

Get service task information.

The service tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The GET method retrieves information about a service task.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
task_name (str) – Name of the Task. Required.
expand (str) – Expand the response. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ProjectTask or the result of cls(response)

Return type

Raises

HttpResponseError –

list(group_name: str, service_name: str, task_type: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.datamigration.models._models_py3.ProjectTask][source]¶

Get service level tasks for a service.

The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of service level tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
task_type (str) – Filter tasks by task type. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ProjectTask]

Raises

HttpResponseError –

update(group_name: str, service_name: str, task_name: str, parameters: _models.ProjectTask, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProjectTask[source]¶

update(group_name: str, service_name: str, task_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProjectTask

Create or update service task.

The service tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PATCH method updates an existing service task, but since service tasks have no mutable custom properties, there is little reason to do so.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
task_name (str) – Name of the Task. Required.
parameters (ProjectTask or IO) – Information about the task. Is either a model type or a IO type. Required.

Keyword Arguments

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

Returns

ProjectTask or the result of cls(response)

Return type

Raises

HttpResponseError –

models = <module 'azure.mgmt.datamigration.models' from '/mnt/vss/_work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datamigration/models/__init__.py'>¶

class azure.mgmt.datamigration.operations.ServicesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataMigrationManagementClient’s services attribute.

begin_create_or_update(group_name: str, service_name: str, parameters: _models.DataMigrationService, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DataMigrationService][source]¶

begin_create_or_update(group_name: str, service_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DataMigrationService]

Create or update DMS Instance.

The services resource is the top-level resource that represents the Database Migration Service. The PUT method creates a new service or updates an existing one. When a service is updated, existing child resources (i.e. tasks) are unaffected. Services currently support a single kind, “vm”, which refers to a VM-based service, although other kinds may be added in the future. This method can change the kind, SKU, and network of the service, but if tasks are currently running (i.e. the service is busy), this will fail with 400 Bad Request (“ServiceIsBusy”). The provider will reply when successful with 200 OK or 201 Created. Long-running operations use the provisioningState property.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
parameters (DataMigrationService or IO) – Information about the service. Is either a model type or a IO type. Required.

Keyword Arguments

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

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

Return type

LROPoller[DataMigrationService]

Raises

HttpResponseError –

begin_delete(group_name: str, service_name: str, delete_running_tasks: Optional[bool] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete DMS Service Instance.

The services resource is the top-level resource that represents the Database Migration Service. The DELETE method deletes a service. Any running tasks will be canceled.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
delete_running_tasks (bool) – Delete the resource even if it contains running tasks. Default value is None.

Keyword Arguments

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

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_start(group_name: str, service_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Start service.

The services resource is the top-level resource that represents the Database Migration Service. This action starts the service and the service can be used for data migration.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.

Keyword Arguments

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

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_stop(group_name: str, service_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Stop service.

The services resource is the top-level resource that represents the Database Migration Service. This action stops the service and the service cannot be used for data migration. The service owner won’t be billed when the service is stopped.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.

Keyword Arguments

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

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(group_name: str, service_name: str, parameters: _models.DataMigrationService, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DataMigrationService][source]¶

begin_update(group_name: str, service_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DataMigrationService]

Create or update DMS Service Instance.

The services resource is the top-level resource that represents the Database Migration Service. The PATCH method updates an existing service. This method can change the kind, SKU, and network of the service, but if tasks are currently running (i.e. the service is busy), this will fail with 400 Bad Request (“ServiceIsBusy”).

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
parameters (DataMigrationService or IO) – Information about the service. Is either a model type or a IO type. Required.

Keyword Arguments

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

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

Return type

LROPoller[DataMigrationService]

Raises

HttpResponseError –

check_children_name_availability(group_name: str, service_name: str, parameters: _models.NameAvailabilityRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NameAvailabilityResponse[source]¶

check_children_name_availability(group_name: str, service_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NameAvailabilityResponse

Check nested resource name validity and availability.

This method checks whether a proposed nested resource name is valid and available.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
parameters (NameAvailabilityRequest or IO) – Requested name to validate. Is either a model type or a IO type. Required.

Keyword Arguments

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

Returns

NameAvailabilityResponse or the result of cls(response)

Return type

NameAvailabilityResponse

Raises

HttpResponseError –

check_name_availability(location: str, parameters: _models.NameAvailabilityRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NameAvailabilityResponse[source]¶

check_name_availability(location: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NameAvailabilityResponse

Check name validity and availability.

This method checks whether a proposed top-level resource name is valid and available.

Parameters

location (str) – The Azure region of the operation. Required.
parameters (NameAvailabilityRequest or IO) – Requested name to validate. Is either a model type or a IO type. Required.

Keyword Arguments

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

Returns

NameAvailabilityResponse or the result of cls(response)

Return type

NameAvailabilityResponse

Raises

HttpResponseError –

check_status(group_name: str, service_name: str, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.DataMigrationServiceStatusResponse[source]¶

Check service health status.

The services resource is the top-level resource that represents the Database Migration Service. This action performs a health check and returns the status of the service and virtual machine size.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DataMigrationServiceStatusResponse or the result of cls(response)

Return type

DataMigrationServiceStatusResponse

Raises

HttpResponseError –

get(group_name: str, service_name: str, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.DataMigrationService[source]¶

Get DMS Service Instance.

The services resource is the top-level resource that represents the Database Migration Service. The GET method retrieves information about a service instance.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DataMigrationService or the result of cls(response)

Return type

DataMigrationService

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.datamigration.models._models_py3.DataMigrationService][source]¶

Get services in subscription.

The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of service resources in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DataMigrationService or the result of cls(response)
Return type: ItemPaged[DataMigrationService]
Raises: HttpResponseError –

list_by_resource_group(group_name: str, **kwargs: Any) → Iterable[azure.mgmt.datamigration.models._models_py3.DataMigrationService][source]¶

Get services in resource group.

The Services resource is the top-level resource that represents the Database Migration Service. This method returns a list of service resources in a resource group.

Parameters: group_name (str) – Name of the resource group. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DataMigrationService or the result of cls(response)
Return type: ItemPaged[DataMigrationService]
Raises: HttpResponseError –

list_skus(group_name: str, service_name: str, **kwargs: Any) → Iterable[azure.mgmt.datamigration.models._models_py3.AvailableServiceSku][source]¶

Get compatible SKUs.

The services resource is the top-level resource that represents the Database Migration Service. The skus action returns the list of SKUs that a service resource can be updated to.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[AvailableServiceSku]

Raises

HttpResponseError –

models = <module 'azure.mgmt.datamigration.models' from '/mnt/vss/_work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datamigration/models/__init__.py'>¶

class azure.mgmt.datamigration.operations.SqlMigrationServicesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataMigrationManagementClient’s sql_migration_services attribute.

begin_create_or_update(resource_group_name: str, sql_migration_service_name: str, parameters: _models.SqlMigrationService, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlMigrationService][source]¶

begin_create_or_update(resource_group_name: str, sql_migration_service_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlMigrationService]

Create or Update Database Migration Service.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_migration_service_name (str) – Name of the SQL Migration Service. Required.
parameters (SqlMigrationService or IO) – Details of SqlMigrationService resource. Is either a model type or a IO type. Required.

Keyword Arguments

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

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

Return type

LROPoller[SqlMigrationService]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, sql_migration_service_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete Database Migration Service.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_migration_service_name (str) – Name of the SQL Migration Service. Required.

Keyword Arguments

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

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

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, sql_migration_service_name: str, parameters: _models.SqlMigrationServiceUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlMigrationService][source]¶

begin_update(resource_group_name: str, sql_migration_service_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlMigrationService]

Update Database Migration Service.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_migration_service_name (str) – Name of the SQL Migration Service. Required.
parameters (SqlMigrationServiceUpdate or IO) – Details of SqlMigrationService resource. Is either a model type or a IO type. Required.

Keyword Arguments

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

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

Return type

LROPoller[SqlMigrationService]

Raises

HttpResponseError –

delete_node(resource_group_name: str, sql_migration_service_name: str, parameters: _models.DeleteNode, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DeleteNode[source]¶

delete_node(resource_group_name: str, sql_migration_service_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DeleteNode

Delete the integration runtime node.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_migration_service_name (str) – Name of the SQL Migration Service. Required.
parameters (DeleteNode or IO) – Details of SqlMigrationService resource. Is either a model type or a IO type. Required.

Keyword Arguments

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

Returns

DeleteNode or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, sql_migration_service_name: str, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.SqlMigrationService[source]¶

Retrieve the Database Migration Service.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_migration_service_name (str) – Name of the SQL Migration Service. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SqlMigrationService or the result of cls(response)

Return type

SqlMigrationService

Raises

HttpResponseError –

list_auth_keys(resource_group_name: str, sql_migration_service_name: str, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.AuthenticationKeys[source]¶

Retrieve the List of Authentication Keys for Self Hosted Integration Runtime.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_migration_service_name (str) – Name of the SQL Migration Service. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AuthenticationKeys or the result of cls(response)

Return type

AuthenticationKeys

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.datamigration.models._models_py3.SqlMigrationService][source]¶

Retrieve all SQL migration services in the resource group.

Parameters: resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SqlMigrationService or the result of cls(response)
Return type: ItemPaged[SqlMigrationService]
Raises: HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[azure.mgmt.datamigration.models._models_py3.SqlMigrationService][source]¶

Retrieve all SQL migration services in the subscriptions.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SqlMigrationService or the result of cls(response)
Return type: ItemPaged[SqlMigrationService]
Raises: HttpResponseError –

list_migrations(resource_group_name: str, sql_migration_service_name: str, **kwargs: Any) → Iterable[azure.mgmt.datamigration.models._models_py3.DatabaseMigration][source]¶

Retrieve the List of database migrations attached to the service.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_migration_service_name (str) – Name of the SQL Migration Service. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[DatabaseMigration]

Raises

HttpResponseError –

list_monitoring_data(resource_group_name: str, sql_migration_service_name: str, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.IntegrationRuntimeMonitoringData[source]¶

Retrieve the registered Integration Runtime nodes and their monitoring data for a given Database Migration Service.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_migration_service_name (str) – Name of the SQL Migration Service. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IntegrationRuntimeMonitoringData or the result of cls(response)

Return type

IntegrationRuntimeMonitoringData

Raises

HttpResponseError –

regenerate_auth_keys(resource_group_name: str, sql_migration_service_name: str, parameters: _models.RegenAuthKeys, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RegenAuthKeys[source]¶

regenerate_auth_keys(resource_group_name: str, sql_migration_service_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RegenAuthKeys

Regenerate a new set of Authentication Keys for Self Hosted Integration Runtime.

Parameters

resource_group_name (str) – Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
sql_migration_service_name (str) – Name of the SQL Migration Service. Required.
parameters (RegenAuthKeys or IO) – Details of SqlMigrationService resource. Is either a model type or a IO type. Required.

Keyword Arguments

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

Returns

RegenAuthKeys or the result of cls(response)

Return type

Raises

HttpResponseError –

models = <module 'azure.mgmt.datamigration.models' from '/mnt/vss/_work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datamigration/models/__init__.py'>¶

class azure.mgmt.datamigration.operations.TasksOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataMigrationManagementClient’s tasks attribute.

cancel(group_name: str, service_name: str, project_name: str, task_name: str, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.ProjectTask[source]¶

Cancel a task.

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. This method cancels a task if it’s currently queued or running.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
task_name (str) – Name of the Task. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ProjectTask or the result of cls(response)

Return type

Raises

HttpResponseError –

command(group_name: str, service_name: str, project_name: str, task_name: str, parameters: _models.CommandProperties, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CommandProperties[source]¶

command(group_name: str, service_name: str, project_name: str, task_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CommandProperties

Execute a command on a task.

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. This method executes a command on a running task.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
task_name (str) – Name of the Task. Required.
parameters (CommandProperties or IO) – Command to execute. Is either a model type or a IO type. Required.

Keyword Arguments

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

Returns

CommandProperties or the result of cls(response)

Return type

CommandProperties

Raises

HttpResponseError –

create_or_update(group_name: str, service_name: str, project_name: str, task_name: str, parameters: _models.ProjectTask, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProjectTask[source]¶

create_or_update(group_name: str, service_name: str, project_name: str, task_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProjectTask

Create or update task.

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an existing one.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
task_name (str) – Name of the Task. Required.
parameters (ProjectTask or IO) – Information about the task. Is either a model type or a IO type. Required.

Keyword Arguments

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

Returns

ProjectTask or the result of cls(response)

Return type

Raises

HttpResponseError –

delete(group_name: str, service_name: str, project_name: str, task_name: str, delete_running_tasks: Optional[bool] = None, **kwargs: Any) → None [source]¶

Delete task.

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The DELETE method deletes a task, canceling it first if it’s running.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
task_name (str) – Name of the Task. Required.
delete_running_tasks (bool) – Delete the resource even if it contains running tasks. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(group_name: str, service_name: str, project_name: str, task_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.datamigration.models._models_py3.ProjectTask[source]¶

Get task information.

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The GET method retrieves information about a task.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
task_name (str) – Name of the Task. Required.
expand (str) – Expand the response. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ProjectTask or the result of cls(response)

Return type

Raises

HttpResponseError –

list(group_name: str, service_name: str, project_name: str, task_type: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.datamigration.models._models_py3.ProjectTask][source]¶

Get tasks in a service.

The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
task_type (str) – Filter tasks by task type. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ProjectTask]

Raises

HttpResponseError –

update(group_name: str, service_name: str, project_name: str, task_name: str, parameters: _models.ProjectTask, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProjectTask[source]¶

update(group_name: str, service_name: str, project_name: str, task_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProjectTask

Create or update task.

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PATCH method updates an existing task, but since tasks have no mutable custom properties, there is little reason to do so.

Parameters

group_name (str) – Name of the resource group. Required.
service_name (str) – Name of the service. Required.
project_name (str) – Name of the project. Required.
task_name (str) – Name of the Task. Required.
parameters (ProjectTask or IO) – Information about the task. Is either a model type or a IO type. Required.

Keyword Arguments

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

Returns

ProjectTask or the result of cls(response)

Return type

Raises

HttpResponseError –

models = <module 'azure.mgmt.datamigration.models' from '/mnt/vss/_work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datamigration/models/__init__.py'>¶

class azure.mgmt.datamigration.operations.UsagesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataMigrationManagementClient’s usages attribute.

list(location: str, **kwargs: Any) → Iterable[azure.mgmt.datamigration.models._models_py3.Quota][source]¶

Get resource quotas and usage information.

This method returns region-specific quotas and resource usage information for the Database Migration Service.

Parameters: location (str) – The Azure region of the operation. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Quota or the result of cls(response)
Return type: ItemPaged[Quota]
Raises: HttpResponseError –

models = <module 'azure.mgmt.datamigration.models' from '/mnt/vss/_work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datamigration/models/__init__.py'>¶