Share via


AppsClient Interface

public interface AppsClient

An instance of this class provides access to all the operations defined in AppsClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<AppInner>,AppInner> beginCreateOrUpdate(String resourceGroupName, String resourceName, AppInner app)

Create or update the metadata of an IoT Central application.

abstract SyncPoller<PollResult<AppInner>,AppInner> beginCreateOrUpdate(String resourceGroupName, String resourceName, AppInner app, Context context)

Create or update the metadata of an IoT Central application.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String resourceName)

Delete an IoT Central application.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String resourceName, Context context)

Delete an IoT Central application.

abstract SyncPoller<PollResult<AppInner>,AppInner> beginUpdate(String resourceGroupName, String resourceName, AppPatch appPatch)

Update the metadata of an IoT Central application.

abstract SyncPoller<PollResult<AppInner>,AppInner> beginUpdate(String resourceGroupName, String resourceName, AppPatch appPatch, Context context)

Update the metadata of an IoT Central application.

abstract AppAvailabilityInfoInner checkNameAvailability(OperationInputs operationInputs)

Check if an IoT Central application name is available.

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

Check if an IoT Central application name is available.

abstract AppAvailabilityInfoInner checkSubdomainAvailability(OperationInputs operationInputs)

Check if an IoT Central application subdomain is available.

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

Check if an IoT Central application subdomain is available.

abstract AppInner createOrUpdate(String resourceGroupName, String resourceName, AppInner app)

Create or update the metadata of an IoT Central application.

abstract AppInner createOrUpdate(String resourceGroupName, String resourceName, AppInner app, Context context)

Create or update the metadata of an IoT Central application.

abstract void delete(String resourceGroupName, String resourceName)

Delete an IoT Central application.

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

Delete an IoT Central application.

abstract AppInner getByResourceGroup(String resourceGroupName, String resourceName)

Get the metadata of an IoT Central application.

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

Get the metadata of an IoT Central application.

abstract PagedIterable<AppInner> list()

Get all IoT Central Applications in a subscription.

abstract PagedIterable<AppInner> list(Context context)

Get all IoT Central Applications in a subscription.

abstract PagedIterable<AppInner> listByResourceGroup(String resourceGroupName)

Get all the IoT Central Applications in a resource group.

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

Get all the IoT Central Applications in a resource group.

abstract PagedIterable<AppTemplateInner> listTemplates()

Get all available application templates.

abstract PagedIterable<AppTemplateInner> listTemplates(Context context)

Get all available application templates.

abstract AppInner update(String resourceGroupName, String resourceName, AppPatch appPatch)

Update the metadata of an IoT Central application.

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

Update the metadata of an IoT Central application.

Method Details

beginCreateOrUpdate

public abstract SyncPoller<PollResult<AppInner>,AppInner> beginCreateOrUpdate(String resourceGroupName, String resourceName, AppInner app)

Create or update the metadata of an IoT Central application. The usual pattern to modify a property is to retrieve the IoT Central application metadata and security metadata, and then combine them with the modified values in a new body to update the 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.
app - The IoT Central application metadata and security metadata.

Returns:

the IoT Central application.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<AppInner>,AppInner> beginCreateOrUpdate(String resourceGroupName, String resourceName, AppInner app, Context context)

Create or update the metadata of an IoT Central application. The usual pattern to modify a property is to retrieve the IoT Central application metadata and security metadata, and then combine them with the modified values in a new body to update the 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.
app - The IoT Central application metadata and security metadata.
context - The context to associate with this operation.

Returns:

the IoT Central application.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(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.

Returns:

the completion.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(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.

Returns:

the completion.

beginUpdate

public abstract SyncPoller<PollResult<AppInner>,AppInner> beginUpdate(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.

Returns:

the IoT Central application.

beginUpdate

public abstract SyncPoller<PollResult<AppInner>,AppInner> beginUpdate(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.

Returns:

the IoT Central application.

checkNameAvailability

public abstract AppAvailabilityInfoInner 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<AppAvailabilityInfoInner> 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.

checkSubdomainAvailability

public abstract AppAvailabilityInfoInner 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<AppAvailabilityInfoInner> 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.

createOrUpdate

public abstract AppInner createOrUpdate(String resourceGroupName, String resourceName, AppInner app)

Create or update the metadata of an IoT Central application. The usual pattern to modify a property is to retrieve the IoT Central application metadata and security metadata, and then combine them with the modified values in a new body to update the 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.
app - The IoT Central application metadata and security metadata.

Returns:

the IoT Central application.

createOrUpdate

public abstract AppInner createOrUpdate(String resourceGroupName, String resourceName, AppInner app, Context context)

Create or update the metadata of an IoT Central application. The usual pattern to modify a property is to retrieve the IoT Central application metadata and security metadata, and then combine them with the modified values in a new body to update the 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.
app - The IoT Central application metadata and security metadata.
context - The context to associate with this operation.

Returns:

the IoT Central application.

delete

public abstract void delete(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.

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.

getByResourceGroup

public abstract AppInner 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<AppInner> 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.

list

public abstract PagedIterable<AppInner> list()

Get all IoT Central Applications in a subscription.

Returns:

all IoT Central Applications in a subscription.

list

public abstract PagedIterable<AppInner> 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.

listByResourceGroup

public abstract PagedIterable<AppInner> 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.

listByResourceGroup

public abstract PagedIterable<AppInner> 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.

listTemplates

public abstract PagedIterable<AppTemplateInner> listTemplates()

Get all available application templates.

Returns:

all available application templates.

listTemplates

public abstract PagedIterable<AppTemplateInner> listTemplates(Context context)

Get all available application templates.

Parameters:

context - The context to associate with this operation.

Returns:

all available application templates.

update

public abstract AppInner 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.

Returns:

the IoT Central application.

update

public abstract AppInner 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.

Returns:

the IoT Central application.

Applies to