az iot central app

Manage IoT Central applications.

Create, delete, view, and update your IoT Central apps.

Commands

az iot central app create

Create an IoT Central application.

az iot central app delete

Delete an IoT Central application.

az iot central app list

List IoT Central applications.

az iot central app show

Get the details of an IoT Central application.

az iot central app update

Update metadata for an IoT Central application.

az iot central app create

Create an IoT Central application.

An IoT Central app is a cloud-based application that you can use to manage your IoT devices. For more information on deploying an IoT Central app via CLI or a list of available arguments, visit https://aka.ms/iotcentral-manage-cli.

az iot central app create --name
                          --resource-group
                          --subdomain
                          [--display-name]
                          [--location]
                          [--no-wait]
                          [--sku {F1, S1, ST0, ST1, ST2}]
                          [--subscription]
                          [--template]

Examples

Create an IoT Central application in the region of the resource group using the default pricing SKU.

az iot central app create -n my-first-iot-app -g MyResourceGroup -s my-iot-app -l unitedstates

Create an IoT Central application the in the 'United States' region with the 'ST1' pricing plan and an industry template.

az iot central app create -n my-first-iot-app -g MyResourceGroup -s my-iot-app -l unitedstates -p ST1 -t iotc-distribution

Required Parameters

--name -n

Give your IoT Central app a unique name so you can find it later.This will be used as the resource name in the Azure portal and CLI.Avoid special characters - instead, use lower case letters (a-z), numbers (0-9), and dashes (-).

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subdomain -s

Enter a unique URL. Your app will be accessible via https://.azureiotcentral.com/. Avoid special characters - instead, use lower case letters (a-z), numbers (0-9), and dashes (-).

Optional Parameters

--display-name -d

Custom display name for the IoT Central app. This will be used in the IoT Central application manager to help you identify your app. Default value is the resource name.

--location -l

Where your app's info and resources are stored. We will default to the location of the target resource group. See documentation for a full list of supported locations.

--no-wait

Do not wait for the long-running operation to finish.

--sku -p

Pricing plan for IoT Central application.

accepted values: F1, S1, ST0, ST1, ST2
default value: ST2
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--template -t

IoT Central application template name. Default is "Custom application". See documentation for a list of available templates.

az iot central app delete

Delete an IoT Central application.

Permanently delete your IoT Central app. -Warning- This operation is irreversible. Once you've deleted your app, you cannot restore it.

az iot central app delete --name
                          --resource-group
                          [--no-wait]
                          [--subscription]
                          [--yes]

Examples

Delete an IoT Central app called 'my-first-iot-app'.

az iot central app delete -n my-first-iot-app -g MyResourceGroup

Required Parameters

--name -n

IoT Central application name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

az iot central app list

List IoT Central applications.

All of the IoT Central apps that are part of your subscription.

az iot central app list [--query-examples]
                        [--resource-group]
                        [--subscription]

Examples

List all IoT Central apps in my subscription.

az iot central app list

List all IoT Central apps in the resource group 'MyResourceGroup' within my subscription.

az iot central app list -g MyResourceGroup

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az iot central app show

Get the details of an IoT Central application.

Information about your app, like app name, subdomain, pricing plan, and location.

az iot central app show --name
                        [--query-examples]
                        [--resource-group]
                        [--subscription]

Examples

Show details for an app named 'my-first-iot-app'.

az iot central app show -n my-first-iot-app

Show details for an app named 'my-first-iot-app' in the resource group 'MyResourceGroup'.

az iot central app show -n my-first-iot-app -g MyResourceGroup

Required Parameters

--name -n

IoT Central application name.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az iot central app update

Update metadata for an IoT Central application.

Update metadata, like app name, subdomain, pricing plan, and location.

az iot central app update --name
                          --resource-group
                          [--add]
                          [--force-string]
                          [--remove]
                          [--set]
                          [--subscription]

Examples

Update the SKU for 'my-first-iot-app'

az iot central app update -n my-first-iot-app -g MyResourceGroup --set sku.name=ST1

Change the subdomain for 'my-first-iot-app'

az iot central app update -n my-first-iot-app -g MyResourceGroup --set subdomain.name=my-iot-app-new

Required Parameters

--name -n

IoT Central application name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.