@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.82 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* 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.
*
* Uses Azure REST API version 2021-11-01-preview. In version 2.x of the Azure Native provider, it used API version 2021-11-01-preview.
*/
export declare class PipelineTopology extends pulumi.CustomResource {
/**
* Get an existing PipelineTopology resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): PipelineTopology;
/**
* Returns true if the given object is an instance of PipelineTopology. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is PipelineTopology;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Topology kind.
*/
readonly kind: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* 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.
*/
readonly parameters: pulumi.Output<outputs.videoanalyzer.ParameterDeclarationResponse[] | undefined>;
/**
* List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed.
*/
readonly processors: pulumi.Output<outputs.videoanalyzer.EncoderProcessorResponse[] | undefined>;
/**
* List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported.
*/
readonly sinks: pulumi.Output<outputs.videoanalyzer.VideoSinkResponse[]>;
/**
* Describes the properties of a SKU.
*/
readonly sku: pulumi.Output<outputs.videoanalyzer.SkuResponse>;
/**
* List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline.
*/
readonly sources: pulumi.Output<(outputs.videoanalyzer.RtspSourceResponse | outputs.videoanalyzer.VideoSourceResponse)[]>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.videoanalyzer.SystemDataResponse>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a PipelineTopology resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: PipelineTopologyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a PipelineTopology resource.
*/
export interface PipelineTopologyArgs {
/**
* The Azure Video Analyzer account name.
*/
accountName: pulumi.Input<string>;
/**
* An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here.
*/
description?: pulumi.Input<string>;
/**
* Topology kind.
*/
kind: pulumi.Input<string | enums.videoanalyzer.Kind>;
/**
* 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.
*/
parameters?: pulumi.Input<pulumi.Input<inputs.videoanalyzer.ParameterDeclarationArgs>[]>;
/**
* Pipeline topology unique identifier.
*/
pipelineTopologyName?: pulumi.Input<string>;
/**
* List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed.
*/
processors?: pulumi.Input<pulumi.Input<inputs.videoanalyzer.EncoderProcessorArgs>[]>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported.
*/
sinks: pulumi.Input<pulumi.Input<inputs.videoanalyzer.VideoSinkArgs>[]>;
/**
* Describes the properties of a SKU.
*/
sku: pulumi.Input<inputs.videoanalyzer.SkuArgs>;
/**
* List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline.
*/
sources: pulumi.Input<pulumi.Input<inputs.videoanalyzer.RtspSourceArgs | inputs.videoanalyzer.VideoSourceArgs>[]>;
}