Azure Native v3.2.0, Apr 14 25

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.videoanalyzer.getVideo

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

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.

TypeScript
Python
Go
C#
Java
YAML

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)
public static Output<GetVideoResult> getVideo(GetVideoArgs args, InvokeOptions options)

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 Video name.

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

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

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

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 Video name.

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

getVideo Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
ContentUrls Pulumi.AzureNative.VideoAnalyzer.Outputs.VideoContentUrlsResponse: Set of URLs to the video content.
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}
Name string: The name of the resource
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"
Archival Pulumi.AzureNative.VideoAnalyzer.Outputs.VideoArchivalResponse: Video archival properties.
Description string: Optional video description provided by the user. Value can be up to 2048 characters long.
MediaInfo Pulumi.AzureNative.VideoAnalyzer.Outputs.VideoMediaInfoResponse: Contains information about the video and audio content.
Title string: Optional video title provided by the user. Value can be up to 256 characters long.

AzureApiVersion string: The Azure API version of the resource.
ContentUrls VideoContentUrlsResponse: Set of URLs to the video content.
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}
Name string: The name of the resource
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"
Archival VideoArchivalResponse: Video archival properties.
Description string: Optional video description provided by the user. Value can be up to 2048 characters long.
MediaInfo VideoMediaInfoResponse: Contains information about the video and audio content.
Title string: Optional video title provided by the user. Value can be up to 256 characters long.

azureApiVersion String: The Azure API version of the resource.
contentUrls VideoContentUrlsResponse: Set of URLs to the video content.
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}
name String: The name of the resource
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"
archival VideoArchivalResponse: Video archival properties.
description String: Optional video description provided by the user. Value can be up to 2048 characters long.
mediaInfo VideoMediaInfoResponse: Contains information about the video and audio content.
title String: Optional video title provided by the user. Value can be up to 256 characters long.

azureApiVersion string: The Azure API version of the resource.
contentUrls VideoContentUrlsResponse: Set of URLs to the video content.
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}
name string: The name of the resource
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"
archival VideoArchivalResponse: Video archival properties.
description string: Optional video description provided by the user. Value can be up to 2048 characters long.
mediaInfo VideoMediaInfoResponse: Contains information about the video and audio content.
title string: Optional video title provided by the user. Value can be up to 256 characters long.

azure_api_version str: The Azure API version of the resource.
content_urls VideoContentUrlsResponse: Set of URLs to the video content.
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}
name str: The name of the resource
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"
archival VideoArchivalResponse: Video archival properties.
description str: Optional video description provided by the user. Value can be up to 2048 characters long.
media_info VideoMediaInfoResponse: Contains information about the video and audio content.
title str: Optional video title provided by the user. Value can be up to 256 characters long.

azureApiVersion String: The Azure API version of the resource.
contentUrls Property Map: Set of URLs to the video content.
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}
name String: The name of the resource
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"
archival Property Map: Video archival properties.
description String: Optional video description provided by the user. Value can be up to 2048 characters long.
mediaInfo Property Map: Contains information about the video and audio content.
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.

VideoArchivalResponse

RetentionPeriod string: Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours.

RetentionPeriod string: Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours.

retentionPeriod String: Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours.

retentionPeriod string: Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours.

retention_period str: Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours.

retentionPeriod String: Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours.

VideoContentUrlsResponse

ArchiveBaseUrl string

Video archive streaming base URL. The archived content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token on any 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. It is available when the video type is ‘archive’ and video archiving is enabled.

DownloadUrl string

Video file download URL. This URL can be used in conjunction with the video content authorization token to download the video MP4 file. The resulting MP4 file can be played on any standard media player. It is available when the video type is ‘file’ and video file is available for consumption.

PreviewImageUrls Pulumi.AzureNative.VideoAnalyzer.Inputs.VideoPreviewImageUrlsResponse

Video preview image URLs. These URLs can be used in conjunction with the video content authorization token to download the most recent still image from the video archive in different resolutions. They are available when the video type is ‘archive’ and preview images are enabled.

RtspTunnelUrl string

Video low-latency streaming URL. The live content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token to expose a WebSocket tunneled RTSP stream. It is available when the video type is ‘archive’ and a live, low-latency feed is available from the source.

ArchiveBaseUrl string

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

DownloadUrl string

PreviewImageUrls VideoPreviewImageUrlsResponse

RtspTunnelUrl string

archiveBaseUrl String

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

downloadUrl String

previewImageUrls VideoPreviewImageUrlsResponse

rtspTunnelUrl String

archiveBaseUrl string

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

downloadUrl string

previewImageUrls VideoPreviewImageUrlsResponse

rtspTunnelUrl string

archive_base_url str

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

download_url str

preview_image_urls VideoPreviewImageUrlsResponse

rtsp_tunnel_url str

archiveBaseUrl String

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

downloadUrl String

previewImageUrls Property Map

rtspTunnelUrl String

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.
IsInUse bool: Value indicating whether or not the video is currently being referenced be an active 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.
IsInUse bool: Value indicating whether or not the video is currently being referenced be an active 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.
isInUse Boolean: Value indicating whether or not the video is currently being referenced be an active 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.
isInUse boolean: Value indicating whether or not the video is currently being referenced be an active 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_in_use bool: Value indicating whether or not the video is currently being referenced be an active 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.
isInUse Boolean: Value indicating whether or not the video is currently being referenced be an active 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.

VideoPreviewImageUrlsResponse

Large string: High resolution preview image URL.
Medium string: Medium resolution preview image URL.
Small string: Low resolution preview image URL.

Large string: High resolution preview image URL.
Medium string: Medium resolution preview image URL.
Small string: Low resolution preview image URL.

large String: High resolution preview image URL.
medium String: Medium resolution preview image URL.
small String: Low resolution preview image URL.

large string: High resolution preview image URL.
medium string: Medium resolution preview image URL.
small string: Low resolution preview image URL.

large str: High resolution preview image URL.
medium str: Medium resolution preview image URL.
small str: Low resolution preview image URL.

large String: High resolution preview image URL.
medium String: Medium resolution preview image URL.
small String: Low resolution preview image URL.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.videoanalyzer.getVideo

On this page

On this page

Using getVideo

getVideo Result

Supporting Types

SystemDataResponse

VideoArchivalResponse

VideoContentUrlsResponse

VideoFlagsResponse

VideoMediaInfoResponse

VideoPreviewImageUrlsResponse

Package Details

On this page

On this page