Package com.azure.resourcemanager.iotcentral.models

Interface Apps

public interface Apps

Resource collection API of Apps.

Method Summary

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

Method Detail

getByResourceGroup

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.

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.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<App> getByResourceGroupWithResponse(String resourceGroupName,
                                                                      String resourceName,
                                                                      com.azure.core.util.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.

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.

update

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.

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.

update

void update(String resourceGroupName,
            String resourceName,
            AppPatch appPatch,
            com.azure.core.util.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.

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.

deleteByResourceGroup

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.

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 resourceName,
            com.azure.core.util.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.

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<App> list()

Get all IoT Central Applications in a subscription.

Returns:

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

Throws:

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<App> list(com.azure.core.util.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.

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.

listByResourceGroup

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

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.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<App> listByResourceGroup(String resourceGroupName,
                                                                com.azure.core.util.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.

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.

checkNameAvailability

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.

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.

checkNameAvailabilityWithResponse

com.azure.core.http.rest.Response<AppAvailabilityInfo> checkNameAvailabilityWithResponse(OperationInputs operationInputs,
                                                                                         com.azure.core.util.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.

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.

checkSubdomainAvailability

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.

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.

checkSubdomainAvailabilityWithResponse

com.azure.core.http.rest.Response<AppAvailabilityInfo> checkSubdomainAvailabilityWithResponse(OperationInputs operationInputs,
                                                                                              com.azure.core.util.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.

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.

listTemplates

com.azure.core.http.rest.PagedIterable<AppTemplate> listTemplates()

Get all available application templates.

Returns:

all available application templates as paginated response with PagedIterable.

Throws:

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.

listTemplates

com.azure.core.http.rest.PagedIterable<AppTemplate> listTemplates(com.azure.core.util.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.

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

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.

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<App> getByIdWithResponse(String id,
                                                           com.azure.core.util.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.

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)

Delete an IoT Central application.

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

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Delete an IoT Central application.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

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

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.