Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PipelineTopologies

Package version

Interface representing a PipelineTopologies.

Hierarchy

  • PipelineTopologies

Implemented by

Index

Methods

createOrUpdate

  • 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.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • accountName: string

      The Azure Video Analyzer account name.

    • pipelineTopologyName: string

      Pipeline topology unique identifier.

    • parameters: PipelineTopology

      The request parameters

    • Optional options: PipelineTopologiesCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<PipelineTopologiesCreateOrUpdateResponse>

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.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • accountName: string

      The Azure Video Analyzer account name.

    • pipelineTopologyName: string

      Pipeline topology unique identifier.

    • Optional options: PipelineTopologiesDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

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.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • accountName: string

      The Azure Video Analyzer account name.

    • pipelineTopologyName: string

      Pipeline topology unique identifier.

    • Optional options: PipelineTopologiesGetOptionalParams

      The options parameters.

    Returns Promise<PipelineTopologiesGetResponse>

list

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.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • accountName: string

      The Azure Video Analyzer account name.

    • pipelineTopologyName: string

      Pipeline topology unique identifier.

    • parameters: PipelineTopologyUpdate

      The request parameters

    • Optional options: PipelineTopologiesUpdateOptionalParams

      The options parameters.

    Returns Promise<PipelineTopologiesUpdateResponse>

Generated using TypeDoc