az iot central app

Reference

Manage IoT Central applications.

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

Commands

Name	Description	Type	Status
az iot central app create	Create an IoT Central application.	Core	GA
az iot central app delete	Delete an IoT Central application.	Core	GA
az iot central app identity	Manage IoT Central application identities.	Core	GA
az iot central app identity assign	Assign managed identities to an IoT Central application.	Core	GA
az iot central app identity remove	Remove managed identities from an IoT Central application.	Core	GA
az iot central app identity show	Show the identity properties of an IoT Central application.	Core	GA
az iot central app list	List IoT Central applications.	Core	GA
az iot central app private-endpoint-connection	Manage private endpoint connection of IoT Central application.	Core	GA
az iot central app private-endpoint-connection approve	Approve a private endpoint connection request for an IoT Central application.	Core	GA
az iot central app private-endpoint-connection delete	Delete a private endpoint connection for an IoT Central application.	Core	GA
az iot central app private-endpoint-connection list	List all of the private endpoint connections for an IoT Central application.	Core	GA
az iot central app private-endpoint-connection reject	Reject a private endpoint connection request for an IoT Central application.	Core	GA
az iot central app private-endpoint-connection show	Show details of a private endpoint connection request for an IoT Central application.	Core	GA
az iot central app private-link-resource	Manage an IoT Central application private link resources.	Core	GA
az iot central app private-link-resource list	List all of the IoT Central application private link resources in the specified account.	Core	GA
az iot central app private-link-resource show	Show details of a private link resource in the specified IoT Central application.	Core	GA
az iot central app show	Get the details of an IoT Central application.	Core	GA
az iot central app update	Update metadata for an IoT Central application.	Core	GA

az iot central app create

Edit

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]
                          [--mi-system-assigned]
                          [--no-wait]
                          [--sku {ST0, ST1, ST2}]
                          [--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

Create an IoT Central application the in the 'East US' 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 eastus -p ST1 -t iotc-distribution

Create an IoT Central application using system-assigned managed identity.

az iot central app create -n my-first-iot-app -g MyResourceGroup -s my-iot-app --mi-system-assigned

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.

--mi-system-assigned

Provide this flag to use system assigned identity.

default value: False

--no-wait

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

default value: False

--sku -p

Pricing plan for IoT Central application.

accepted values: ST0, ST1, ST2

default value: ST2

--template -t

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot central app delete

Edit

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]
                          [--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.

default value: False

--yes -y

Do not prompt for confirmation.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot central app list

Edit

List IoT Central applications.

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

az iot central app list [--resource-group]

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

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot central app show

Edit

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
                        [--resource-group]

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

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot central app update

Edit

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]

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>.

default value: []

--force-string

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

default value: False

--remove

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

default value: []

--set

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

default value: []

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot central app

Commands

az iot central app create

Examples

Required Parameters

Optional Parameters

az iot central app delete

Examples

Required Parameters

Optional Parameters

az iot central app list

Examples

Optional Parameters

az iot central app show

Examples

Required Parameters

Optional Parameters

az iot central app update

Examples

Required Parameters

Optional Parameters

Feedback

Additional resources