Docs Packages
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. videoanalyzer
  5. Video
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.videoanalyzer.Video

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    The representation of a single video in a Video Analyzer account. API Version: 2021-05-01-preview.

    Example Usage

    Register video entity.

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var video = new AzureNative.VideoAnalyzer.Video("video", new()
    {
        AccountName = "testaccount2",
        Description = "Sample Description 1",
        ResourceGroupName = "testrg",
        Title = "Sample Title 1",
        VideoName = "video1",
    });

});

    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.NewVideo(ctx, "video", &videoanalyzer.VideoArgs{
			AccountName:       pulumi.String("testaccount2"),
			Description:       pulumi.String("Sample Description 1"),
			ResourceGroupName: pulumi.String("testrg"),
			Title:             pulumi.String("Sample Title 1"),
			VideoName:         pulumi.String("video1"),
		})
		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.Video;
import com.pulumi.azurenative.videoanalyzer.VideoArgs;
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 video = new Video("video", VideoArgs.builder()        
            .accountName("testaccount2")
            .description("Sample Description 1")
            .resourceGroupName("testrg")
            .title("Sample Title 1")
            .videoName("video1")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

video = azure_native.videoanalyzer.Video("video",
    account_name="testaccount2",
    description="Sample Description 1",
    resource_group_name="testrg",
    title="Sample Title 1",
    video_name="video1")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const video = new azure_native.videoanalyzer.Video("video", {
    accountName: "testaccount2",
    description: "Sample Description 1",
    resourceGroupName: "testrg",
    title: "Sample Title 1",
    videoName: "video1",
});

    resources:
  video:
    type: azure-native:videoanalyzer:Video
    properties:
      accountName: testaccount2
      description: Sample Description 1
      resourceGroupName: testrg
      title: Sample Title 1
      videoName: video1

    Create Video Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Video(name: string, args: VideoArgs, opts?: CustomResourceOptions);
    @overload
def Video(resource_name: str,
          args: VideoArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Video(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          account_name: Optional[str] = None,
          resource_group_name: Optional[str] = None,
          description: Optional[str] = None,
          title: Optional[str] = None,
          video_name: Optional[str] = None)
    func NewVideo(ctx *Context, name string, args VideoArgs, opts ...ResourceOption) (*Video, error)
    public Video(string name, VideoArgs args, CustomResourceOptions? opts = null)
    public Video(String name, VideoArgs args)
public Video(String name, VideoArgs args, CustomResourceOptions options)

    type: azure-native:videoanalyzer:Video
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 VideoArgs
    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 VideoArgs
    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 VideoArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VideoArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VideoArgs
    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 videoResource = new AzureNative.Videoanalyzer.Video("videoResource", new()
{
    AccountName = "string",
    ResourceGroupName = "string",
    Description = "string",
    Title = "string",
    VideoName = "string",
});

    example, err := videoanalyzer.NewVideo(ctx, "videoResource", &videoanalyzer.VideoArgs{
	AccountName:       "string",
	ResourceGroupName: "string",
	Description:       "string",
	Title:             "string",
	VideoName:         "string",
})

    var videoResource = new Video("videoResource", VideoArgs.builder()
    .accountName("string")
    .resourceGroupName("string")
    .description("string")
    .title("string")
    .videoName("string")
    .build());

    video_resource = azure_native.videoanalyzer.Video("videoResource",
    account_name=string,
    resource_group_name=string,
    description=string,
    title=string,
    video_name=string)

    const videoResource = new azure_native.videoanalyzer.Video("videoResource", {
    accountName: "string",
    resourceGroupName: "string",
    description: "string",
    title: "string",
    videoName: "string",
});

    type: azure-native:videoanalyzer:Video
properties:
    accountName: string
    description: string
    resourceGroupName: string
    title: string
    videoName: string

    Video 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 Video resource accepts the following input properties:

    AccountName string
    The Azure Video Analyzer account name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Description string
    Optional video description provided by the user. Value can be up to 2048 characters long.
    Title string
    Optional video title provided by the user. Value can be up to 256 characters long.
    VideoName string
    The name of the video to create or update.
    AccountName string
    The Azure Video Analyzer account name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Description string
    Optional video description provided by the user. Value can be up to 2048 characters long.
    Title string
    Optional video title provided by the user. Value can be up to 256 characters long.
    VideoName string
    The name of the video to create or update.
    accountName String
    The Azure Video Analyzer account name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    description String
    Optional video description provided by the user. Value can be up to 2048 characters long.
    title String
    Optional video title provided by the user. Value can be up to 256 characters long.
    videoName String
    The name of the video to create or update.
    accountName string
    The Azure Video Analyzer account name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    description string
    Optional video description provided by the user. Value can be up to 2048 characters long.
    title string
    Optional video title provided by the user. Value can be up to 256 characters long.
    videoName string
    The name of the video to create or update.
    account_name str
    The Azure Video Analyzer account name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    description str
    Optional video description provided by the user. Value can be up to 2048 characters long.
    title str
    Optional video title provided by the user. Value can be up to 256 characters long.
    video_name str
    The name of the video to create or update.
    accountName String
    The Azure Video Analyzer account name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    description String
    Optional video description provided by the user. Value can be up to 2048 characters long.
    title String
    Optional video title provided by the user. Value can be up to 256 characters long.
    videoName String
    The name of the video to create or update.

    Outputs

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

    Flags Pulumi.AzureNative.VideoAnalyzer.Outputs.VideoFlagsResponse
    Video flags contain information about the available video actions and its dynamic properties based on the current video state.
    Id string
    The provider-assigned unique ID for this managed resource.
    MediaInfo Pulumi.AzureNative.VideoAnalyzer.Outputs.VideoMediaInfoResponse
    Contains information about the video and audio content.
    Name string
    The name of the resource
    Streaming Pulumi.AzureNative.VideoAnalyzer.Outputs.VideoStreamingResponse
    Video streaming holds information about video streaming URLs.
    SystemData Pulumi.AzureNative.VideoAnalyzer.Outputs.SystemDataResponse
    The system metadata relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Flags VideoFlagsResponse
    Video flags contain information about the available video actions and its dynamic properties based on the current video state.
    Id string
    The provider-assigned unique ID for this managed resource.
    MediaInfo VideoMediaInfoResponse
    Contains information about the video and audio content.
    Name string
    The name of the resource
    Streaming VideoStreamingResponse
    Video streaming holds information about video streaming URLs.
    SystemData SystemDataResponse
    The system metadata relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    flags VideoFlagsResponse
    Video flags contain information about the available video actions and its dynamic properties based on the current video state.
    id String
    The provider-assigned unique ID for this managed resource.
    mediaInfo VideoMediaInfoResponse
    Contains information about the video and audio content.
    name String
    The name of the resource
    streaming VideoStreamingResponse
    Video streaming holds information about video streaming URLs.
    systemData SystemDataResponse
    The system metadata relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    flags VideoFlagsResponse
    Video flags contain information about the available video actions and its dynamic properties based on the current video state.
    id string
    The provider-assigned unique ID for this managed resource.
    mediaInfo VideoMediaInfoResponse
    Contains information about the video and audio content.
    name string
    The name of the resource
    streaming VideoStreamingResponse
    Video streaming holds information about video streaming URLs.
    systemData SystemDataResponse
    The system metadata relating to this resource.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    flags VideoFlagsResponse
    Video flags contain information about the available video actions and its dynamic properties based on the current video state.
    id str
    The provider-assigned unique ID for this managed resource.
    media_info VideoMediaInfoResponse
    Contains information about the video and audio content.
    name str
    The name of the resource
    streaming VideoStreamingResponse
    Video streaming holds information about video streaming URLs.
    system_data SystemDataResponse
    The system metadata relating to this resource.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    flags Property Map
    Video flags contain information about the available video actions and its dynamic properties based on the current video state.
    id String
    The provider-assigned unique ID for this managed resource.
    mediaInfo Property Map
    Contains information about the video and audio content.
    name String
    The name of the resource
    streaming Property Map
    Video streaming holds information about video streaming URLs.
    systemData Property Map
    The system metadata relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    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.

    VideoFlagsResponse, VideoFlagsResponseArgs

    CanStream bool
    Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed.
    HasData bool
    Value indicating whether or not there has ever been data recorded or uploaded into the video. Newly created videos have this value set to false.
    IsRecording bool
    Value indicating whether or not the video is currently being referenced be an active live pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time.
    CanStream bool
    Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed.
    HasData bool
    Value indicating whether or not there has ever been data recorded or uploaded into the video. Newly created videos have this value set to false.
    IsRecording bool
    Value indicating whether or not the video is currently being referenced be an active live pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time.
    canStream Boolean
    Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed.
    hasData Boolean
    Value indicating whether or not there has ever been data recorded or uploaded into the video. Newly created videos have this value set to false.
    isRecording Boolean
    Value indicating whether or not the video is currently being referenced be an active live pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time.
    canStream boolean
    Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed.
    hasData boolean
    Value indicating whether or not there has ever been data recorded or uploaded into the video. Newly created videos have this value set to false.
    isRecording boolean
    Value indicating whether or not the video is currently being referenced be an active live pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time.
    can_stream bool
    Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed.
    has_data bool
    Value indicating whether or not there has ever been data recorded or uploaded into the video. Newly created videos have this value set to false.
    is_recording bool
    Value indicating whether or not the video is currently being referenced be an active live pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time.
    canStream Boolean
    Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed.
    hasData Boolean
    Value indicating whether or not there has ever been data recorded or uploaded into the video. Newly created videos have this value set to false.
    isRecording Boolean
    Value indicating whether or not the video is currently being referenced be an active live pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time.

    VideoMediaInfoResponse, VideoMediaInfoResponseArgs

    SegmentLength string
    Video segment length indicates the length of individual video files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments.
    SegmentLength string
    Video segment length indicates the length of individual video files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments.
    segmentLength String
    Video segment length indicates the length of individual video files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments.
    segmentLength string
    Video segment length indicates the length of individual video files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments.
    segment_length str
    Video segment length indicates the length of individual video files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments.
    segmentLength String
    Video segment length indicates the length of individual video files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments.

    VideoStreamingResponse, VideoStreamingResponseArgs

    ArchiveBaseUrl string

    Video streaming base URL for the video archive. When present, archived video can be played through the Azure Video Analyzer player. Alternatively, this URL can be used with compatible DASH or HLS players by appending the following to the base URL:

    • HLSv4: /manifest(format=m3u8-aapl).m3u8
    • HLS CMAF: /manifest(format=m3u8-cmaf)
    • DASH CMAF: /manifest(format=mpd-time-cmaf)

    Moreover, an ongoing video recording can be played in "live mode" with latencies which are approximately double of the chosen video segment length.

    ArchiveBaseUrl string

    Video streaming base URL for the video archive. When present, archived video can be played through the Azure Video Analyzer player. Alternatively, this URL can be used with compatible DASH or HLS players by appending the following to the base URL:

    • HLSv4: /manifest(format=m3u8-aapl).m3u8
    • HLS CMAF: /manifest(format=m3u8-cmaf)
    • DASH CMAF: /manifest(format=mpd-time-cmaf)

    Moreover, an ongoing video recording can be played in "live mode" with latencies which are approximately double of the chosen video segment length.

    archiveBaseUrl String

    Video streaming base URL for the video archive. When present, archived video can be played through the Azure Video Analyzer player. Alternatively, this URL can be used with compatible DASH or HLS players by appending the following to the base URL:

    • HLSv4: /manifest(format=m3u8-aapl).m3u8
    • HLS CMAF: /manifest(format=m3u8-cmaf)
    • DASH CMAF: /manifest(format=mpd-time-cmaf)

    Moreover, an ongoing video recording can be played in "live mode" with latencies which are approximately double of the chosen video segment length.

    archiveBaseUrl string

    Video streaming base URL for the video archive. When present, archived video can be played through the Azure Video Analyzer player. Alternatively, this URL can be used with compatible DASH or HLS players by appending the following to the base URL:

    • HLSv4: /manifest(format=m3u8-aapl).m3u8
    • HLS CMAF: /manifest(format=m3u8-cmaf)
    • DASH CMAF: /manifest(format=mpd-time-cmaf)

    Moreover, an ongoing video recording can be played in "live mode" with latencies which are approximately double of the chosen video segment length.

    archive_base_url str

    Video streaming base URL for the video archive. When present, archived video can be played through the Azure Video Analyzer player. Alternatively, this URL can be used with compatible DASH or HLS players by appending the following to the base URL:

    • HLSv4: /manifest(format=m3u8-aapl).m3u8
    • HLS CMAF: /manifest(format=m3u8-cmaf)
    • DASH CMAF: /manifest(format=mpd-time-cmaf)

    Moreover, an ongoing video recording can be played in "live mode" with latencies which are approximately double of the chosen video segment length.

    archiveBaseUrl String

    Video streaming base URL for the video archive. When present, archived video can be played through the Azure Video Analyzer player. Alternatively, this URL can be used with compatible DASH or HLS players by appending the following to the base URL:

    • HLSv4: /manifest(format=m3u8-aapl).m3u8
    • HLS CMAF: /manifest(format=m3u8-cmaf)
    • DASH CMAF: /manifest(format=mpd-time-cmaf)

    Moreover, an ongoing video recording can be played in "live mode" with latencies which are approximately double of the chosen video segment length.

    Import

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

    $ pulumi import azure-native:videoanalyzer:Video video1 /subscriptions/591e76c3-3e97-44db-879c-3e2b12961b62/resourceGroups/testrg/providers/Microsoft.Media/videoAnalyzers/testaccount2/videos/video1

    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
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native