Interface DataTransferJobs

Package version

Interface representing a DataTransferJobs.

Hierarchy

DataTransferJobs

Implemented by

DataTransferJobsImpl

Index

Methods

Methods

create

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

- Defined in operationsInterfaces/dataTransferJobs.ts:42
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:56
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:29
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>

Generated using TypeDoc