edge_modules

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

Overview

Name	edge_modules
Type	Resource
Id	azure.video_analyzer.edge_modules

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, edgeModuleName		Retrieves an existing edge module resource with the given name.
list	select	subscriptionId, resourceGroupName, accountName	$top	List all existing edge module resources, along with their JSON representations.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, edgeModuleName		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	subscriptionId, resourceGroupName, accountName, edgeModuleName		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
accountName	string	The Azure Video Analyzer account name.
edgeModuleName	string	The Edge Module 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 edge module resource with the given name.

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

list

List all existing edge module resources, along with their JSON representations.

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

INSERT examples

create_or_update

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.video_analyzer.edge_modules (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
edgeModuleName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ edgeModuleName }}'
RETURNING
properties
;

Manifest

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

DELETE examples

delete

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.video_analyzer.edge_modules
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND edgeModuleName = '{{ edgeModuleName }}' --required
;