pipeline_topologies

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

Overview

Name	pipeline_topologies
Type	Resource
Id	azure.video_analyzer.pipeline_topologies

Fields

The following fields are returned by SELECT queries:

get

Pipeline topology was retrieved successfully.

Name	Datatype	Description
kind	string	Topology kind.
properties	object	The resource properties.
sku	object	Describes the properties of a SKU.

list

Pipeline topologies were successfully retrieved.

Name	Datatype	Description
kind	string	Topology kind.
properties	object	The resource properties.
sku	object	Describes the properties of a SKU.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, pipelineTopologyName		Retrieves a specific pipeline topology by name. If a topology with that name has been previously created, the call will return the JSON representation of that topology.
list	select	subscriptionId, resourceGroupName, accountName	$filter, $top	Retrieves a list of pipeline topologies that have been added to the account, if any, along with their JSON representation.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, pipelineTopologyName, data__kind, data__sku		Creates a new pipeline topology or updates an existing one, with the given name. A pipeline topology describes the processing steps to be applied when processing content for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics.
update	update	subscriptionId, resourceGroupName, accountName, pipelineTopologyName		Updates an existing pipeline topology with the given name. If the associated live pipelines or pipeline jobs are in active or processing state, respectively, then only the description can be updated. Else, the properties that can be updated include: description, parameter declarations, sources, processors, and sinks.
delete	delete	subscriptionId, resourceGroupName, accountName, pipelineTopologyName		Deletes a pipeline topology with the given name. This method should be called after all instances of the topology have been stopped and deleted.

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.
pipelineTopologyName	string	Pipeline topology 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 pipeline topology by name. If a topology with that name has been previously created, the call will return the JSON representation of that topology.

SELECT
kind,
properties,
sku
FROM azure.video_analyzer.pipeline_topologies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND pipelineTopologyName = '{{ pipelineTopologyName }}' -- required
;

list

Retrieves a list of pipeline topologies that have been added to the account, if any, along with their JSON representation.

SELECT
kind,
properties,
sku
FROM azure.video_analyzer.pipeline_topologies
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 pipeline topology or updates an existing one, with the given name. A pipeline topology describes the processing steps to be applied when processing content for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics.

INSERT INTO azure.video_analyzer.pipeline_topologies (
data__properties,
data__kind,
data__sku,
subscriptionId,
resourceGroupName,
accountName,
pipelineTopologyName
)
SELECT 
'{{ properties }}',
'{{ kind }}' /* required */,
'{{ sku }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ pipelineTopologyName }}'
RETURNING
kind,
properties,
sku
;

Manifest

# Description fields are for documentation purposes
- name: pipeline_topologies
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the pipeline_topologies resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the pipeline_topologies resource.
    - name: accountName
      value: string
      description: Required parameter for the pipeline_topologies resource.
    - name: pipelineTopologyName
      value: string
      description: Required parameter for the pipeline_topologies resource.
    - name: properties
      value: object
      description: |
        The resource properties.
    - name: kind
      value: string
      description: |
        Topology kind.
      valid_values: ['Live', 'Batch']
    - name: sku
      value: object
      description: |
        Describes the properties of a SKU.

UPDATE examples

update

Updates an existing pipeline topology with the given name. If the associated live pipelines or pipeline jobs are in active or processing state, respectively, then only the description can be updated. Else, the properties that can be updated include: description, parameter declarations, sources, processors, and sinks.

UPDATE azure.video_analyzer.pipeline_topologies
SET 
data__properties = '{{ properties }}',
data__kind = '{{ kind }}',
data__sku = '{{ sku }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND pipelineTopologyName = '{{ pipelineTopologyName }}' --required
RETURNING
kind,
properties,
sku;

DELETE examples

delete

Deletes a pipeline topology with the given name. This method should be called after all instances of the topology have been stopped and deleted.

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