access_policies

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

Overview

Name	access_policies
Type	Resource
Id	azure.video_analyzer.access_policies

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, accessPolicyName		Retrieves an existing access policy resource with the given name.
list	select	subscriptionId, resourceGroupName, accountName	$top	Retrieves all existing access policy resources, along with their JSON representations.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, accessPolicyName		Creates a new access policy resource or updates an existing one with the given name.
update	update	subscriptionId, resourceGroupName, accountName, accessPolicyName		Updates individual properties of an existing access policy resource with the given name.
delete	delete	subscriptionId, resourceGroupName, accountName, accessPolicyName		Deletes an existing access policy 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
accessPolicyName	string	The Access Policy name.
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.
$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 access policy resource with the given name.

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

list

Retrieves all existing access policy resources, along with their JSON representations.

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

INSERT examples

create_or_update

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

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

Manifest

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

UPDATE examples

update

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

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

DELETE examples

delete

Deletes an existing access policy resource with the given name.

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