azure.mgmt.datamigration.operations module

class azure.mgmt.datamigration.operations.ResourceSkusOperations(client, config, serializer, deserializer)[source]

Bases: object

ResourceSkusOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Version of the API. Constant value: “2018-07-15-preview”.

list_skus(custom_headers=None, raw=False, **operation_config)[source]

Get supported SKUs.

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

Parameters
  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of ResourceSku

Return type

ResourceSkuPaged[ResourceSku]

Raises

ApiErrorException

models = <module 'azure.mgmt.datamigration.models' from '/home/vsts/work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datamigration/models/__init__.py'>
class azure.mgmt.datamigration.operations.ServicesOperations(client, config, serializer, deserializer)[source]

Bases: object

ServicesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Version of the API. Constant value: “2018-07-15-preview”.

check_children_name_availability(group_name, service_name, name=None, type=None, custom_headers=None, raw=False, **operation_config)[source]

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

  • service_name (str) – Name of the service

  • name (str) – The proposed resource name

  • type (str) – The resource type chain (e.g. virtualMachines/extensions)

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

NameAvailabilityResponse or ClientRawResponse if raw=true

Return type

NameAvailabilityResponse or ClientRawResponse

Raises

ApiErrorException

check_name_availability(location, name=None, type=None, custom_headers=None, raw=False, **operation_config)[source]

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

  • name (str) – The proposed resource name

  • type (str) – The resource type chain (e.g. virtualMachines/extensions)

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

NameAvailabilityResponse or ClientRawResponse if raw=true

Return type

NameAvailabilityResponse or ClientRawResponse

Raises

ApiErrorException

check_status(group_name, service_name, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

DataMigrationServiceStatusResponse or ClientRawResponse if raw=true

Return type

DataMigrationServiceStatusResponse or ClientRawResponse

Raises

ApiErrorException

create_or_update(parameters, group_name, service_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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
  • parameters (DataMigrationService) – Information about the service

  • group_name (str) – Name of the resource group

  • service_name (str) – Name of the service

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns DataMigrationService or ClientRawResponse<DataMigrationService> if raw==True

Return type

AzureOperationPoller[DataMigrationService] or AzureOperationPoller[ClientRawResponse[DataMigrationService]]

Raises

ApiErrorException

delete(group_name, service_name, delete_running_tasks=None, custom_headers=None, raw=False, polling=True, **operation_config)[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

  • service_name (str) – Name of the service

  • delete_running_tasks (bool) – Delete the resource even if it contains running tasks

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ApiErrorException

get(group_name, service_name, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

DataMigrationService or ClientRawResponse if raw=true

Return type

DataMigrationService or ClientRawResponse

Raises

ApiErrorException

list(custom_headers=None, raw=False, **operation_config)[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.

Parameters
  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of DataMigrationService

Return type

DataMigrationServicePaged[DataMigrationService]

Raises

ApiErrorException

list_by_resource_group(group_name, custom_headers=None, raw=False, **operation_config)[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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of DataMigrationService

Return type

DataMigrationServicePaged[DataMigrationService]

Raises

ApiErrorException

list_skus(group_name, service_name, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of AvailableServiceSku

Return type

AvailableServiceSkuPaged[AvailableServiceSku]

Raises

ApiErrorException

start(group_name, service_name, custom_headers=None, raw=False, polling=True, **operation_config)[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

  • service_name (str) – Name of the service

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ApiErrorException

stop(group_name, service_name, custom_headers=None, raw=False, polling=True, **operation_config)[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

  • service_name (str) – Name of the service

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ApiErrorException

update(parameters, group_name, service_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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
  • parameters (DataMigrationService) – Information about the service

  • group_name (str) – Name of the resource group

  • service_name (str) – Name of the service

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns DataMigrationService or ClientRawResponse<DataMigrationService> if raw==True

Return type

AzureOperationPoller[DataMigrationService] or AzureOperationPoller[ClientRawResponse[DataMigrationService]]

Raises

ApiErrorException

models = <module 'azure.mgmt.datamigration.models' from '/home/vsts/work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datamigration/models/__init__.py'>
class azure.mgmt.datamigration.operations.TasksOperations(client, config, serializer, deserializer)[source]

Bases: object

TasksOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Version of the API. Constant value: “2018-07-15-preview”.

cancel(group_name, service_name, project_name, task_name, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • task_name (str) – Name of the Task

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ProjectTask or ClientRawResponse if raw=true

Return type

ProjectTask or ClientRawResponse

Raises

ApiErrorException

command(group_name, service_name, project_name, task_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

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

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • task_name (str) – Name of the Task

  • parameters (CommandProperties) – Command to execute

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

CommandProperties or ClientRawResponse if raw=true

Return type

CommandProperties or ClientRawResponse

Raises

ApiErrorException

create_or_update(group_name, service_name, project_name, task_name, etag=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]

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

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • task_name (str) – Name of the Task

  • etag (str) – HTTP strong entity tag value. This is ignored if submitted.

  • properties (ProjectTaskProperties) – Custom task properties

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ProjectTask or ClientRawResponse if raw=true

Return type

ProjectTask or ClientRawResponse

Raises

ApiErrorException

delete(group_name, service_name, project_name, task_name, delete_running_tasks=None, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • task_name (str) – Name of the Task

  • delete_running_tasks (bool) – Delete the resource even if it contains running tasks

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ApiErrorException

get(group_name, service_name, project_name, task_name, expand=None, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • task_name (str) – Name of the Task

  • expand (str) – Expand the response

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ProjectTask or ClientRawResponse if raw=true

Return type

ProjectTask or ClientRawResponse

Raises

ApiErrorException

list(group_name, service_name, project_name, task_type=None, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • task_type (str) – Filter tasks by task type

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of ProjectTask

Return type

ProjectTaskPaged[ProjectTask]

Raises

ApiErrorException

update(group_name, service_name, project_name, task_name, etag=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]

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

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • task_name (str) – Name of the Task

  • etag (str) – HTTP strong entity tag value. This is ignored if submitted.

  • properties (ProjectTaskProperties) – Custom task properties

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ProjectTask or ClientRawResponse if raw=true

Return type

ProjectTask or ClientRawResponse

Raises

ApiErrorException

models = <module 'azure.mgmt.datamigration.models' from '/home/vsts/work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datamigration/models/__init__.py'>
class azure.mgmt.datamigration.operations.ServiceTasksOperations(client, config, serializer, deserializer)[source]

Bases: object

ServiceTasksOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Version of the API. Constant value: “2018-07-15-preview”.

cancel(group_name, service_name, task_name, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • task_name (str) – Name of the Task

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ProjectTask or ClientRawResponse if raw=true

Return type

ProjectTask or ClientRawResponse

Raises

ApiErrorException

create_or_update(group_name, service_name, task_name, etag=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]

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

  • service_name (str) – Name of the service

  • task_name (str) – Name of the Task

  • etag (str) – HTTP strong entity tag value. This is ignored if submitted.

  • properties (ProjectTaskProperties) – Custom task properties

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ProjectTask or ClientRawResponse if raw=true

Return type

ProjectTask or ClientRawResponse

Raises

ApiErrorException

delete(group_name, service_name, task_name, delete_running_tasks=None, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • task_name (str) – Name of the Task

  • delete_running_tasks (bool) – Delete the resource even if it contains running tasks

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ApiErrorException

get(group_name, service_name, task_name, expand=None, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • task_name (str) – Name of the Task

  • expand (str) – Expand the response

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ProjectTask or ClientRawResponse if raw=true

Return type

ProjectTask or ClientRawResponse

Raises

ApiErrorException

list(group_name, service_name, task_type=None, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • task_type (str) – Filter tasks by task type

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of ProjectTask

Return type

ProjectTaskPaged[ProjectTask]

Raises

ApiErrorException

update(group_name, service_name, task_name, etag=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]

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

  • service_name (str) – Name of the service

  • task_name (str) – Name of the Task

  • etag (str) – HTTP strong entity tag value. This is ignored if submitted.

  • properties (ProjectTaskProperties) – Custom task properties

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ProjectTask or ClientRawResponse if raw=true

Return type

ProjectTask or ClientRawResponse

Raises

ApiErrorException

models = <module 'azure.mgmt.datamigration.models' from '/home/vsts/work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datamigration/models/__init__.py'>
class azure.mgmt.datamigration.operations.ProjectsOperations(client, config, serializer, deserializer)[source]

Bases: object

ProjectsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Version of the API. Constant value: “2018-07-15-preview”.

create_or_update(parameters, group_name, service_name, project_name, custom_headers=None, raw=False, **operation_config)[source]

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
  • parameters (Project) – Information about the project

  • group_name (str) – Name of the resource group

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Project or ClientRawResponse if raw=true

Return type

Project or ClientRawResponse

Raises

ApiErrorException

delete(group_name, service_name, project_name, delete_running_tasks=None, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • delete_running_tasks (bool) – Delete the resource even if it contains running tasks

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ApiErrorException

get(group_name, service_name, project_name, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Project or ClientRawResponse if raw=true

Return type

Project or ClientRawResponse

Raises

ApiErrorException

list(group_name, service_name, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Project

Return type

ProjectPaged[Project]

Raises

ApiErrorException

update(parameters, group_name, service_name, project_name, custom_headers=None, raw=False, **operation_config)[source]

Update project.

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

Parameters
  • parameters (Project) – Information about the project

  • group_name (str) – Name of the resource group

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Project or ClientRawResponse if raw=true

Return type

Project or ClientRawResponse

Raises

ApiErrorException

models = <module 'azure.mgmt.datamigration.models' from '/home/vsts/work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datamigration/models/__init__.py'>
class azure.mgmt.datamigration.operations.UsagesOperations(client, config, serializer, deserializer)[source]

Bases: object

UsagesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Version of the API. Constant value: “2018-07-15-preview”.

list(location, custom_headers=None, raw=False, **operation_config)[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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Quota

Return type

QuotaPaged[Quota]

Raises

ApiErrorException

models = <module 'azure.mgmt.datamigration.models' from '/home/vsts/work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datamigration/models/__init__.py'>
class azure.mgmt.datamigration.operations.Operations(client, config, serializer, deserializer)[source]

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Version of the API. Constant value: “2018-07-15-preview”.

list(custom_headers=None, raw=False, **operation_config)[source]

Get available resource provider actions (operations).

Lists all available actions exposed by the Database Migration Service resource provider.

Parameters
  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of ServiceOperation

Return type

ServiceOperationPaged[ServiceOperation]

Raises

ApiErrorException

models = <module 'azure.mgmt.datamigration.models' from '/home/vsts/work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datamigration/models/__init__.py'>
class azure.mgmt.datamigration.operations.FilesOperations(client, config, serializer, deserializer)[source]

Bases: object

FilesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Version of the API. Constant value: “2018-07-15-preview”.

create_or_update(group_name, service_name, project_name, file_name, etag=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]

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

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • file_name (str) – Name of the File

  • etag (str) – HTTP strong entity tag value. This is ignored if submitted.

  • properties (ProjectFileProperties) – Custom file properties

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ProjectFile or ClientRawResponse if raw=true

Return type

ProjectFile or ClientRawResponse

Raises

ApiErrorException

delete(group_name, service_name, project_name, file_name, custom_headers=None, raw=False, **operation_config)[source]

Delete file.

This method deletes a file.

Parameters
  • group_name (str) – Name of the resource group

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • file_name (str) – Name of the File

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ApiErrorException

get(group_name, service_name, project_name, file_name, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • file_name (str) – Name of the File

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ProjectFile or ClientRawResponse if raw=true

Return type

ProjectFile or ClientRawResponse

Raises

ApiErrorException

list(group_name, service_name, project_name, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of ProjectFile

Return type

ProjectFilePaged[ProjectFile]

Raises

ApiErrorException

read(group_name, service_name, project_name, file_name, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • file_name (str) – Name of the File

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

FileStorageInfo or ClientRawResponse if raw=true

Return type

FileStorageInfo or ClientRawResponse

Raises

ApiErrorException

read_write(group_name, service_name, project_name, file_name, custom_headers=None, raw=False, **operation_config)[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

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • file_name (str) – Name of the File

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

FileStorageInfo or ClientRawResponse if raw=true

Return type

FileStorageInfo or ClientRawResponse

Raises

ApiErrorException

update(group_name, service_name, project_name, file_name, etag=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]

Update a file.

This method updates an existing file.

Parameters
  • group_name (str) – Name of the resource group

  • service_name (str) – Name of the service

  • project_name (str) – Name of the project

  • file_name (str) – Name of the File

  • etag (str) – HTTP strong entity tag value. This is ignored if submitted.

  • properties (ProjectFileProperties) – Custom file properties

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ProjectFile or ClientRawResponse if raw=true

Return type

ProjectFile or ClientRawResponse

Raises

ApiErrorException

models = <module 'azure.mgmt.datamigration.models' from '/home/vsts/work/1/s/sdk/datamigration/azure-mgmt-datamigration/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/datamigration/models/__init__.py'>