pipeline_topologies

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

Overview

Name	pipeline_topologies
Type	Resource
Id	azure_extras.video_analyzer.pipeline_topologies

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.
description	string
kind	string
parameters	array
processors	array
sinks	array
sku	object	The SKU details. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure.
sources	array
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	pipeline_topology_name, account_name, resource_group_name, subscription_id		Retrieves a specific pipeline topology by name. 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	account_name, resource_group_name, subscription_id	$filter, $top	Retrieves a list of pipeline topologies. Retrieves a list of pipeline topologies that have been added to the account, if any, along with their JSON representation.
create_or_update	insert	pipeline_topology_name, account_name, resource_group_name, subscription_id, kind, sku		Creates or updates a pipeline topology. 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	pipeline_topology_name, account_name, resource_group_name, subscription_id		Updates an existing pipeline topology. 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.
create_or_update	replace	pipeline_topology_name, account_name, resource_group_name, subscription_id, kind, sku		Creates or updates a pipeline topology. 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	pipeline_topology_name, account_name, resource_group_name, subscription_id		Deletes a pipeline topology. 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
account_name	string	The Azure Video Analyzer account name.
pipeline_topology_name	string	Pipeline topology 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 pipeline topology by name. 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
id,
name,
description,
kind,
parameters,
processors,
sinks,
sku,
sources,
systemData,
type
FROM azure_extras.video_analyzer.pipeline_topologies
WHERE pipeline_topology_name = '{{ pipeline_topology_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 pipeline topologies. Retrieves a list of pipeline topologies that have been added to the account, if any, along with their JSON representation.

SELECT
@nextLink,
value
FROM azure_extras.video_analyzer.pipeline_topologies
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 pipeline topology. 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_extras.video_analyzer.pipeline_topologies (
kind,
sku,
properties,
pipeline_topology_name,
account_name,
resource_group_name,
subscription_id
)
SELECT 
'{{ kind }}' /* required */,
'{{ sku }}' /* required */,
'{{ properties }}',
'{{ pipeline_topology_name }}',
'{{ account_name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
properties,
sku,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: pipeline_topologies
props:
  - name: pipeline_topology_name
    value: "{{ pipeline_topology_name }}"
    description: Required parameter for the pipeline_topologies resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the pipeline_topologies resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the pipeline_topologies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the pipeline_topologies resource.
  - name: kind
    value: "{{ kind }}"
  - name: sku
    description: |
      The SKU details. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
  - name: properties
    value:
      description: "{{ description }}"
      parameters:
        - name: "{{ name }}"
          type: "{{ type }}"
          description: "{{ description }}"
          default: "{{ default }}"
      sources:
        - @type: "{{ @type }}"
          name: "{{ name }}"
      processors:
        - @type: "{{ @type }}"
          name: "{{ name }}"
          inputs: "{{ inputs }}"
      sinks:
        - @type: "{{ @type }}"
          name: "{{ name }}"
          inputs: "{{ inputs }}"

UPDATE examples

update

Updates an existing pipeline topology. 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_extras.video_analyzer.pipeline_topologies
SET 
kind = '{{ kind }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
pipeline_topology_name = '{{ pipeline_topology_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,
kind,
properties,
sku,
systemData,
type;

REPLACE examples

create_or_update

Creates or updates a pipeline topology. 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.

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

DELETE examples

delete

Deletes a pipeline topology. 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_extras.video_analyzer.pipeline_topologies
WHERE pipeline_topology_name = '{{ pipeline_topology_name }}' --required
AND account_name = '{{ account_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;