LivePipelines interface

Package:

@azure/arm-videoanalyzer

Interface representing a LivePipelines.

Methods

beginActivate(string, string, string, LivePipelinesActivateOptionalParams)	Activates a live pipeline with the given name.
beginActivateAndWait(string, string, string, LivePipelinesActivateOptionalParams)	Activates a live pipeline with the given name.
beginDeactivate(string, string, string, LivePipelinesDeactivateOptionalParams)	Deactivates a live pipeline with the given name.
beginDeactivateAndWait(string, string, string, LivePipelinesDeactivateOptionalParams)	Deactivates a live pipeline with the given name.
createOrUpdate(string, string, string, LivePipeline, LivePipelinesCreateOrUpdateOptionalParams)	Creates a new live pipeline or updates an existing one, with the given name.
delete(string, string, string, LivePipelinesDeleteOptionalParams)	Deletes a live pipeline with the given name.
get(string, string, string, LivePipelinesGetOptionalParams)	Retrieves a specific live pipeline by name. If a live pipeline with that name has been previously created, the call will return the JSON representation of that instance.
list(string, string, LivePipelinesListOptionalParams)	Retrieves a list of live pipelines that have been created, along with their JSON representations.
update(string, string, string, LivePipelineUpdate, LivePipelinesUpdateOptionalParams)	Updates an existing live pipeline with the given name. Properties that can be updated include: description, bitrateKbps, and parameter definitions. Only the description can be updated while the live pipeline is active.

Method Details

beginActivate(string, string, string, LivePipelinesActivateOptionalParams)

Activates a live pipeline with the given name.

function beginActivate(resourceGroupName: string, accountName: string, livePipelineName: string, options?: LivePipelinesActivateOptionalParams): 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.

livePipelineName

string

Live pipeline unique identifier.

options

LivePipelinesActivateOptionalParams

The options parameters.

Returns

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

beginActivateAndWait(string, string, string, LivePipelinesActivateOptionalParams)

Activates a live pipeline with the given name.

function beginActivateAndWait(resourceGroupName: string, accountName: string, livePipelineName: string, options?: LivePipelinesActivateOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

accountName

string

The Azure Video Analyzer account name.

livePipelineName

string

Live pipeline unique identifier.

options

LivePipelinesActivateOptionalParams

The options parameters.

Returns

Promise<void>

beginDeactivate(string, string, string, LivePipelinesDeactivateOptionalParams)

Deactivates a live pipeline with the given name.

function beginDeactivate(resourceGroupName: string, accountName: string, livePipelineName: string, options?: LivePipelinesDeactivateOptionalParams): 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.

livePipelineName

string

Live pipeline unique identifier.

options

LivePipelinesDeactivateOptionalParams

The options parameters.

Returns

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

beginDeactivateAndWait(string, string, string, LivePipelinesDeactivateOptionalParams)

Deactivates a live pipeline with the given name.

function beginDeactivateAndWait(resourceGroupName: string, accountName: string, livePipelineName: string, options?: LivePipelinesDeactivateOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

accountName

string

The Azure Video Analyzer account name.

livePipelineName

string

Live pipeline unique identifier.

options

LivePipelinesDeactivateOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, string, LivePipeline, LivePipelinesCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, accountName: string, livePipelineName: string, parameters: LivePipeline, options?: LivePipelinesCreateOrUpdateOptionalParams): Promise<LivePipeline>

Parameters

resourceGroupName

string

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

accountName

string

The Azure Video Analyzer account name.

livePipelineName

string

Live pipeline unique identifier.

parameters

LivePipeline

The request parameters

options

LivePipelinesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<LivePipeline>

delete(string, string, string, LivePipelinesDeleteOptionalParams)

Deletes a live pipeline with the given name.

function delete(resourceGroupName: string, accountName: string, livePipelineName: string, options?: LivePipelinesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

accountName

string

The Azure Video Analyzer account name.

livePipelineName

string

Live pipeline unique identifier.

options

LivePipelinesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, LivePipelinesGetOptionalParams)

Retrieves a specific live pipeline by name. If a live pipeline with that name has been previously created, the call will return the JSON representation of that instance.

function get(resourceGroupName: string, accountName: string, livePipelineName: string, options?: LivePipelinesGetOptionalParams): Promise<LivePipeline>

Parameters

resourceGroupName

string

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

accountName

string

The Azure Video Analyzer account name.

livePipelineName

string

Live pipeline unique identifier.

options

LivePipelinesGetOptionalParams

The options parameters.

Returns

Promise<LivePipeline>

list(string, string, LivePipelinesListOptionalParams)

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

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

Parameters

resourceGroupName

string

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

accountName

string

The Azure Video Analyzer account name.

options

LivePipelinesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LivePipeline, LivePipeline[], PageSettings>

update(string, string, string, LivePipelineUpdate, LivePipelinesUpdateOptionalParams)

Updates an existing live pipeline with the given name. Properties that can be updated include: description, bitrateKbps, and parameter definitions. Only the description can be updated while the live pipeline is active.

function update(resourceGroupName: string, accountName: string, livePipelineName: string, parameters: LivePipelineUpdate, options?: LivePipelinesUpdateOptionalParams): Promise<LivePipeline>

Parameters

resourceGroupName

string

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

accountName

string

The Azure Video Analyzer account name.

livePipelineName

string

Live pipeline unique identifier.

parameters

LivePipelineUpdate

The request parameters

options

LivePipelinesUpdateOptionalParams

The options parameters.

Returns

Promise<LivePipeline>