live_pipelines

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

Overview

Name	live_pipelines
Type	Resource
Id	azure_extras.video_analyzer.live_pipelines

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
bitrateKbps	integer
description	string
parameters	array
state	string	Current state of the pipeline (read-only). Possible values include: "Inactive", "Activating", "Active", "Deactivating".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
topologyName	string
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
@nextLink	string
value	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	live_pipeline_name, account_name, resource_group_name, subscription_id		Retrieves a specific live pipeline by name. 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	account_name, resource_group_name, subscription_id	$filter, $top	Retrieves a list of live pipelines. Retrieves a list of live pipelines that have been created, along with their JSON representations.
create_or_update	insert	live_pipeline_name, account_name, resource_group_name, subscription_id		Creates or updates a live pipeline. Creates a new live pipeline or updates an existing one, with the given name.
update	update	live_pipeline_name, account_name, resource_group_name, subscription_id		Updates an existing live pipeline. 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.
create_or_update	replace	live_pipeline_name, account_name, resource_group_name, subscription_id		Creates or updates a live pipeline. Creates a new live pipeline or updates an existing one, with the given name.
delete	delete	live_pipeline_name, account_name, resource_group_name, subscription_id		Deletes a live pipeline. Deletes a live pipeline with the given name.
activate	exec	live_pipeline_name, account_name, resource_group_name, subscription_id		Activates a live pipeline. Activates a live pipeline with the given name.
deactivate	exec	live_pipeline_name, account_name, resource_group_name, subscription_id		Deactivates a live pipeline. 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
account_name	string	The Azure Video Analyzer account name.
live_pipeline_name	string	Live pipeline unique identifier.
resource_group_name	string	The name of the resource group. The name is case insensitive.
subscription_id	string
$filter	string	Restricts the set of items returned.
$top	integer	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. 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
id,
name,
bitrateKbps,
description,
parameters,
state,
systemData,
topologyName,
type
FROM azure_extras.video_analyzer.live_pipelines
WHERE live_pipeline_name = '{{ live_pipeline_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
@nextLink,
value
FROM azure_extras.video_analyzer.live_pipelines
WHERE account_name = '{{ account_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure_extras.video_analyzer.live_pipelines (
properties,
live_pipeline_name,
account_name,
resource_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ live_pipeline_name }}',
'{{ account_name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: live_pipelines
props:
  - name: live_pipeline_name
    value: "{{ live_pipeline_name }}"
    description: Required parameter for the live_pipelines resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the live_pipelines resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the live_pipelines resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the live_pipelines resource.
  - name: properties
    value:
      topologyName: "{{ topologyName }}"
      description: "{{ description }}"
      bitrateKbps: {{ bitrateKbps }}
      parameters:
        - name: "{{ name }}"
          value: "{{ value }}"

UPDATE examples

update

Updates an existing live pipeline. 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_extras.video_analyzer.live_pipelines
SET 
properties = '{{ properties }}'
WHERE 
live_pipeline_name = '{{ live_pipeline_name }}' --required
AND account_name = '{{ account_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

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

REPLACE azure_extras.video_analyzer.live_pipelines
SET 
properties = '{{ properties }}'
WHERE 
live_pipeline_name = '{{ live_pipeline_name }}' --required
AND account_name = '{{ account_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a live pipeline. Deletes a live pipeline with the given name.

DELETE FROM azure_extras.video_analyzer.live_pipelines
WHERE live_pipeline_name = '{{ live_pipeline_name }}' --required
AND account_name = '{{ account_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

activate

Activates a live pipeline. Activates a live pipeline with the given name.

EXEC azure_extras.video_analyzer.live_pipelines.activate 
@live_pipeline_name='{{ live_pipeline_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

deactivate

Deactivates a live pipeline. Deactivates a live pipeline with the given name.

EXEC azure_extras.video_analyzer.live_pipelines.deactivate 
@live_pipeline_name='{{ live_pipeline_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;