PipelineTopologies interface
Interface representing a PipelineTopologies.
Methods
| create |
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(string, string, string, Pipeline |
Deletes a pipeline topology with the given name. This method should be called after all instances of the topology have been stopped and deleted. |
| get(string, string, string, Pipeline |
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(string, string, Pipeline |
Retrieves a list of pipeline topologies that have been added to the account, if any, along with their JSON representation. |
| update(string, string, string, Pipeline |
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. |
Method Details
createOrUpdate(string, string, string, PipelineTopology, PipelineTopologiesCreateOrUpdateOptionalParams)
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.
function createOrUpdate(resourceGroupName: string, accountName: string, pipelineTopologyName: string, parameters: PipelineTopology, options?: PipelineTopologiesCreateOrUpdateOptionalParams): Promise<PipelineTopology>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
The options parameters.
Returns
Promise<PipelineTopology>
delete(string, string, string, PipelineTopologiesDeleteOptionalParams)
Deletes a pipeline topology with the given name. This method should be called after all instances of the topology have been stopped and deleted.
function delete(resourceGroupName: string, accountName: string, pipelineTopologyName: string, options?: PipelineTopologiesDeleteOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
get(string, string, string, PipelineTopologiesGetOptionalParams)
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.
function get(resourceGroupName: string, accountName: string, pipelineTopologyName: string, options?: PipelineTopologiesGetOptionalParams): Promise<PipelineTopology>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.
The options parameters.
Returns
Promise<PipelineTopology>
list(string, string, PipelineTopologiesListOptionalParams)
Retrieves a list of pipeline topologies that have been added to the account, if any, along with their JSON representation.
function list(resourceGroupName: string, accountName: string, options?: PipelineTopologiesListOptionalParams): PagedAsyncIterableIterator<PipelineTopology, PipelineTopology[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
The Azure Video Analyzer account name.
The options parameters.
Returns
update(string, string, string, PipelineTopologyUpdate, PipelineTopologiesUpdateOptionalParams)
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.
function update(resourceGroupName: string, accountName: string, pipelineTopologyName: string, parameters: PipelineTopologyUpdate, options?: PipelineTopologiesUpdateOptionalParams): Promise<PipelineTopology>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
The options parameters.
Returns
Promise<PipelineTopology>
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for