LivePipelinesImpl | @azure/arm-videoanalyzer

Class containing LivePipelines operations.

Hierarchy

LivePipelinesImpl

Implements

LivePipelines

Index

Constructors

constructor

Methods

Constructors

constructor

new LivePipelinesImpl(client: VideoAnalyzerManagementClient): LivePipelinesImpl

- Defined in operations/livePipelines.ts:38
Initialize a new instance of the class LivePipelines class.

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

Methods

beginActivate

beginActivate(resourceGroupName: string, accountName: string, livePipelineName: string, options?: LivePipelinesActivateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of LivePipelines.beginActivate
- Defined in operations/livePipelines.ts:214
Activates a live pipeline 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.
- livePipelineName: string
  
  Live pipeline unique identifier.
- Optional options: LivePipelinesActivateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginActivateAndWait

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

Implementation of LivePipelines.beginActivateAndWait
- Defined in operations/livePipelines.ts:277
Activates a live pipeline 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.
- livePipelineName: string
  
  Live pipeline unique identifier.
- Optional options: LivePipelinesActivateOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeactivate

beginDeactivate(resourceGroupName: string, accountName: string, livePipelineName: string, options?: LivePipelinesDeactivateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of LivePipelines.beginDeactivate
- Defined in operations/livePipelines.ts:299
Deactivates a live pipeline 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.
- livePipelineName: string
  
  Live pipeline unique identifier.
- Optional options: LivePipelinesDeactivateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeactivateAndWait

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

Implementation of LivePipelines.beginDeactivateAndWait
- Defined in operations/livePipelines.ts:362
Deactivates a live pipeline 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.
- livePipelineName: string
  
  Live pipeline unique identifier.
- Optional options: LivePipelinesDeactivateOptionalParams
  
  The options parameters.
Returns Promise<void>

createOrUpdate

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

Implementation of LivePipelines.createOrUpdate
- Defined in operations/livePipelines.ts:152
Creates a new live pipeline 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.
- livePipelineName: string
  
  Live pipeline unique identifier.
- parameters: LivePipeline
  
  The request parameters
- Optional options: LivePipelinesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<LivePipelinesCreateOrUpdateResponse>

delete

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

Implementation of LivePipelines.delete
- Defined in operations/livePipelines.ts:172
Deletes a live pipeline 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.
- livePipelineName: string
  
  Live pipeline unique identifier.
- Optional options: LivePipelinesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

Implementation of LivePipelines.get
- Defined in operations/livePipelines.ts:132
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.

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

list

list(resourceGroupName: string, accountName: string, options?: LivePipelinesListOptionalParams): PagedAsyncIterableIterator<LivePipeline>

Implementation of LivePipelines.list
- Defined in operations/livePipelines.ts:54
Retrieves a list of 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: LivePipelinesListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<LivePipeline>

update

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

Implementation of LivePipelines.update
- Defined in operations/livePipelines.ts:194
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.

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

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: VideoAnalyzerManagementClient

Returns LivePipelinesImpl

Methods

beginActivate

Parameters

resourceGroupName: string

accountName: string

livePipelineName: string

Optional options: LivePipelinesActivateOptionalParams

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

beginActivateAndWait

Parameters

resourceGroupName: string

accountName: string

livePipelineName: string

Optional options: LivePipelinesActivateOptionalParams

Returns Promise<void>

beginDeactivate

Parameters

resourceGroupName: string

accountName: string

livePipelineName: string

Optional options: LivePipelinesDeactivateOptionalParams

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

beginDeactivateAndWait

Parameters

resourceGroupName: string

accountName: string

livePipelineName: string

Optional options: LivePipelinesDeactivateOptionalParams

Returns Promise<void>

createOrUpdate

Parameters

resourceGroupName: string

accountName: string

livePipelineName: string

parameters: LivePipeline

Optional options: LivePipelinesCreateOrUpdateOptionalParams

Returns Promise<LivePipelinesCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

accountName: string

livePipelineName: string

Optional options: LivePipelinesDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

accountName: string

livePipelineName: string

Optional options: LivePipelinesGetOptionalParams

Returns Promise<LivePipelinesGetResponse>

list

Parameters

resourceGroupName: string

accountName: string

Optional options: LivePipelinesListOptionalParams

Returns PagedAsyncIterableIterator<LivePipeline>

update

Parameters

resourceGroupName: string

accountName: string

livePipelineName: string

parameters: LivePipelineUpdate

Optional options: LivePipelinesUpdateOptionalParams

Returns Promise<LivePipelinesUpdateResponse>