Interface EdgeModulesClient


  • public interface EdgeModulesClient
    An instance of this class provides access to all the operations defined in EdgeModulesClient.
    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<EdgeModuleEntityInner> list​(String resourceGroupName,
                                                                           String accountName)
        List all existing edge module resources, along with their JSON representations.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        Returns:
        a collection of EdgeModuleEntity items as paginated response with PagedIterable.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • list

        com.azure.core.http.rest.PagedIterable<EdgeModuleEntityInner> list​(String resourceGroupName,
                                                                           String accountName,
                                                                           Integer top,
                                                                           com.azure.core.util.Context context)
        List all existing edge module resources, along with their JSON representations.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        top - 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.
        context - The context to associate with this operation.
        Returns:
        a collection of EdgeModuleEntity items as paginated response with PagedIterable.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • get

        EdgeModuleEntityInner get​(String resourceGroupName,
                                  String accountName,
                                  String edgeModuleName)
        Retrieves an existing edge module resource with the given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        edgeModuleName - The Edge Module name.
        Returns:
        the representation of an edge module.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getWithResponse

        com.azure.core.http.rest.Response<EdgeModuleEntityInner> getWithResponse​(String resourceGroupName,
                                                                                 String accountName,
                                                                                 String edgeModuleName,
                                                                                 com.azure.core.util.Context context)
        Retrieves an existing edge module resource with the given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        edgeModuleName - The Edge Module name.
        context - The context to associate with this operation.
        Returns:
        the representation of an edge module along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createOrUpdate

        EdgeModuleEntityInner createOrUpdate​(String resourceGroupName,
                                             String accountName,
                                             String edgeModuleName,
                                             EdgeModuleEntityInner parameters)
        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.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        edgeModuleName - The Edge Module name.
        parameters - The request parameters.
        Returns:
        the representation of an edge module.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createOrUpdateWithResponse

        com.azure.core.http.rest.Response<EdgeModuleEntityInner> createOrUpdateWithResponse​(String resourceGroupName,
                                                                                            String accountName,
                                                                                            String edgeModuleName,
                                                                                            EdgeModuleEntityInner parameters,
                                                                                            com.azure.core.util.Context context)
        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.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        edgeModuleName - The Edge Module name.
        parameters - The request parameters.
        context - The context to associate with this operation.
        Returns:
        the representation of an edge module along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • delete

        void delete​(String resourceGroupName,
                    String accountName,
                    String 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:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        edgeModuleName - The Edge Module name.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteWithResponse

        com.azure.core.http.rest.Response<Void> deleteWithResponse​(String resourceGroupName,
                                                                   String accountName,
                                                                   String edgeModuleName,
                                                                   com.azure.core.util.Context context)
        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:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        edgeModuleName - The Edge Module name.
        context - The context to associate with this operation.
        Returns:
        the Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listProvisioningToken

        EdgeModuleProvisioningTokenInner listProvisioningToken​(String resourceGroupName,
                                                               String accountName,
                                                               String edgeModuleName,
                                                               ListProvisioningTokenInput parameters)
        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.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        edgeModuleName - The Edge Module name.
        parameters - The request parameters.
        Returns:
        provisioning token properties.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listProvisioningTokenWithResponse

        com.azure.core.http.rest.Response<EdgeModuleProvisioningTokenInner> listProvisioningTokenWithResponse​(String resourceGroupName,
                                                                                                              String accountName,
                                                                                                              String edgeModuleName,
                                                                                                              ListProvisioningTokenInput parameters,
                                                                                                              com.azure.core.util.Context context)
        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.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        edgeModuleName - The Edge Module name.
        parameters - The request parameters.
        context - The context to associate with this operation.
        Returns:
        provisioning token properties along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.