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

vw_pipeline_topologies

Name	Datatype	Description
description	text	field from the properties object
accountName	text	field from the properties object
kind	text	Topology kind.
parameters	text	field from the properties object
pipelineTopologyName	text	field from the properties object
processors	text	field from the properties object
resourceGroupName	text	field from the properties object
sinks	text	field from the properties object
sku	text	The SKU details.
sources	text	field from the properties object
subscriptionId	text	field from the properties object

pipeline_topologies

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	accountName, pipelineTopologyName, resourceGroupName, subscriptionId	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	accountName, resourceGroupName, subscriptionId	Retrieves a list of pipeline topologies that have been added to the account, if any, along with their JSON representation.
create_or_update	INSERT	accountName, pipelineTopologyName, resourceGroupName, subscriptionId, 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.
delete	DELETE	accountName, pipelineTopologyName, resourceGroupName, subscriptionId	Deletes a pipeline topology with the given name. This method should be called after all instances of the topology have been stopped and deleted.
update	UPDATE	accountName, pipelineTopologyName, resourceGroupName, subscriptionId	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.

SELECT examples

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

vw_pipeline_topologies

SELECT
description,
accountName,
kind,
parameters,
pipelineTopologyName,
processors,
resourceGroupName,
sinks,
sku,
sources,
subscriptionId
FROM azure.video_analyzer.vw_pipeline_topologies
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

pipeline_topologies

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

INSERT example

Use the following StackQL query and manifest file to create a new pipeline_topologies resource.

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: description
          value: string
        - name: parameters
          value:
            - - name: name
                value: string
              - name: type
                value: string
              - name: description
                value: string
              - name: default
                value: string
        - name: sources
          value:
            - - name: '@type'
                value: string
              - name: name
                value: string
        - name: processors
          value:
            - - name: '@type'
                value: string
              - name: name
                value: string
              - name: inputs
                value:
                  - - name: nodeName
                      value: string
        - name: sinks
          value:
            - - name: '@type'
                value: string
              - name: name
                value: string
              - name: inputs
                value:
                  - - name: nodeName
                      value: string
    - name: kind
      value: string
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string

UPDATE example

Updates a pipeline_topologies resource.

/*+ update */
UPDATE azure.video_analyzer.pipeline_topologies
SET 
properties = '{{ properties }}',
kind = '{{ kind }}',
sku = '{{ sku }}'
WHERE 
accountName = '{{ accountName }}'
AND pipelineTopologyName = '{{ pipelineTopologyName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified pipeline_topologies resource.

/*+ delete */
DELETE FROM azure.video_analyzer.pipeline_topologies
WHERE accountName = '{{ accountName }}'
AND pipelineTopologyName = '{{ pipelineTopologyName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';