ServiceTasks class
Class representing a ServiceTasks.
Constructors
| Service |
Create a ServiceTasks. |
Methods
| cancel(string, string, string, Request |
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(string, string, string, Request |
|
| cancel(string, string, string, Service |
|
| 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. |
| create |
|
| create |
|
| delete |
|
| delete |
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 |
|
| get(string, string, string, Service |
|
| 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. |
| get(string, string, string, Service |
|
| list(string, string, Service |
|
| 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. |
| list(string, string, Service |
|
| list |
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 |
|
| list |
|
| update(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. |
| update(Project |
|
| update(Project |
Constructor Details
ServiceTasks(DataMigrationServiceClientContext)
Create a ServiceTasks.
new ServiceTasks(client: DataMigrationServiceClientContext)Parameters
Reference to the service client.
Method Details
cancel(string, string, string, RequestOptionsBase)
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?: RequestOptionsBase): Promise<ServiceTasksCancelResponse>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ServiceTasksCancelResponse>
Promise<Models.ServiceTasksCancelResponse>
cancel(string, string, string, RequestOptionsBase, ServiceCallback<ProjectTask>)
function cancel(groupName: string, serviceName: string, taskName: string, options: RequestOptionsBase, callback: ServiceCallback<ProjectTask>)Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
cancel(string, string, string, ServiceCallback<ProjectTask>)
function cancel(groupName: string, serviceName: string, taskName: string, callback: ServiceCallback<ProjectTask>)Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- callback
The callback
createOrUpdate(ProjectTask, string, string, string, RequestOptionsBase)
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(parameters: ProjectTask, groupName: string, serviceName: string, taskName: string, options?: RequestOptionsBase): Promise<ServiceTasksCreateOrUpdateResponse>Parameters
- parameters
- ProjectTask
Information about the task
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ServiceTasksCreateOrUpdateResponse>
Promise<Models.ServiceTasksCreateOrUpdateResponse>
createOrUpdate(ProjectTask, string, string, string, RequestOptionsBase, ServiceCallback<ProjectTask>)
function createOrUpdate(parameters: ProjectTask, groupName: string, serviceName: string, taskName: string, options: RequestOptionsBase, callback: ServiceCallback<ProjectTask>)Parameters
- parameters
- ProjectTask
Information about the task
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
createOrUpdate(ProjectTask, string, string, string, ServiceCallback<ProjectTask>)
function createOrUpdate(parameters: ProjectTask, groupName: string, serviceName: string, taskName: string, callback: ServiceCallback<ProjectTask>)Parameters
- parameters
- ProjectTask
Information about the task
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- callback
The callback
deleteMethod(string, string, string, ServiceCallback<void>)
function deleteMethod(groupName: string, serviceName: string, taskName: string, callback: ServiceCallback<void>)Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, string, string, ServiceTasksDeleteMethodOptionalParams)
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 deleteMethod(groupName: string, serviceName: string, taskName: string, options?: ServiceTasksDeleteMethodOptionalParams): Promise<RestResponse>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteMethod(string, string, string, ServiceTasksDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(groupName: string, serviceName: string, taskName: string, options: ServiceTasksDeleteMethodOptionalParams, callback: ServiceCallback<void>)Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
The optional parameters
- callback
-
ServiceCallback<void>
The callback
get(string, string, string, ServiceCallback<ProjectTask>)
function get(groupName: string, serviceName: string, taskName: string, callback: ServiceCallback<ProjectTask>)Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- callback
The callback
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<ServiceTasksGetResponse>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- options
- ServiceTasksGetOptionalParams
The optional parameters
Returns
Promise<ServiceTasksGetResponse>
Promise<Models.ServiceTasksGetResponse>
get(string, string, string, ServiceTasksGetOptionalParams, ServiceCallback<ProjectTask>)
function get(groupName: string, serviceName: string, taskName: string, options: ServiceTasksGetOptionalParams, callback: ServiceCallback<ProjectTask>)Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- options
- ServiceTasksGetOptionalParams
The optional parameters
- callback
The callback
list(string, string, ServiceCallback<TaskList>)
function list(groupName: string, serviceName: string, callback: ServiceCallback<TaskList>)Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- callback
The callback
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): Promise<ServiceTasksListResponse>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- ServiceTasksListOptionalParams
The optional parameters
Returns
Promise<ServiceTasksListResponse>
Promise<Models.ServiceTasksListResponse>
list(string, string, ServiceTasksListOptionalParams, ServiceCallback<TaskList>)
function list(groupName: string, serviceName: string, options: ServiceTasksListOptionalParams, callback: ServiceCallback<TaskList>)Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- ServiceTasksListOptionalParams
The optional parameters
- callback
The callback
listNext(string, RequestOptionsBase)
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 listNext(nextPageLink: string, options?: RequestOptionsBase): Promise<ServiceTasksListNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ServiceTasksListNextResponse>
Promise<Models.ServiceTasksListNextResponse>
listNext(string, RequestOptionsBase, ServiceCallback<TaskList>)
function listNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<TaskList>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listNext(string, ServiceCallback<TaskList>)
function listNext(nextPageLink: string, callback: ServiceCallback<TaskList>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback
update(ProjectTask, string, string, string, RequestOptionsBase)
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(parameters: ProjectTask, groupName: string, serviceName: string, taskName: string, options?: RequestOptionsBase): Promise<ServiceTasksUpdateResponse>Parameters
- parameters
- ProjectTask
Information about the task
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ServiceTasksUpdateResponse>
Promise<Models.ServiceTasksUpdateResponse>
update(ProjectTask, string, string, string, RequestOptionsBase, ServiceCallback<ProjectTask>)
function update(parameters: ProjectTask, groupName: string, serviceName: string, taskName: string, options: RequestOptionsBase, callback: ServiceCallback<ProjectTask>)Parameters
- parameters
- ProjectTask
Information about the task
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
update(ProjectTask, string, string, string, ServiceCallback<ProjectTask>)
function update(parameters: ProjectTask, groupName: string, serviceName: string, taskName: string, callback: ServiceCallback<ProjectTask>)Parameters
- parameters
- ProjectTask
Information about the task
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- taskName
-
string
Name of the Task
- callback
The callback