DataTransferJobs | @azure/arm-cosmosdb

Interface representing a DataTransferJobs.

Hierarchy

DataTransferJobs

Implemented by

DataTransferJobsImpl

Index

Methods

cancel

cancel(resourceGroupName: string, accountName: string, jobName: string, options?: DataTransferJobsCancelOptionalParams): Promise<DataTransferJobsCancelResponse>

- Defined in operationsInterfaces/dataTransferJobs.ts:101
Cancels a Data Transfer Job.

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
- Optional options: DataTransferJobsCancelOptionalParams
  
  The options parameters.
Returns Promise<DataTransferJobsCancelResponse>

create

create(resourceGroupName: string, accountName: string, jobName: string, jobCreateParameters: CreateJobRequest, options?: DataTransferJobsCreateOptionalParams): Promise<DataTransferJobsCreateResponse>

- Defined in operationsInterfaces/dataTransferJobs.ts:48
Creates a Data Transfer Job.

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
- Optional options: DataTransferJobsCreateOptionalParams
  
  The options parameters.
Returns Promise<DataTransferJobsCreateResponse>

get

get(resourceGroupName: string, accountName: string, jobName: string, options?: DataTransferJobsGetOptionalParams): Promise<DataTransferJobsGetResponse>

- Defined in operationsInterfaces/dataTransferJobs.ts:62
Get a Data Transfer Job.

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
- Optional options: DataTransferJobsGetOptionalParams
  
  The options parameters.
Returns Promise<DataTransferJobsGetResponse>

listByDatabaseAccount

listByDatabaseAccount(resourceGroupName: string, accountName: string, options?: DataTransferJobsListByDatabaseAccountOptionalParams): PagedAsyncIterableIterator<DataTransferJobGetResults>

- Defined in operationsInterfaces/dataTransferJobs.ts:35
Get a list of Data Transfer jobs.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- Optional options: DataTransferJobsListByDatabaseAccountOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DataTransferJobGetResults>

pause

pause(resourceGroupName: string, accountName: string, jobName: string, options?: DataTransferJobsPauseOptionalParams): Promise<DataTransferJobsPauseResponse>

- Defined in operationsInterfaces/dataTransferJobs.ts:75
Pause a Data Transfer Job.

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
- Optional options: DataTransferJobsPauseOptionalParams
  
  The options parameters.
Returns Promise<DataTransferJobsPauseResponse>

resume

resume(resourceGroupName: string, accountName: string, jobName: string, options?: DataTransferJobsResumeOptionalParams): Promise<DataTransferJobsResumeResponse>

- Defined in operationsInterfaces/dataTransferJobs.ts:88
Resumes a Data Transfer Job.

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
- Optional options: DataTransferJobsResumeOptionalParams
  
  The options parameters.
Returns Promise<DataTransferJobsResumeResponse>

Hierarchy

Implemented by

Index

Methods

Methods

cancel

Parameters

resourceGroupName: string

accountName: string

jobName: string

Optional options: DataTransferJobsCancelOptionalParams

Returns Promise<DataTransferJobsCancelResponse>

create

Parameters

resourceGroupName: string

accountName: string

jobName: string

jobCreateParameters: CreateJobRequest

Optional options: DataTransferJobsCreateOptionalParams

Returns Promise<DataTransferJobsCreateResponse>

get

Parameters

resourceGroupName: string

accountName: string

jobName: string

Optional options: DataTransferJobsGetOptionalParams

Returns Promise<DataTransferJobsGetResponse>

listByDatabaseAccount

Parameters

resourceGroupName: string

accountName: string

Optional options: DataTransferJobsListByDatabaseAccountOptionalParams

Returns PagedAsyncIterableIterator<DataTransferJobGetResults>

pause

Parameters

resourceGroupName: string

accountName: string

jobName: string

Optional options: DataTransferJobsPauseOptionalParams

Returns Promise<DataTransferJobsPauseResponse>

resume

Parameters

resourceGroupName: string

accountName: string

jobName: string

Optional options: DataTransferJobsResumeOptionalParams

Returns Promise<DataTransferJobsResumeResponse>