Apps Interface

Package:

com.azure.resourcemanager.iotcentral.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-iotcentral:1.1.0-beta.2

public interface Apps

Resource collection API of Apps.

Method Summary

Modifier and Type	Method and Description
abstract AppAvailabilityInfo	checkNameAvailability(OperationInputs operationInputs) Check if an IoT Central application name is available.
abstract Response<AppAvailabilityInfo>	checkNameAvailabilityWithResponse(OperationInputs operationInputs, Context context) Check if an IoT Central application name is available.
abstract AppAvailabilityInfo	checkSubdomainAvailability(OperationInputs operationInputs) Check if an IoT Central application subdomain is available.
abstract Response<AppAvailabilityInfo>	checkSubdomainAvailabilityWithResponse(OperationInputs operationInputs, Context context) Check if an IoT Central application subdomain is available.
abstract Blank	define(String name) Begins definition for a new App resource.
abstract void	delete(String resourceGroupName, String resourceName, Context context) Delete an IoT Central application.
abstract void	deleteById(String id) Delete an IoT Central application.
abstract void	deleteByIdWithResponse(String id, Context context) Delete an IoT Central application.
abstract void	deleteByResourceGroup(String resourceGroupName, String resourceName) Delete an IoT Central application.
abstract App	getById(String id) Get the metadata of an IoT Central application.
abstract Response<App>	getByIdWithResponse(String id, Context context) Get the metadata of an IoT Central application.
abstract App	getByResourceGroup(String resourceGroupName, String resourceName) Get the metadata of an IoT Central application.
abstract Response<App>	getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context) Get the metadata of an IoT Central application.
abstract PagedIterable<App>	list() Get all IoT Central Applications in a subscription.
abstract PagedIterable<App>	list(Context context) Get all IoT Central Applications in a subscription.
abstract PagedIterable<App>	listByResourceGroup(String resourceGroupName) Get all the IoT Central Applications in a resource group.
abstract PagedIterable<App>	listByResourceGroup(String resourceGroupName, Context context) Get all the IoT Central Applications in a resource group.
abstract PagedIterable<AppTemplate>	listTemplates() Get all available application templates.
abstract PagedIterable<AppTemplate>	listTemplates(Context context) Get all available application templates.
abstract void	update(String resourceGroupName, String resourceName, AppPatch appPatch) Update the metadata of an IoT Central application.
abstract void	update(String resourceGroupName, String resourceName, AppPatch appPatch, Context context) Update the metadata of an IoT Central application.

Method Details

checkNameAvailability

public abstract AppAvailabilityInfo checkNameAvailability(OperationInputs operationInputs)

Check if an IoT Central application name is available.

Parameters:

operationInputs - Set the name parameter in the OperationInputs structure to the name of the IoT Central application to check.

Returns:

the properties indicating whether a given IoT Central application name or subdomain is available.

checkNameAvailabilityWithResponse

public abstract Response<AppAvailabilityInfo> checkNameAvailabilityWithResponse(OperationInputs operationInputs, Context context)

Check if an IoT Central application name is available.

Parameters:

operationInputs - Set the name parameter in the OperationInputs structure to the name of the IoT Central application to check.

context - The context to associate with this operation.

Returns:

the properties indicating whether a given IoT Central application name or subdomain is available along with Response<T>.

checkSubdomainAvailability

public abstract AppAvailabilityInfo checkSubdomainAvailability(OperationInputs operationInputs)

Check if an IoT Central application subdomain is available.

Parameters:

operationInputs - Set the name parameter in the OperationInputs structure to the subdomain of the IoT Central application to check.

Returns:

the properties indicating whether a given IoT Central application name or subdomain is available.

checkSubdomainAvailabilityWithResponse

public abstract Response<AppAvailabilityInfo> checkSubdomainAvailabilityWithResponse(OperationInputs operationInputs, Context context)

Check if an IoT Central application subdomain is available.

Parameters:

operationInputs - Set the name parameter in the OperationInputs structure to the subdomain of the IoT Central application to check.

context - The context to associate with this operation.

Returns:

the properties indicating whether a given IoT Central application name or subdomain is available along with Response<T>.

define

public abstract App.DefinitionStages.Blank define(String name)

Begins definition for a new App resource.

Parameters:

name - resource name.

Returns:

the first stage of the new App definition.

delete

public abstract void delete(String resourceGroupName, String resourceName, Context context)

Delete an IoT Central application.

Parameters:

resourceGroupName - The name of the resource group that contains the IoT Central application.

resourceName - The ARM resource name of the IoT Central application.

context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Delete an IoT Central application.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete an IoT Central application.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String resourceName)

Delete an IoT Central application.

Parameters:

resourceGroupName - The name of the resource group that contains the IoT Central application.

resourceName - The ARM resource name of the IoT Central application.

getById

public abstract App getById(String id)

Get the metadata of an IoT Central application.

Parameters:

id - the resource ID.

Returns:

the metadata of an IoT Central application along with Response<T>.

getByIdWithResponse

public abstract Response<App> getByIdWithResponse(String id, Context context)

Get the metadata of an IoT Central application.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the metadata of an IoT Central application along with Response<T>.

getByResourceGroup

public abstract App getByResourceGroup(String resourceGroupName, String resourceName)

Get the metadata of an IoT Central application.

Parameters:

resourceGroupName - The name of the resource group that contains the IoT Central application.

resourceName - The ARM resource name of the IoT Central application.

Returns:

the metadata of an IoT Central application.

getByResourceGroupWithResponse

public abstract Response<App> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)

Get the metadata of an IoT Central application.

Parameters:

resourceGroupName - The name of the resource group that contains the IoT Central application.

resourceName - The ARM resource name of the IoT Central application.

context - The context to associate with this operation.

Returns:

the metadata of an IoT Central application along with Response<T>.

list

public abstract PagedIterable<App> list()

Get all IoT Central Applications in a subscription.

Returns:

all IoT Central Applications in a subscription as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<App> list(Context context)

Get all IoT Central Applications in a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

all IoT Central Applications in a subscription as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<App> listByResourceGroup(String resourceGroupName)

Get all the IoT Central Applications in a resource group.

Parameters:

resourceGroupName - The name of the resource group that contains the IoT Central application.

Returns:

all the IoT Central Applications in a resource group as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<App> listByResourceGroup(String resourceGroupName, Context context)

Get all the IoT Central Applications in a resource group.

Parameters:

resourceGroupName - The name of the resource group that contains the IoT Central application.

context - The context to associate with this operation.

Returns:

all the IoT Central Applications in a resource group as paginated response with PagedIterable<T>.

listTemplates

public abstract PagedIterable<AppTemplate> listTemplates()

Get all available application templates.

Returns:

all available application templates as paginated response with PagedIterable<T>.

listTemplates

public abstract PagedIterable<AppTemplate> listTemplates(Context context)

Get all available application templates.

Parameters:

context - The context to associate with this operation.

Returns:

all available application templates as paginated response with PagedIterable<T>.

update

public abstract void update(String resourceGroupName, String resourceName, AppPatch appPatch)

Update the metadata of an IoT Central application.

Parameters:

resourceGroupName - The name of the resource group that contains the IoT Central application.

resourceName - The ARM resource name of the IoT Central application.

appPatch - The IoT Central application metadata and security metadata.

update

public abstract void update(String resourceGroupName, String resourceName, AppPatch appPatch, Context context)

Update the metadata of an IoT Central application.

Parameters:

resourceGroupName - The name of the resource group that contains the IoT Central application.

resourceName - The ARM resource name of the IoT Central application.

appPatch - The IoT Central application metadata and security metadata.

context - The context to associate with this operation.