videos

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

Overview

Name	videos
Type	Resource
Id	azure.video_analyzer.videos

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The resource properties.

list

Name	Datatype	Description
properties	object	The resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, videoName		Retrieves an existing video resource with the given name.
list	select	subscriptionId, resourceGroupName, accountName	$top	Retrieves a list of video resources that have been created, along with their JSON representations.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, videoName		Creates a new video resource or updates an existing video resource with the given name.
update	update	subscriptionId, resourceGroupName, accountName, videoName		Updates individual properties of an existing video resource with the given name.
delete	delete	subscriptionId, resourceGroupName, accountName, videoName		Deletes an existing video resource and its underlying data. This operation is irreversible.

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
accountName	string	The Azure Video Analyzer account name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
videoName	string	The Video name.
$top	integer (int32)	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 with the given name.

SELECT
properties
FROM azure.video_analyzer.videos
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND videoName = '{{ videoName }}' -- required
;

list

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

SELECT
properties
FROM azure.video_analyzer.videos
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure.video_analyzer.videos (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
videoName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ videoName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: videos
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the videos resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the videos resource.
    - name: accountName
      value: string
      description: Required parameter for the videos resource.
    - name: videoName
      value: string
      description: Required parameter for the videos resource.
    - name: properties
      value: object
      description: |
        The resource properties.

UPDATE examples

update

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

UPDATE azure.video_analyzer.videos
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND videoName = '{{ videoName }}' --required
RETURNING
properties;

DELETE examples

delete

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

DELETE FROM azure.video_analyzer.videos
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND videoName = '{{ videoName }}' --required
;