ServiceTasksOperations Class
ServiceTasksOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectServiceTasksOperations
Constructor
ServiceTasksOperations(client, config, serializer, deserializer)
Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| cancel |
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. |
| create_or_update |
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. |
| delete |
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. |
| get |
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. |
| list |
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. |
| update |
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. |
cancel
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.
cancel(group_name: str, service_name: str, task_name: str, **kwargs: Any) -> _models.ProjectTask
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
ProjectTask, or the result of cls(response)
Return type
Exceptions
create_or_update
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.
create_or_update(group_name: str, service_name: str, task_name: str, parameters: _models.ProjectTask, **kwargs: Any) -> _models.ProjectTask
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
ProjectTask, or the result of cls(response)
Return type
Exceptions
delete
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.
delete(group_name: str, service_name: str, task_name: str, delete_running_tasks: Optional[bool] = None, **kwargs: Any) -> None
Parameters
- delete_running_tasks
- bool
Delete the resource even if it contains running tasks.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
get
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.
get(group_name: str, service_name: str, task_name: str, expand: Optional[str] = None, **kwargs: Any) -> _models.ProjectTask
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
ProjectTask, or the result of cls(response)
Return type
Exceptions
list
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.
list(group_name: str, service_name: str, task_type: Optional[str] = None, **kwargs: Any) -> Iterable[_models.TaskList]
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either TaskList or the result of cls(response)
Return type
Exceptions
update
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.
update(group_name: str, service_name: str, task_name: str, parameters: _models.ProjectTask, **kwargs: Any) -> _models.ProjectTask
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
ProjectTask, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.datamigration.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\datamigration\\models\\__init__.py'>
Feedback
Submit and view feedback for