videos

Creates, updates, deletes, gets or lists a videos resource.

Overview

Name	videos
Type	Resource
Id	azure_extras.video_analyzer.videos

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
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.
archival	object	Video archival properties.
contentUrls	object	Set of URLs to the video content.
description	string
flags	object	Video flags contain information about the available video actions and its dynamic properties based on the current video state.
mediaInfo	object	Contains information about the video and audio content.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
@nextLink	string
value	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_name, resource_group_name, video_name, subscription_id		Retrieves an existing video resource. Retrieves an existing video resource with the given name.
list	select	account_name, resource_group_name, subscription_id	$top	Retrieves all existing video resources. Retrieves a list of video resources that have been created, along with their JSON representations.
create_or_update	insert	account_name, resource_group_name, video_name, subscription_id		Creates a new video resource or updates an existing one. Creates a new video resource or updates an existing video resource with the given name.
update	update	account_name, resource_group_name, video_name, subscription_id		Updates individual properties of an existing video resource. Updates individual properties of an existing video resource with the given name.
create_or_update	replace	account_name, resource_group_name, video_name, subscription_id		Creates a new video resource or updates an existing one. Creates a new video resource or updates an existing video resource with the given name.
delete	delete	account_name, resource_group_name, video_name, subscription_id		Deletes an existing video resource and its underlying data. Deletes an existing video resource and its underlying data. This operation is irreversible.
list_content_token	exec	account_name, resource_group_name, video_name, subscription_id		Generates a streaming token which can be used for accessing content from video content URLs. Generates a streaming token which can be used for accessing content from video content URLs, for a video resource with the given name.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_name	string	The Azure Video Analyzer account name.
resource_group_name	string	The name of the resource group. The name is case insensitive.
subscription_id	string
video_name	string	The Video name.
$top	integer	Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.

SELECT examples

get

Retrieves an existing video resource. Retrieves an existing video resource with the given name.

SELECT
id,
name,
archival,
contentUrls,
description,
flags,
mediaInfo,
systemData,
title,
type
FROM azure_extras.video_analyzer.videos
WHERE account_name = '{{ account_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND video_name = '{{ video_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Retrieves all existing video resources. Retrieves a list of video resources that have been created, along with their JSON representations.

SELECT
@nextLink,
value
FROM azure_extras.video_analyzer.videos
WHERE account_name = '{{ account_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates a new video resource or updates an existing one. Creates a new video resource or updates an existing video resource with the given name.

INSERT INTO azure_extras.video_analyzer.videos (
properties,
account_name,
resource_group_name,
video_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ account_name }}',
'{{ resource_group_name }}',
'{{ video_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: videos
props:
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the videos resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the videos resource.
  - name: video_name
    value: "{{ video_name }}"
    description: Required parameter for the videos resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the videos resource.
  - name: properties
    value:
      title: "{{ title }}"
      description: "{{ description }}"
      mediaInfo:
        segmentLength: "{{ segmentLength }}"
      archival:
        retentionPeriod: "{{ retentionPeriod }}"

UPDATE examples

update

Updates individual properties of an existing video resource. Updates individual properties of an existing video resource with the given name.

UPDATE azure_extras.video_analyzer.videos
SET 
properties = '{{ properties }}'
WHERE 
account_name = '{{ account_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND video_name = '{{ video_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates a new video resource or updates an existing one. Creates a new video resource or updates an existing video resource with the given name.

REPLACE azure_extras.video_analyzer.videos
SET 
properties = '{{ properties }}'
WHERE 
account_name = '{{ account_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND video_name = '{{ video_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes an existing video resource and its underlying data. Deletes an existing video resource and its underlying data. This operation is irreversible.

DELETE FROM azure_extras.video_analyzer.videos
WHERE account_name = '{{ account_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND video_name = '{{ video_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_content_token

Generates a streaming token which can be used for accessing content from video content URLs. Generates a streaming token which can be used for accessing content from video content URLs, for a video resource with the given name.

EXEC azure_extras.video_analyzer.videos.list_content_token 
@account_name='{{ account_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@video_name='{{ video_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;