DataTransferJobs interface
Interface representing a DataTransferJobs.
Methods
| cancel(string, string, string, Data |
Cancels a Data Transfer Job. |
| complete(string, string, string, Data |
Completes a Data Transfer Online Job. |
| create(string, string, string, Create |
Creates a Data Transfer Job. |
| get(string, string, string, Data |
Get a Data Transfer Job. |
| list |
Get a list of Data Transfer jobs. |
| pause(string, string, string, Data |
Pause a Data Transfer Job. |
| resume(string, string, string, Data |
Resumes a Data Transfer Job. |
Method Details
cancel(string, string, string, DataTransferJobsCancelOptionalParams)
Cancels a Data Transfer Job.
function cancel(resourceGroupName: string, accountName: string, jobName: string, options?: DataTransferJobsCancelOptionalParams): Promise<DataTransferJobGetResults>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- jobName
-
string
Name of the Data Transfer Job
The options parameters.
Returns
Promise<DataTransferJobGetResults>
complete(string, string, string, DataTransferJobsCompleteOptionalParams)
Completes a Data Transfer Online Job.
function complete(resourceGroupName: string, accountName: string, jobName: string, options?: DataTransferJobsCompleteOptionalParams): Promise<DataTransferJobGetResults>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- jobName
-
string
Name of the Data Transfer Job
The options parameters.
Returns
Promise<DataTransferJobGetResults>
create(string, string, string, CreateJobRequest, DataTransferJobsCreateOptionalParams)
Creates a Data Transfer Job.
function create(resourceGroupName: string, accountName: string, jobName: string, jobCreateParameters: CreateJobRequest, options?: DataTransferJobsCreateOptionalParams): Promise<DataTransferJobGetResults>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- jobName
-
string
Name of the Data Transfer Job
- jobCreateParameters
- CreateJobRequest
Parameters to create Data Transfer Job
The options parameters.
Returns
Promise<DataTransferJobGetResults>
get(string, string, string, DataTransferJobsGetOptionalParams)
Get a Data Transfer Job.
function get(resourceGroupName: string, accountName: string, jobName: string, options?: DataTransferJobsGetOptionalParams): Promise<DataTransferJobGetResults>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- jobName
-
string
Name of the Data Transfer Job
The options parameters.
Returns
Promise<DataTransferJobGetResults>
listByDatabaseAccount(string, string, DataTransferJobsListByDatabaseAccountOptionalParams)
Get a list of Data Transfer jobs.
function listByDatabaseAccount(resourceGroupName: string, accountName: string, options?: DataTransferJobsListByDatabaseAccountOptionalParams): PagedAsyncIterableIterator<DataTransferJobGetResults, DataTransferJobGetResults[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
The options parameters.
Returns
pause(string, string, string, DataTransferJobsPauseOptionalParams)
Pause a Data Transfer Job.
function pause(resourceGroupName: string, accountName: string, jobName: string, options?: DataTransferJobsPauseOptionalParams): Promise<DataTransferJobGetResults>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- jobName
-
string
Name of the Data Transfer Job
The options parameters.
Returns
Promise<DataTransferJobGetResults>
resume(string, string, string, DataTransferJobsResumeOptionalParams)
Resumes a Data Transfer Job.
function resume(resourceGroupName: string, accountName: string, jobName: string, options?: DataTransferJobsResumeOptionalParams): Promise<DataTransferJobGetResults>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- jobName
-
string
Name of the Data Transfer Job
The options parameters.
Returns
Promise<DataTransferJobGetResults>
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for