EdgeModules interface
Interface representing a EdgeModules.
Methods
| create |
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(string, string, string, Edge |
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. |
| get(string, string, string, Edge |
Retrieves an existing edge module resource with the given name. |
| list(string, string, Edge |
List all existing edge module resources, along with their JSON representations. |
| list |
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. |
Method Details
createOrUpdate(string, string, string, EdgeModuleEntity, EdgeModulesCreateOrUpdateOptionalParams)
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.
function createOrUpdate(resourceGroupName: string, accountName: string, edgeModuleName: string, parameters: EdgeModuleEntity, options?: EdgeModulesCreateOrUpdateOptionalParams): Promise<EdgeModuleEntity>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
The Azure Video Analyzer account name.
- edgeModuleName
-
string
The Edge Module name.
- parameters
- EdgeModuleEntity
The request parameters
The options parameters.
Returns
Promise<EdgeModuleEntity>
delete(string, string, string, EdgeModulesDeleteOptionalParams)
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.
function delete(resourceGroupName: string, accountName: string, edgeModuleName: string, options?: EdgeModulesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
The Azure Video Analyzer account name.
- edgeModuleName
-
string
The Edge Module name.
- options
- EdgeModulesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, EdgeModulesGetOptionalParams)
Retrieves an existing edge module resource with the given name.
function get(resourceGroupName: string, accountName: string, edgeModuleName: string, options?: EdgeModulesGetOptionalParams): Promise<EdgeModuleEntity>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
The Azure Video Analyzer account name.
- edgeModuleName
-
string
The Edge Module name.
- options
- EdgeModulesGetOptionalParams
The options parameters.
Returns
Promise<EdgeModuleEntity>
list(string, string, EdgeModulesListOptionalParams)
List all existing edge module resources, along with their JSON representations.
function list(resourceGroupName: string, accountName: string, options?: EdgeModulesListOptionalParams): PagedAsyncIterableIterator<EdgeModuleEntity, EdgeModuleEntity[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
The Azure Video Analyzer account name.
- options
- EdgeModulesListOptionalParams
The options parameters.
Returns
listProvisioningToken(string, string, string, ListProvisioningTokenInput, EdgeModulesListProvisioningTokenOptionalParams)
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.
function listProvisioningToken(resourceGroupName: string, accountName: string, edgeModuleName: string, parameters: ListProvisioningTokenInput, options?: EdgeModulesListProvisioningTokenOptionalParams): Promise<EdgeModuleProvisioningToken>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
The Azure Video Analyzer account name.
- edgeModuleName
-
string
The Edge Module name.
- parameters
- ListProvisioningTokenInput
The request parameters
The options parameters.
Returns
Promise<EdgeModuleProvisioningToken>
Azure SDK for JavaScript