Share via


PipelineTopologyUpdate Class

Definition

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. For instance, a pipeline topology which captures content from a RTSP camera and archives the content can be reused across many different cameras, as long as the same processing is to be applied across all the cameras. Individual instance properties can be defined through the use of user-defined parameters, which allow for a topology to be parameterized. This allows individual pipelines refer to different values, such as individual cameras' RTSP endpoints and credentials. Overall a topology is composed of the following:

  • Parameters: list of user defined parameters that can be references across the topology nodes.
  • Sources: list of one or more data sources nodes such as an RTSP source which allows for content to be ingested from cameras.
  • Processors: list of nodes which perform data analysis or transformations.
  • Sinks: list of one or more data sinks which allow for data to be stored or exported to other destinations.
[Microsoft.Rest.Serialization.JsonTransformation]
public class PipelineTopologyUpdate : Microsoft.Azure.Management.VideoAnalyzer.Models.ProxyResource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type PipelineTopologyUpdate = class
    inherit ProxyResource
Public Class PipelineTopologyUpdate
Inherits ProxyResource
Inheritance
PipelineTopologyUpdate
Attributes

Constructors

PipelineTopologyUpdate()

Initializes a new instance of the PipelineTopologyUpdate class.

PipelineTopologyUpdate(String, String, String, SystemData, String, IList<ParameterDeclaration>, IList<SourceNodeBase>, IList<ProcessorNodeBase>, IList<SinkNodeBase>, Nullable<Kind>, Sku)

Initializes a new instance of the PipelineTopologyUpdate class.

Properties

Description

Gets or sets an optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here.

Id

Gets fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

(Inherited from Resource)
Kind

Gets or sets topology kind. Possible values include: 'Live', 'Batch'

Name

Gets the name of the resource

(Inherited from Resource)
Parameters

Gets or sets list of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline.

Processors

Gets or sets list of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed.

Sinks

Gets or sets list of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported.

Sku

Gets or sets describes the properties of a SKU.

Sources

Gets or sets list of the topology source nodes. Source nodes enable external data to be ingested by the pipeline.

SystemData

Gets azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from Resource)
Type

Gets the type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

(Inherited from Resource)

Methods

Validate()

Validate the object.

Applies to