accounts

Creates, updates, deletes, gets or lists an accounts resource.

Overview

Name	accounts
Type	Resource
Id	azure_extras.video_indexer.accounts

Fields

The following fields are returned by SELECT queries:

get

The Azure Video Indexer account properties were retrieved successfully.

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The geo-location where the resource lives
properties	object	List of account properties
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The geo-location where the resource lives
properties	object	List of account properties
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.

list

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The geo-location where the resource lives
properties	object	List of account properties
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName		Gets the properties of an Azure Video Indexer account.
list_by_resource_group	select	subscriptionId, resourceGroupName		List all Azure Video Indexer accounts available under the resource group
list	select	subscriptionId		List all Azure Video Indexer accounts available under the subscription
create_or_update	insert	subscriptionId, resourceGroupName, accountName		Creates or updates an Azure Video Indexer account.
update	update	subscriptionId, resourceGroupName, accountName		Updates the properties of an existing Azure Video Indexer account.
delete	delete	subscriptionId, resourceGroupName, accountName		Delete an Azure Video Indexer account.
check_name_availability	exec	subscriptionId, name, type		Checks that the Video Indexer account name is valid and is not already in use.

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 name of the Azure Video Indexer account.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the properties of an Azure Video Indexer account.

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure_extras.video_indexer.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;

list_by_resource_group

List all Azure Video Indexer accounts available under the resource group

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure_extras.video_indexer.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

List all Azure Video Indexer accounts available under the subscription

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure_extras.video_indexer.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an Azure Video Indexer account.

INSERT INTO azure_extras.video_indexer.accounts (
data__properties,
data__identity,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
accountName
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}'
RETURNING
identity,
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: accounts
props:
  - name: subscriptionId
    value: "{{ subscriptionId }}"
    description: Required parameter for the accounts resource.
  - name: resourceGroupName
    value: "{{ resourceGroupName }}"
    description: Required parameter for the accounts resource.
  - name: accountName
    value: "{{ accountName }}"
    description: Required parameter for the accounts resource.
  - name: properties
    description: |
      List of account properties
    value:
      tenantId: "{{ tenantId }}"
      accountId: "{{ accountId }}"
      accountName: "{{ accountName }}"
      storageServices:
        resourceId: "{{ resourceId }}"
        userAssignedIdentity: "{{ userAssignedIdentity }}"
      totalSecondsIndexed: {{ totalSecondsIndexed }}
      provisioningState: "{{ provisioningState }}"
  - name: identity
    description: |
      Managed service identity (system assigned and/or user assigned identities)
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives

UPDATE examples

update

Updates the properties of an existing Azure Video Indexer account.

UPDATE azure_extras.video_indexer.accounts
SET 
data__properties = '{{ properties }}',
data__identity = '{{ identity }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
RETURNING
identity,
location,
properties,
systemData,
tags;

DELETE examples

delete

Delete an Azure Video Indexer account.

DELETE FROM azure_extras.video_indexer.accounts
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
;

Lifecycle Methods

check_name_availability

Checks that the Video Indexer account name is valid and is not already in use.

EXEC azure_extras.video_indexer.accounts.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;