Package com.azure.resourcemanager.videoanalyzer.models

Interface EdgeModules

public interface EdgeModules

Resource collection API of EdgeModules.

Method Summary

Modifier and Type	Method	Description
EdgeModuleEntity.DefinitionStages.Blank	define(String name)	Begins definition for a new EdgeModuleEntity resource.
void	delete(String resourceGroupName, String accountName, String edgeModuleName)	Deletes an existing edge module resource.
void	deleteById(String id)	Deletes an existing edge module resource.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes an existing edge module resource.
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.
EdgeModuleEntity	get(String resourceGroupName, String accountName, String edgeModuleName)	Retrieves an existing edge module resource with the given name.
EdgeModuleEntity	getById(String id)	Retrieves an existing edge module resource with the given name.
com.azure.core.http.rest.Response<EdgeModuleEntity>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Retrieves an existing edge module resource with the given name.
com.azure.core.http.rest.Response<EdgeModuleEntity>	getWithResponse(String resourceGroupName, String accountName, String edgeModuleName, com.azure.core.util.Context context)	Retrieves an existing edge module resource with the given name.
com.azure.core.http.rest.PagedIterable<EdgeModuleEntity>	list(String resourceGroupName, String accountName)	List all existing edge module resources, along with their JSON representations.
com.azure.core.http.rest.PagedIterable<EdgeModuleEntity>	list(String resourceGroupName, String accountName, Integer top, com.azure.core.util.Context context)	List all existing edge module resources, along with their JSON representations.
EdgeModuleProvisioningToken	listProvisioningToken(String resourceGroupName, String accountName, String edgeModuleName, ListProvisioningTokenInput parameters)	Creates a new provisioning token.
com.azure.core.http.rest.Response<EdgeModuleProvisioningToken>	listProvisioningTokenWithResponse(String resourceGroupName, String accountName, String edgeModuleName, ListProvisioningTokenInput parameters, com.azure.core.util.Context context)	Creates a new provisioning token.

Method Detail

list

com.azure.core.http.rest.PagedIterable<EdgeModuleEntity> 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<EdgeModuleEntity> 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

EdgeModuleEntity 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<EdgeModuleEntity> 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.

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

EdgeModuleProvisioningToken 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<EdgeModuleProvisioningToken> 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.

getById

EdgeModuleEntity getById(String id)

Retrieves an existing edge module resource with the given name.

Parameters:

id - the resource ID.

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.

getByIdWithResponse

com.azure.core.http.rest.Response<EdgeModuleEntity> getByIdWithResponse(String id,
                                                                        com.azure.core.util.Context context)

Retrieves an existing edge module resource with the given name.

Parameters:

id - the resource ID.

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.

deleteById

void deleteById(String id)

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:

id - the resource ID.

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.

deleteByIdWithResponse

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               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:

id - the resource ID.

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.

define

EdgeModuleEntity.DefinitionStages.Blank define(String name)

Begins definition for a new EdgeModuleEntity resource.

Parameters:

name - resource name.

Returns:

the first stage of the new EdgeModuleEntity definition.