Azure Native v1 v1.104.0, Jul 6 23

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.getVideo

Explore with Pulumi AI

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

Using getVideo

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 getVideo(args: GetVideoArgs, opts?: InvokeOptions): Promise<GetVideoResult>
function getVideoOutput(args: GetVideoOutputArgs, opts?: InvokeOptions): Output<GetVideoResult>

def get_video(account_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              video_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetVideoResult
def get_video_output(account_name: Optional[pulumi.Input[str]] = None,
              resource_group_name: Optional[pulumi.Input[str]] = None,
              video_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetVideoResult]

func LookupVideo(ctx *Context, args *LookupVideoArgs, opts ...InvokeOption) (*LookupVideoResult, error)
func LookupVideoOutput(ctx *Context, args *LookupVideoOutputArgs, opts ...InvokeOption) LookupVideoResultOutput

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

public static class GetVideo 
{
    public static Task<GetVideoResult> InvokeAsync(GetVideoArgs args, InvokeOptions? opts = null)
    public static Output<GetVideoResult> Invoke(GetVideoInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVideoResult> getVideo(GetVideoArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:videoanalyzer:getVideo
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountName string: The Azure Video Analyzer account name.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
VideoName string: The name of the video to retrieve.

AccountName string: The Azure Video Analyzer account name.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
VideoName string: The name of the video to retrieve.

accountName String: The Azure Video Analyzer account name.
resourceGroupName String: The name of the resource group. The name is case insensitive.
videoName String: The name of the video to retrieve.

accountName string: The Azure Video Analyzer account name.
resourceGroupName string: The name of the resource group. The name is case insensitive.
videoName string: The name of the video to retrieve.

account_name str: The Azure Video Analyzer account name.
resource_group_name str: The name of the resource group. The name is case insensitive.
video_name str: The name of the video to retrieve.

accountName String: The Azure Video Analyzer account name.
resourceGroupName String: The name of the resource group. The name is case insensitive.
videoName String: The name of the video to retrieve.

getVideo Result

The following output properties are available:

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: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
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.

Flags VideoFlagsResponse: Video flags contain information about the available video actions and its dynamic properties based on the current video state.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
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.

flags VideoFlagsResponse: Video flags contain information about the available video actions and its dynamic properties based on the current video state.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
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.

flags VideoFlagsResponse: Video flags contain information about the available video actions and its dynamic properties based on the current video state.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
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.

flags VideoFlagsResponse: Video flags contain information about the available video actions and its dynamic properties based on the current video state.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
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.

flags Property Map: Video flags contain information about the available video actions and its dynamic properties based on the current video state.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
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.

Supporting Types

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.

VideoFlagsResponse

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

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

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)