1. Packages
  2. Azure Native
  3. API Docs
  4. videoanalyzer
  5. LivePipeline
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi

azure-native.videoanalyzer.LivePipeline

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi

    Live pipeline represents a unique instance of a live topology, used for real-time ingestion, archiving and publishing of content for a unique RTSP camera. Azure REST API version: 2021-11-01-preview. Prior API version in Azure Native 1.x: 2021-11-01-preview.

    Example Usage

    Create or update a live pipeline

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var livePipeline = new AzureNative.VideoAnalyzer.LivePipeline("livePipeline", new()
        {
            AccountName = "testaccount2",
            BitrateKbps = 500,
            Description = "Live Pipeline 1 Description",
            LivePipelineName = "livePipeline1",
            Parameters = new[]
            {
                new AzureNative.VideoAnalyzer.Inputs.ParameterDefinitionArgs
                {
                    Name = "rtspUrlParameter",
                    Value = "rtsp://contoso.com/stream",
                },
            },
            ResourceGroupName = "testrg",
            TopologyName = "pipelinetopology1",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/videoanalyzer/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := videoanalyzer.NewLivePipeline(ctx, "livePipeline", &videoanalyzer.LivePipelineArgs{
    			AccountName:      pulumi.String("testaccount2"),
    			BitrateKbps:      pulumi.Int(500),
    			Description:      pulumi.String("Live Pipeline 1 Description"),
    			LivePipelineName: pulumi.String("livePipeline1"),
    			Parameters: []videoanalyzer.ParameterDefinitionArgs{
    				{
    					Name:  pulumi.String("rtspUrlParameter"),
    					Value: pulumi.String("rtsp://contoso.com/stream"),
    				},
    			},
    			ResourceGroupName: pulumi.String("testrg"),
    			TopologyName:      pulumi.String("pipelinetopology1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.videoanalyzer.LivePipeline;
    import com.pulumi.azurenative.videoanalyzer.LivePipelineArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var livePipeline = new LivePipeline("livePipeline", LivePipelineArgs.builder()        
                .accountName("testaccount2")
                .bitrateKbps(500)
                .description("Live Pipeline 1 Description")
                .livePipelineName("livePipeline1")
                .parameters(Map.ofEntries(
                    Map.entry("name", "rtspUrlParameter"),
                    Map.entry("value", "rtsp://contoso.com/stream")
                ))
                .resourceGroupName("testrg")
                .topologyName("pipelinetopology1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    live_pipeline = azure_native.videoanalyzer.LivePipeline("livePipeline",
        account_name="testaccount2",
        bitrate_kbps=500,
        description="Live Pipeline 1 Description",
        live_pipeline_name="livePipeline1",
        parameters=[azure_native.videoanalyzer.ParameterDefinitionArgs(
            name="rtspUrlParameter",
            value="rtsp://contoso.com/stream",
        )],
        resource_group_name="testrg",
        topology_name="pipelinetopology1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const livePipeline = new azure_native.videoanalyzer.LivePipeline("livePipeline", {
        accountName: "testaccount2",
        bitrateKbps: 500,
        description: "Live Pipeline 1 Description",
        livePipelineName: "livePipeline1",
        parameters: [{
            name: "rtspUrlParameter",
            value: "rtsp://contoso.com/stream",
        }],
        resourceGroupName: "testrg",
        topologyName: "pipelinetopology1",
    });
    
    resources:
      livePipeline:
        type: azure-native:videoanalyzer:LivePipeline
        properties:
          accountName: testaccount2
          bitrateKbps: 500
          description: Live Pipeline 1 Description
          livePipelineName: livePipeline1
          parameters:
            - name: rtspUrlParameter
              value: rtsp://contoso.com/stream
          resourceGroupName: testrg
          topologyName: pipelinetopology1
    

    Create LivePipeline Resource

    new LivePipeline(name: string, args: LivePipelineArgs, opts?: CustomResourceOptions);
    @overload
    def LivePipeline(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     account_name: Optional[str] = None,
                     bitrate_kbps: Optional[int] = None,
                     description: Optional[str] = None,
                     live_pipeline_name: Optional[str] = None,
                     parameters: Optional[Sequence[ParameterDefinitionArgs]] = None,
                     resource_group_name: Optional[str] = None,
                     topology_name: Optional[str] = None)
    @overload
    def LivePipeline(resource_name: str,
                     args: LivePipelineArgs,
                     opts: Optional[ResourceOptions] = None)
    func NewLivePipeline(ctx *Context, name string, args LivePipelineArgs, opts ...ResourceOption) (*LivePipeline, error)
    public LivePipeline(string name, LivePipelineArgs args, CustomResourceOptions? opts = null)
    public LivePipeline(String name, LivePipelineArgs args)
    public LivePipeline(String name, LivePipelineArgs args, CustomResourceOptions options)
    
    type: azure-native:videoanalyzer:LivePipeline
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args LivePipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LivePipelineArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LivePipelineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LivePipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LivePipelineArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    LivePipeline Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The LivePipeline resource accepts the following input properties:

    AccountName string
    The Azure Video Analyzer account name.
    BitrateKbps int
    Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    TopologyName string
    The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition.
    Description string
    An optional description for the pipeline.
    LivePipelineName string
    Live pipeline unique identifier.
    Parameters List<Pulumi.AzureNative.VideoAnalyzer.Inputs.ParameterDefinition>
    List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.
    AccountName string
    The Azure Video Analyzer account name.
    BitrateKbps int
    Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    TopologyName string
    The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition.
    Description string
    An optional description for the pipeline.
    LivePipelineName string
    Live pipeline unique identifier.
    Parameters []ParameterDefinitionArgs
    List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.
    accountName String
    The Azure Video Analyzer account name.
    bitrateKbps Integer
    Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    topologyName String
    The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition.
    description String
    An optional description for the pipeline.
    livePipelineName String
    Live pipeline unique identifier.
    parameters List<ParameterDefinition>
    List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.
    accountName string
    The Azure Video Analyzer account name.
    bitrateKbps number
    Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    topologyName string
    The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition.
    description string
    An optional description for the pipeline.
    livePipelineName string
    Live pipeline unique identifier.
    parameters ParameterDefinition[]
    List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.
    account_name str
    The Azure Video Analyzer account name.
    bitrate_kbps int
    Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    topology_name str
    The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition.
    description str
    An optional description for the pipeline.
    live_pipeline_name str
    Live pipeline unique identifier.
    parameters Sequence[ParameterDefinitionArgs]
    List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.
    accountName String
    The Azure Video Analyzer account name.
    bitrateKbps Number
    Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    topologyName String
    The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition.
    description String
    An optional description for the pipeline.
    livePipelineName String
    Live pipeline unique identifier.
    parameters List<Property Map>
    List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LivePipeline resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    State string
    Current state of the pipeline (read-only).
    SystemData Pulumi.AzureNative.VideoAnalyzer.Outputs.SystemDataResponse
    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"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    State string
    Current state of the pipeline (read-only).
    SystemData SystemDataResponse
    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"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    state String
    Current state of the pipeline (read-only).
    systemData SystemDataResponse
    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"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    state string
    Current state of the pipeline (read-only).
    systemData SystemDataResponse
    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"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    state str
    Current state of the pipeline (read-only).
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    state String
    Current state of the pipeline (read-only).
    systemData Property Map
    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"

    Supporting Types

    ParameterDefinition, ParameterDefinitionArgs

    Name string
    Name of the parameter declared in the pipeline topology.
    Value string
    Parameter value to be applied on this specific pipeline.
    Name string
    Name of the parameter declared in the pipeline topology.
    Value string
    Parameter value to be applied on this specific pipeline.
    name String
    Name of the parameter declared in the pipeline topology.
    value String
    Parameter value to be applied on this specific pipeline.
    name string
    Name of the parameter declared in the pipeline topology.
    value string
    Parameter value to be applied on this specific pipeline.
    name str
    Name of the parameter declared in the pipeline topology.
    value str
    Parameter value to be applied on this specific pipeline.
    name String
    Name of the parameter declared in the pipeline topology.
    value String
    Parameter value to be applied on this specific pipeline.

    ParameterDefinitionResponse, ParameterDefinitionResponseArgs

    Name string
    Name of the parameter declared in the pipeline topology.
    Value string
    Parameter value to be applied on this specific pipeline.
    Name string
    Name of the parameter declared in the pipeline topology.
    Value string
    Parameter value to be applied on this specific pipeline.
    name String
    Name of the parameter declared in the pipeline topology.
    value String
    Parameter value to be applied on this specific pipeline.
    name string
    Name of the parameter declared in the pipeline topology.
    value string
    Parameter value to be applied on this specific pipeline.
    name str
    Name of the parameter declared in the pipeline topology.
    value str
    Parameter value to be applied on this specific pipeline.
    name String
    Name of the parameter declared in the pipeline topology.
    value String
    Parameter value to be applied on this specific pipeline.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:videoanalyzer:LivePipeline livePipeline1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/livePipelines/{livePipelineName} 
    

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi