edge_modules

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

Overview

Name	edge_modules
Type	Resource
Id	azure_extras.video_analyzer.edge_modules

Fields

The following fields are returned by SELECT queries:

list_provisioning_token

Name	Datatype	Description
expirationDate	string (date-time)	The expiration date of the registration token. The Azure Video Analyzer IoT edge module must be initialized and connected to the Internet prior to the token expiration date.
token	string	The token blob to be provided to the Azure Video Analyzer IoT edge module through the Azure IoT Edge module twin properties.

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.
edgeModuleId	string	Internal ID generated for the instance of the Video Analyzer edge module.
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
list_provisioning_token	select	edge_module_name, account_name, resource_group_name, subscription_id		Creates a new provisioning token. Creates a new provisioning token. A provisioning token allows for a single instance of Azure Video analyzer IoT edge module to be initialized and authorized to the cloud account. The provisioning token itself is short lived and it is only used for the initial handshake between IoT edge module and the cloud. After the initial handshake, the IoT edge module will agree on a set of authentication keys which will be auto-rotated as long as the module is able to periodically connect to the cloud. A new provisioning token can be generated for the same IoT edge module in case the module state lost or reset.
get	select	edge_module_name, account_name, resource_group_name, subscription_id		Retrieves an existing edge module resource. Retrieves an existing edge module resource with the given name.
list	select	account_name, resource_group_name, subscription_id	$top	List all existing edge module resources. List all existing edge module resources, along with their JSON representations.
create_or_update	insert	edge_module_name, account_name, resource_group_name, subscription_id		Creates a new edge module or updates an existing one. Creates a new edge module or updates an existing one. An edge module resource enables a single instance of an Azure Video Analyzer IoT edge module to interact with the Video Analyzer Account. This is used for authorization and also to make sure that the particular edge module instance only has access to the data it requires from the Azure Video Analyzer service. A new edge module resource should be created for every new instance of an Azure Video Analyzer edge module deployed to you Azure IoT edge environment. Edge module resources can be deleted if the specific module is not in use anymore.
create_or_update	replace	edge_module_name, account_name, resource_group_name, subscription_id		Creates a new edge module or updates an existing one. Creates a new edge module or updates an existing one. An edge module resource enables a single instance of an Azure Video Analyzer IoT edge module to interact with the Video Analyzer Account. This is used for authorization and also to make sure that the particular edge module instance only has access to the data it requires from the Azure Video Analyzer service. A new edge module resource should be created for every new instance of an Azure Video Analyzer edge module deployed to you Azure IoT edge environment. Edge module resources can be deleted if the specific module is not in use anymore.
delete	delete	edge_module_name, account_name, resource_group_name, subscription_id		Deletes an existing edge module resource. Deletes an existing edge module resource. Deleting the edge module resource will prevent an Azure Video Analyzer IoT edge module which was previously initiated with the module provisioning token from communicating with the cloud.

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.
edge_module_name	string	The Edge Module 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

list_provisioning_token

Creates a new provisioning token. Creates a new provisioning token. A provisioning token allows for a single instance of Azure Video analyzer IoT edge module to be initialized and authorized to the cloud account. The provisioning token itself is short lived and it is only used for the initial handshake between IoT edge module and the cloud. After the initial handshake, the IoT edge module will agree on a set of authentication keys which will be auto-rotated as long as the module is able to periodically connect to the cloud. A new provisioning token can be generated for the same IoT edge module in case the module state lost or reset.

SELECT
expirationDate,
token
FROM azure_extras.video_analyzer.edge_modules
WHERE edge_module_name = '{{ edge_module_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Retrieves an existing edge module resource. Retrieves an existing edge module resource with the given name.

SELECT
id,
name,
edgeModuleId,
systemData,
type
FROM azure_extras.video_analyzer.edge_modules
WHERE edge_module_name = '{{ edge_module_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 edge module resources. List all existing edge module resources, along with their JSON representations.

SELECT
@nextLink,
value
FROM azure_extras.video_analyzer.edge_modules
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 edge module or updates an existing one. Creates a new edge module or updates an existing one. An edge module resource enables a single instance of an Azure Video Analyzer IoT edge module to interact with the Video Analyzer Account. This is used for authorization and also to make sure that the particular edge module instance only has access to the data it requires from the Azure Video Analyzer service. A new edge module resource should be created for every new instance of an Azure Video Analyzer edge module deployed to you Azure IoT edge environment. Edge module resources can be deleted if the specific module is not in use anymore.

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

Manifest

# Description fields are for documentation purposes
- name: edge_modules
props:
  - name: edge_module_name
    value: "{{ edge_module_name }}"
    description: Required parameter for the edge_modules resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the edge_modules resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the edge_modules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the edge_modules resource.
  - name: id
    value: "{{ id }}"
    description: |
      Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the resource.
  - name: type
    value: "{{ type }}"
    description: |
      The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
  - name: systemData
    description: |
      Azure Resource Manager metadata containing createdBy and modifiedBy information.
    value:
      createdBy: "{{ createdBy }}"
      createdByType: "{{ createdByType }}"
      createdAt: "{{ createdAt }}"
      lastModifiedBy: "{{ lastModifiedBy }}"
      lastModifiedByType: "{{ lastModifiedByType }}"
      lastModifiedAt: "{{ lastModifiedAt }}"
  - name: properties
    value:
      edgeModuleId: "{{ edgeModuleId }}"

REPLACE examples

create_or_update

Creates a new edge module or updates an existing one. Creates a new edge module or updates an existing one. An edge module resource enables a single instance of an Azure Video Analyzer IoT edge module to interact with the Video Analyzer Account. This is used for authorization and also to make sure that the particular edge module instance only has access to the data it requires from the Azure Video Analyzer service. A new edge module resource should be created for every new instance of an Azure Video Analyzer edge module deployed to you Azure IoT edge environment. Edge module resources can be deleted if the specific module is not in use anymore.

REPLACE azure_extras.video_analyzer.edge_modules
SET 
id = '{{ id }}',
name = '{{ name }}',
type = '{{ type }}',
systemData = '{{ systemData }}',
properties = '{{ properties }}'
WHERE 
edge_module_name = '{{ edge_module_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 edge module resource. Deletes an existing edge module resource. Deleting the edge module resource will prevent an Azure Video Analyzer IoT edge module which was previously initiated with the module provisioning token from communicating with the cloud.

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