PipelineJobsImpl | @azure/arm-videoanalyzer

Class containing PipelineJobs operations.

Hierarchy

PipelineJobsImpl

Implements

PipelineJobs

Index

Constructors

constructor

Methods

Constructors

constructor

new PipelineJobsImpl(client: VideoAnalyzerManagementClient): PipelineJobsImpl

- Defined in operations/pipelineJobs.ts:37
Initialize a new instance of the class PipelineJobs class.

Parameters
- client: VideoAnalyzerManagementClient
  
  Reference to the service client
Returns PipelineJobsImpl

Methods

beginCancel

beginCancel(resourceGroupName: string, accountName: string, pipelineJobName: string, options?: PipelineJobsCancelOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of PipelineJobs.beginCancel
- Defined in operations/pipelineJobs.ts:214
Cancels a pipeline job with the given name.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  The Azure Video Analyzer account name.
- pipelineJobName: string
  
  The pipeline job name.
- Optional options: PipelineJobsCancelOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginCancelAndWait

beginCancelAndWait(resourceGroupName: string, accountName: string, pipelineJobName: string, options?: PipelineJobsCancelOptionalParams): Promise<void>

Implementation of PipelineJobs.beginCancelAndWait
- Defined in operations/pipelineJobs.ts:277
Cancels a pipeline job with the given name.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  The Azure Video Analyzer account name.
- pipelineJobName: string
  
  The pipeline job name.
- Optional options: PipelineJobsCancelOptionalParams
  
  The options parameters.
Returns Promise<void>

createOrUpdate

createOrUpdate(resourceGroupName: string, accountName: string, pipelineJobName: string, parameters: PipelineJob, options?: PipelineJobsCreateOrUpdateOptionalParams): Promise<PipelineJobsCreateOrUpdateResponse>

Implementation of PipelineJobs.createOrUpdate
- Defined in operations/pipelineJobs.ts:153
Creates a new pipeline job or updates an existing one, with the given name.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  The Azure Video Analyzer account name.
- pipelineJobName: string
  
  The pipeline job name.
- parameters: PipelineJob
  
  The request parameters
- Optional options: PipelineJobsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PipelineJobsCreateOrUpdateResponse>

delete

delete(resourceGroupName: string, accountName: string, pipelineJobName: string, options?: PipelineJobsDeleteOptionalParams): Promise<void>

Implementation of PipelineJobs.delete
- Defined in operations/pipelineJobs.ts:173
Deletes a pipeline job with the given name.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  The Azure Video Analyzer account name.
- pipelineJobName: string
  
  The pipeline job name.
- Optional options: PipelineJobsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, accountName: string, pipelineJobName: string, options?: PipelineJobsGetOptionalParams): Promise<PipelineJobsGetResponse>

Implementation of PipelineJobs.get
- Defined in operations/pipelineJobs.ts:133
Retrieves a specific pipeline job by name. If a pipeline job with that name has been previously created, the call will return the JSON representation of that instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  The Azure Video Analyzer account name.
- pipelineJobName: string
  
  The pipeline job name.
- Optional options: PipelineJobsGetOptionalParams
  
  The options parameters.
Returns Promise<PipelineJobsGetResponse>

list

list(resourceGroupName: string, accountName: string, options?: PipelineJobsListOptionalParams): PagedAsyncIterableIterator<PipelineJob>

Implementation of PipelineJobs.list
- Defined in operations/pipelineJobs.ts:54
Retrieves a list of all live pipelines that have been created, along with their JSON representations.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  The Azure Video Analyzer account name.
- Optional options: PipelineJobsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PipelineJob>

update

update(resourceGroupName: string, accountName: string, pipelineJobName: string, parameters: PipelineJobUpdate, options?: PipelineJobsUpdateOptionalParams): Promise<PipelineJobsUpdateResponse>

Implementation of PipelineJobs.update
- Defined in operations/pipelineJobs.ts:194
Updates an existing pipeline job with the given name. Properties that can be updated include: description.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  The Azure Video Analyzer account name.
- pipelineJobName: string
  
  The pipeline job name.
- parameters: PipelineJobUpdate
  
  The request parameters
- Optional options: PipelineJobsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PipelineJobsUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: VideoAnalyzerManagementClient

Returns PipelineJobsImpl

Methods

beginCancel

Parameters

resourceGroupName: string

accountName: string

pipelineJobName: string

Optional options: PipelineJobsCancelOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginCancelAndWait

Parameters

resourceGroupName: string

accountName: string

pipelineJobName: string

Optional options: PipelineJobsCancelOptionalParams

Returns Promise<void>

createOrUpdate

Parameters

resourceGroupName: string

accountName: string

pipelineJobName: string

parameters: PipelineJob

Optional options: PipelineJobsCreateOrUpdateOptionalParams

Returns Promise<PipelineJobsCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

accountName: string

pipelineJobName: string

Optional options: PipelineJobsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

accountName: string

pipelineJobName: string

Optional options: PipelineJobsGetOptionalParams

Returns Promise<PipelineJobsGetResponse>

list

Parameters

resourceGroupName: string

accountName: string

Optional options: PipelineJobsListOptionalParams

Returns PagedAsyncIterableIterator<PipelineJob>

update

Parameters

resourceGroupName: string

accountName: string

pipelineJobName: string

parameters: PipelineJobUpdate

Optional options: PipelineJobsUpdateOptionalParams

Returns Promise<PipelineJobsUpdateResponse>