live_pipelines

Creates, updates, deletes, gets or lists a live_pipelines resource.

Overview

Name	live_pipelines
Type	Resource
Id	azure.video_analyzer.live_pipelines

Fields

The following fields are returned by SELECT queries:

get

The live pipeline was retrieved successfully.

Name	Datatype	Description
properties	object	The resource properties.

list

List of live pipelines that were successfully retrieved.

Name	Datatype	Description
properties	object	The resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, livePipelineName		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	select	subscriptionId, resourceGroupName, accountName	$filter, $top	Retrieves a list of live pipelines that have been created, along with their JSON representations.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, livePipelineName		Creates a new live pipeline or updates an existing one, with the given name.
update	update	subscriptionId, resourceGroupName, accountName, livePipelineName		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.
delete	delete	subscriptionId, resourceGroupName, accountName, livePipelineName		Deletes a live pipeline with the given name.
activate	exec	subscriptionId, resourceGroupName, accountName, livePipelineName		Activates a live pipeline with the given name.
deactivate	exec	subscriptionId, resourceGroupName, accountName, livePipelineName		Deactivates a live pipeline with the given name.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accountName	string	The Azure Video Analyzer account name.
livePipelineName	string	Live pipeline unique identifier.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$filter	string	Restricts the set of items returned.
$top	integer (int32)	Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.

SELECT examples

get

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.

SELECT
properties
FROM azure.video_analyzer.live_pipelines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND livePipelineName = '{{ livePipelineName }}' -- required
;

list

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

SELECT
properties
FROM azure.video_analyzer.live_pipelines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure.video_analyzer.live_pipelines (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
livePipelineName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ livePipelineName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: live_pipelines
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the live_pipelines resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the live_pipelines resource.
    - name: accountName
      value: string
      description: Required parameter for the live_pipelines resource.
    - name: livePipelineName
      value: string
      description: Required parameter for the live_pipelines resource.
    - name: properties
      value: object
      description: |
        The resource properties.

UPDATE examples

update

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.

UPDATE azure.video_analyzer.live_pipelines
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND livePipelineName = '{{ livePipelineName }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes a live pipeline with the given name.

DELETE FROM azure.video_analyzer.live_pipelines
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND livePipelineName = '{{ livePipelineName }}' --required
;

Lifecycle Methods

activate

Activates a live pipeline with the given name.

EXEC azure.video_analyzer.live_pipelines.activate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@livePipelineName='{{ livePipelineName }}' --required
;

deactivate

Deactivates a live pipeline with the given name.

EXEC azure.video_analyzer.live_pipelines.deactivate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@livePipelineName='{{ livePipelineName }}' --required
;