Skip to main content

edge_modules

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

Overview

Nameedge_modules
TypeResource
Idazure.video_analyzer.edge_modules

Fields

NameDatatypeDescription
accountNametextfield from the properties object
edgeModuleNametextfield from the properties object
edge_module_idtextfield from the properties object
resourceGroupNametextfield from the properties object
subscriptionIdtextfield from the properties object

Methods

NameAccessible byRequired ParamsDescription
getSELECTaccountName, edgeModuleName, resourceGroupName, subscriptionIdRetrieves an existing edge module resource with the given name.
listSELECTaccountName, resourceGroupName, subscriptionIdList all existing edge module resources, along with their JSON representations.
create_or_updateINSERTaccountName, edgeModuleName, resourceGroupName, subscriptionIdCreates 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.
deleteDELETEaccountName, edgeModuleName, resourceGroupName, subscriptionIdDeletes 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.

SELECT examples

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

SELECT
accountName,
edgeModuleName,
edge_module_id,
resourceGroupName,
subscriptionId
FROM azure.video_analyzer.vw_edge_modules
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new edge_modules resource.

/*+ create */
INSERT INTO azure.video_analyzer.edge_modules (
accountName,
edgeModuleName,
resourceGroupName,
subscriptionId,
properties
)
SELECT
'{{ accountName }}',
'{{ edgeModuleName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

DELETE example

Deletes the specified edge_modules resource.

/*+ delete */
DELETE FROM azure.video_analyzer.edge_modules
WHERE accountName = '{{ accountName }}'
AND edgeModuleName = '{{ edgeModuleName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';