Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.1 published on Monday, Aug 15, 2022 by Pulumi

getLivePipeline

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.

Using getLivePipeline

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getLivePipeline(args: GetLivePipelineArgs, opts?: InvokeOptions): Promise<GetLivePipelineResult>
function getLivePipelineOutput(args: GetLivePipelineOutputArgs, opts?: InvokeOptions): Output<GetLivePipelineResult>
def get_live_pipeline(account_name: Optional[str] = None,
                      live_pipeline_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetLivePipelineResult
def get_live_pipeline_output(account_name: Optional[pulumi.Input[str]] = None,
                      live_pipeline_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetLivePipelineResult]
func LookupLivePipeline(ctx *Context, args *LookupLivePipelineArgs, opts ...InvokeOption) (*LookupLivePipelineResult, error)
func LookupLivePipelineOutput(ctx *Context, args *LookupLivePipelineOutputArgs, opts ...InvokeOption) LookupLivePipelineResultOutput

> Note: This function is named LookupLivePipeline in the Go SDK.

public static class GetLivePipeline 
{
    public static Task<GetLivePipelineResult> InvokeAsync(GetLivePipelineArgs args, InvokeOptions? opts = null)
    public static Output<GetLivePipelineResult> Invoke(GetLivePipelineInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetLivePipelineResult> getLivePipeline(GetLivePipelineArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:videoanalyzer:getLivePipeline
  Arguments:
    # Arguments dictionary

The following arguments are supported:

AccountName string

The Azure Video Analyzer account name.

LivePipelineName string

Live pipeline unique identifier.

ResourceGroupName string

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

AccountName string

The Azure Video Analyzer account name.

LivePipelineName string

Live pipeline unique identifier.

ResourceGroupName string

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

accountName String

The Azure Video Analyzer account name.

livePipelineName String

Live pipeline unique identifier.

resourceGroupName String

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

accountName string

The Azure Video Analyzer account name.

livePipelineName string

Live pipeline unique identifier.

resourceGroupName string

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

account_name str

The Azure Video Analyzer account name.

live_pipeline_name str

Live pipeline unique identifier.

resource_group_name str

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

accountName String

The Azure Video Analyzer account name.

livePipelineName String

Live pipeline unique identifier.

resourceGroupName String

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

getLivePipeline Result

The following output properties are available:

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.

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

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.

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.

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Description string

An optional description for the pipeline.

Parameters List<Pulumi.AzureNative.VideoAnalyzer.Outputs.ParameterDefinitionResponse>

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.

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.

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

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.

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.

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Description string

An optional description for the pipeline.

Parameters []ParameterDefinitionResponse

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.

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.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

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.

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.

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

description String

An optional description for the pipeline.

parameters List<ParameterDefinitionResponse>

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.

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.

id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

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.

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.

type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

description string

An optional description for the pipeline.

parameters ParameterDefinitionResponse[]

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.

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.

id str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

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.

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.

type str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

description str

An optional description for the pipeline.

parameters Sequence[ParameterDefinitionResponse]

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.

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.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

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.

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.

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

description String

An optional description for the pipeline.

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.

Supporting Types

ParameterDefinitionResponse

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

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.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0