azure-native.videoanalyzer.LivePipeline
Explore with Pulumi AI
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. API Version: 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 (
videoanalyzer "github.com/pulumi/pulumi-azure-native-sdk/videoanalyzer"
"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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LivePipeline(name: string, args: LivePipelineArgs, opts?: CustomResourceOptions);
@overload
def LivePipeline(resource_name: str,
args: LivePipelineArgs,
opts: Optional[ResourceOptions] = None)
@overload
def LivePipeline(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_name: Optional[str] = None,
bitrate_kbps: Optional[int] = None,
resource_group_name: Optional[str] = None,
topology_name: Optional[str] = None,
description: Optional[str] = None,
live_pipeline_name: Optional[str] = None,
parameters: Optional[Sequence[ParameterDefinitionArgs]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var livePipelineResource = new AzureNative.Videoanalyzer.LivePipeline("livePipelineResource", new()
{
AccountName = "string",
BitrateKbps = 0,
ResourceGroupName = "string",
TopologyName = "string",
Description = "string",
LivePipelineName = "string",
Parameters = new[]
{
{
{ "name", "string" },
{ "value", "string" },
},
},
});
example, err := videoanalyzer.NewLivePipeline(ctx, "livePipelineResource", &videoanalyzer.LivePipelineArgs{
AccountName: "string",
BitrateKbps: 0,
ResourceGroupName: "string",
TopologyName: "string",
Description: "string",
LivePipelineName: "string",
Parameters: []map[string]interface{}{
map[string]interface{}{
"name": "string",
"value": "string",
},
},
})
var livePipelineResource = new LivePipeline("livePipelineResource", LivePipelineArgs.builder()
.accountName("string")
.bitrateKbps(0)
.resourceGroupName("string")
.topologyName("string")
.description("string")
.livePipelineName("string")
.parameters(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
live_pipeline_resource = azure_native.videoanalyzer.LivePipeline("livePipelineResource",
account_name=string,
bitrate_kbps=0,
resource_group_name=string,
topology_name=string,
description=string,
live_pipeline_name=string,
parameters=[{
name: string,
value: string,
}])
const livePipelineResource = new azure_native.videoanalyzer.LivePipeline("livePipelineResource", {
accountName: "string",
bitrateKbps: 0,
resourceGroupName: "string",
topologyName: "string",
description: "string",
livePipelineName: "string",
parameters: [{
name: "string",
value: "string",
}],
});
type: azure-native:videoanalyzer:LivePipeline
properties:
accountName: string
bitrateKbps: 0
description: string
livePipelineName: string
parameters:
- name: string
value: string
resourceGroupName: string
topologyName: string
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:
- Account
Name string - 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 stringName - The name of the resource group. The name is case insensitive.
- Topology
Name 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.
- Live
Pipeline stringName - Live pipeline unique identifier.
- Parameters
List<Pulumi.
Azure Native. Video Analyzer. Inputs. Parameter Definition> - 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 string - 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 stringName - The name of the resource group. The name is case insensitive.
- Topology
Name 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.
- Live
Pipeline stringName - Live pipeline unique identifier.
- Parameters
[]Parameter
Definition Args - 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 String - The Azure Video Analyzer account name.
- bitrate
Kbps 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.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- topology
Name 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.
- live
Pipeline StringName - Live pipeline unique identifier.
- parameters
List<Parameter
Definition> - 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 string - The Azure Video Analyzer account name.
- bitrate
Kbps 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.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- topology
Name 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.
- live
Pipeline stringName - Live pipeline unique identifier.
- parameters
Parameter
Definition[] - 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_ strname - 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_ strname - Live pipeline unique identifier.
- parameters
Sequence[Parameter
Definition Args] - 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 String - The Azure Video Analyzer account name.
- bitrate
Kbps 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.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- topology
Name 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.
- live
Pipeline StringName - 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).
- System
Data Pulumi.Azure Native. Video Analyzer. Outputs. System Data Response - 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).
- System
Data SystemData Response - 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).
- system
Data SystemData Response - 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).
- system
Data SystemData Response - 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 SystemData Response - 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).
- system
Data 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
ParameterDefinitionResponse, ParameterDefinitionResponseArgs
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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/591e76c3-3e97-44db-879c-3e2b12961b62/resourceGroups/testrg/providers/Microsoft.Media/videoAnalyzers/testaccount2/livePipelines/livePipeline1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0