ServiceTasks interface
Interface representing a ServiceTasks.
Methods
| cancel(string, string, string, Service |
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 |
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(string, string, string, Service |
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(string, string, string, Service |
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(string, string, 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(string, string, string, Project |
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. |
Method Details
cancel(string, string, string, ServiceTasksCancelOptionalParams)
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.
function cancel(groupName: string, serviceName: string, taskName: string, options?: ServiceTasksCancelOptionalParams): Promise<ProjectTask>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- options
- ServiceTasksCancelOptionalParams
The options parameters.
Returns
Promise<ProjectTask>
createOrUpdate(string, string, string, ProjectTask, ServiceTasksCreateOrUpdateOptionalParams)
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.
function createOrUpdate(groupName: string, serviceName: string, taskName: string, parameters: ProjectTask, options?: ServiceTasksCreateOrUpdateOptionalParams): Promise<ProjectTask>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- parameters
- ProjectTask
Information about the task
The options parameters.
Returns
Promise<ProjectTask>
delete(string, string, string, ServiceTasksDeleteOptionalParams)
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.
function delete(groupName: string, serviceName: string, taskName: string, options?: ServiceTasksDeleteOptionalParams): Promise<void>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- options
- ServiceTasksDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, ServiceTasksGetOptionalParams)
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.
function get(groupName: string, serviceName: string, taskName: string, options?: ServiceTasksGetOptionalParams): Promise<ProjectTask>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- options
- ServiceTasksGetOptionalParams
The options parameters.
Returns
Promise<ProjectTask>
list(string, string, ServiceTasksListOptionalParams)
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.
function list(groupName: string, serviceName: string, options?: ServiceTasksListOptionalParams): PagedAsyncIterableIterator<ProjectTask, ProjectTask[], PageSettings>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- ServiceTasksListOptionalParams
The options parameters.
Returns
update(string, string, string, ProjectTask, ServiceTasksUpdateOptionalParams)
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.
function update(groupName: string, serviceName: string, taskName: string, parameters: ProjectTask, options?: ServiceTasksUpdateOptionalParams): Promise<ProjectTask>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- parameters
- ProjectTask
Information about the task
- options
- ServiceTasksUpdateOptionalParams
The options parameters.
Returns
Promise<ProjectTask>
