Apps interface

Package:

@azure/arm-iotcentral

Interface representing a Apps.

Methods

beginCreateOrUpdate(string, string, App, AppsCreateOrUpdateOptionalParams)	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.
beginCreateOrUpdateAndWait(string, string, App, AppsCreateOrUpdateOptionalParams)	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.
beginDelete(string, string, AppsDeleteOptionalParams)	Delete an IoT Central application.
beginDeleteAndWait(string, string, AppsDeleteOptionalParams)	Delete an IoT Central application.
beginUpdate(string, string, AppPatch, AppsUpdateOptionalParams)	Update the metadata of an IoT Central application.
beginUpdateAndWait(string, string, AppPatch, AppsUpdateOptionalParams)	Update the metadata of an IoT Central application.
checkNameAvailability(OperationInputs, AppsCheckNameAvailabilityOptionalParams)	Check if an IoT Central application name is available.
checkSubdomainAvailability(OperationInputs, AppsCheckSubdomainAvailabilityOptionalParams)	Check if an IoT Central application subdomain is available.
get(string, string, AppsGetOptionalParams)	Get the metadata of an IoT Central application.
listByResourceGroup(string, AppsListByResourceGroupOptionalParams)	Get all the IoT Central Applications in a resource group.
listBySubscription(AppsListBySubscriptionOptionalParams)	Get all IoT Central Applications in a subscription.
listTemplates(AppsListTemplatesOptionalParams)	Get all available application templates.

Method Details

beginCreateOrUpdate(string, string, App, AppsCreateOrUpdateOptionalParams)

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.

function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, app: App, options?: AppsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<App>, App>>

Parameters

resourceGroupName

string

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

resourceName

string

The ARM resource name of the IoT Central application.

app

App

The IoT Central application metadata and security metadata.

options

AppsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<App>, App>>

beginCreateOrUpdateAndWait(string, string, App, AppsCreateOrUpdateOptionalParams)

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.

function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, app: App, options?: AppsCreateOrUpdateOptionalParams): Promise<App>

Parameters

resourceGroupName

string

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

resourceName

string

The ARM resource name of the IoT Central application.

app

App

The IoT Central application metadata and security metadata.

options

AppsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<App>

beginDelete(string, string, AppsDeleteOptionalParams)

Delete an IoT Central application.

function beginDelete(resourceGroupName: string, resourceName: string, options?: AppsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

resourceName

string

The ARM resource name of the IoT Central application.

options

AppsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, AppsDeleteOptionalParams)

Delete an IoT Central application.

function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: AppsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

resourceName

string

The ARM resource name of the IoT Central application.

options

AppsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, AppPatch, AppsUpdateOptionalParams)

Update the metadata of an IoT Central application.

function beginUpdate(resourceGroupName: string, resourceName: string, appPatch: AppPatch, options?: AppsUpdateOptionalParams): Promise<PollerLike<PollOperationState<App>, App>>

Parameters

resourceGroupName

string

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

resourceName

string

The ARM resource name of the IoT Central application.

appPatch

AppPatch

The IoT Central application metadata and security metadata.

options

AppsUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<App>, App>>

beginUpdateAndWait(string, string, AppPatch, AppsUpdateOptionalParams)

Update the metadata of an IoT Central application.

function beginUpdateAndWait(resourceGroupName: string, resourceName: string, appPatch: AppPatch, options?: AppsUpdateOptionalParams): Promise<App>

Parameters

resourceGroupName

string

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

resourceName

string

The ARM resource name of the IoT Central application.

appPatch

AppPatch

The IoT Central application metadata and security metadata.

options

AppsUpdateOptionalParams

The options parameters.

Returns

Promise<App>

checkNameAvailability(OperationInputs, AppsCheckNameAvailabilityOptionalParams)

Check if an IoT Central application name is available.

function checkNameAvailability(operationInputs: OperationInputs, options?: AppsCheckNameAvailabilityOptionalParams): Promise<AppAvailabilityInfo>

Parameters

operationInputs

OperationInputs

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

options

AppsCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<AppAvailabilityInfo>

checkSubdomainAvailability(OperationInputs, AppsCheckSubdomainAvailabilityOptionalParams)

Check if an IoT Central application subdomain is available.

function checkSubdomainAvailability(operationInputs: OperationInputs, options?: AppsCheckSubdomainAvailabilityOptionalParams): Promise<AppAvailabilityInfo>

Parameters

operationInputs

OperationInputs

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

options

AppsCheckSubdomainAvailabilityOptionalParams

The options parameters.

Returns

Promise<AppAvailabilityInfo>

get(string, string, AppsGetOptionalParams)

Get the metadata of an IoT Central application.

function get(resourceGroupName: string, resourceName: string, options?: AppsGetOptionalParams): Promise<App>

Parameters

resourceGroupName

string

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

resourceName

string

The ARM resource name of the IoT Central application.

options

AppsGetOptionalParams

The options parameters.

Returns

Promise<App>

listByResourceGroup(string, AppsListByResourceGroupOptionalParams)

Get all the IoT Central Applications in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: AppsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<App, App[], PageSettings>

Parameters

resourceGroupName

string

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

options

AppsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<App, App[], PageSettings>

listBySubscription(AppsListBySubscriptionOptionalParams)

Get all IoT Central Applications in a subscription.

function listBySubscription(options?: AppsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<App, App[], PageSettings>

Parameters

options

AppsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<App, App[], PageSettings>

listTemplates(AppsListTemplatesOptionalParams)

Get all available application templates.

function listTemplates(options?: AppsListTemplatesOptionalParams): PagedAsyncIterableIterator<AppTemplate, AppTemplate[], PageSettings>

Parameters

options

AppsListTemplatesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AppTemplate, AppTemplate[], PageSettings>