access_policies

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

Overview

Name	access_policies
Type	Resource
Id	azure_extras.video_analyzer.access_policies

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.
authentication	object	Base class for access policies authentication methods. You probably want to use the sub-classes and not this class directly. Known sub-classes are: JwtAuthentication. All required parameters must be populated in order to send to Azure.
role	string
systemData	object	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".

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

SELECT
id,
name,
authentication,
role,
systemData,
type
FROM azure_extras.video_analyzer.access_policies
WHERE access_policy_name = '{{ access_policy_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
@nextLink,
value
FROM azure_extras.video_analyzer.access_policies
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 access policy resource or updates an existing one. Creates a new access policy resource or updates an existing one with the given name.

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

Manifest

# Description fields are for documentation purposes
- name: access_policies
props:
  - name: access_policy_name
    value: "{{ access_policy_name }}"
    description: Required parameter for the access_policies resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the access_policies resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the access_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the access_policies resource.
  - name: properties
    value:
      role: "{{ role }}"
      authentication:
        @type: "{{ @type }}"

UPDATE examples

update

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

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

REPLACE examples

create_or_update

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

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

DELETE examples

delete

Deletes an existing access policy resource. Deletes an existing access policy resource with the given name.

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