edge_modules
Creates, updates, deletes, gets or lists a edge_modules
resource.
Overview
Name | edge_modules |
Type | Resource |
Id | azure.video_analyzer.edge_modules |
Fields
- vw_edge_modules
- edge_modules
Name | Datatype | Description |
---|---|---|
accountName | text | field from the properties object |
edgeModuleName | text | field from the properties object |
edge_module_id | text | field from the properties object |
resourceGroupName | text | field from the properties object |
subscriptionId | text | field from the properties object |
Name | Datatype | Description |
---|---|---|
properties | object | Application level properties for the edge module resource. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | accountName, edgeModuleName, resourceGroupName, subscriptionId | Retrieves an existing edge module resource with the given name. |
list | SELECT | accountName, resourceGroupName, subscriptionId | List all existing edge module resources, along with their JSON representations. |
create_or_update | INSERT | accountName, edgeModuleName, resourceGroupName, subscriptionId | 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 | accountName, edgeModuleName, resourceGroupName, subscriptionId | 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. |
SELECT
examples
List all existing edge module resources, along with their JSON representations.
- vw_edge_modules
- edge_modules
SELECT
accountName,
edgeModuleName,
edge_module_id,
resourceGroupName,
subscriptionId
FROM azure.video_analyzer.vw_edge_modules
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';
SELECT
properties
FROM azure.video_analyzer.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.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure.video_analyzer.edge_modules (
accountName,
edgeModuleName,
resourceGroupName,
subscriptionId,
properties
)
SELECT
'{{ accountName }}',
'{{ edgeModuleName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;
- name: your_resource_model_name
props:
- name: properties
value:
- name: edgeModuleId
value: string
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 }}';