PipelineJobs interface

Interface representing a PipelineJobs.

Methods

beginCancel(string, string, string, PipelineJobsCancelOptionalParams)

Cancels a pipeline job with the given name.

beginCancelAndWait(string, string, string, PipelineJobsCancelOptionalParams)

Cancels a pipeline job with the given name.

createOrUpdate(string, string, string, PipelineJob, PipelineJobsCreateOrUpdateOptionalParams)

Creates a new pipeline job or updates an existing one, with the given name.

delete(string, string, string, PipelineJobsDeleteOptionalParams)

Deletes a pipeline job with the given name.

get(string, string, string, PipelineJobsGetOptionalParams)

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.

list(string, string, PipelineJobsListOptionalParams)

Retrieves a list of all live pipelines that have been created, along with their JSON representations.

update(string, string, string, PipelineJobUpdate, PipelineJobsUpdateOptionalParams)

Updates an existing pipeline job with the given name. Properties that can be updated include: description.

Method Details

beginCancel(string, string, string, PipelineJobsCancelOptionalParams)

Cancels a pipeline job with the given name.

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

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.

options
PipelineJobsCancelOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginCancelAndWait(string, string, string, PipelineJobsCancelOptionalParams)

Cancels a pipeline job with the given name.

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

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.

options
PipelineJobsCancelOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, string, PipelineJob, PipelineJobsCreateOrUpdateOptionalParams)

Creates a new pipeline job or updates an existing one, with the given name.

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

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

options
PipelineJobsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PipelineJob>

delete(string, string, string, PipelineJobsDeleteOptionalParams)

Deletes a pipeline job with the given name.

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

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.

options
PipelineJobsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, PipelineJobsGetOptionalParams)

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.

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

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.

options
PipelineJobsGetOptionalParams

The options parameters.

Returns

Promise<PipelineJob>

list(string, string, PipelineJobsListOptionalParams)

Retrieves a list of all live pipelines that have been created, along with their JSON representations.

function list(resourceGroupName: string, accountName: string, options?: PipelineJobsListOptionalParams): PagedAsyncIterableIterator<PipelineJob, PipelineJob[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The Azure Video Analyzer account name.

options
PipelineJobsListOptionalParams

The options parameters.

Returns

update(string, string, string, PipelineJobUpdate, PipelineJobsUpdateOptionalParams)

Updates an existing pipeline job with the given name. Properties that can be updated include: description.

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

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

options
PipelineJobsUpdateOptionalParams

The options parameters.

Returns

Promise<PipelineJob>