You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: How to create an IoT Central application by using the Azure IoT Central site, the Azure portal, or a command-line environment.
3
+
description: How to create an IoT Central application by using the Azure portal or a command-line environment.
4
4
services: iot-central
5
5
ms.service: iot-central
6
6
author: dominicbetts
7
7
ms.author: dobett
8
-
ms.date: 07/14/2023
8
+
ms.date: 04/03/2024
9
9
ms.topic: how-to
10
10
---
11
11
12
12
# Create an IoT Central application
13
13
14
-
You have several ways to create an IoT Central application. You can use one of the GUI-based methods if you prefer a manual approach, or one of the CLI or programmatic methods if you want to automate the process.
14
+
There are multiple ways to create an IoT Central application. You can use a GUI-based method if you prefer a manual approach, or one of the CLI or programmatic methods if you need to automate the process.
15
15
16
16
Whichever approach you choose, the configuration options are the same, and the process typically takes less than a minute to complete.
17
17
18
18
[!INCLUDE [Warning About Access Required](../../../includes/iot-central-warning-contribitorrequireaccess.md)]
19
19
20
-
To learn how to manage IoT Central application by using the IoT Central REST API, see [Use the REST API to create and manage IoT Central applications.](../core/howto-manage-iot-central-with-rest-api.md)
20
+
Other approaches, not described in this article include:
21
21
22
-
## Options
22
+
-[Use the REST API to create and manage IoT Central applications.](../core/howto-manage-iot-central-with-rest-api.md).
23
+
-[Create and manage an Azure IoT Central application from the Microsoft Cloud Solution Provider portal](howto-create-and-manage-applications-csp.md).
23
24
24
-
This section describes the available options when you create an IoT Central application. Depending on the method you choose, you might need to supply the options on a form or as command-line parameters:
25
+
## Parameters
25
26
26
-
### Pricing plans
27
+
This section describes the available parameters when you create an IoT Central application. Depending on the method you choose to create your application, you might need to supply the parameter values on a web form or at the command-line. In some cases, there are default values that you can use:
27
28
28
-
The *standard* plans:
29
+
### Pricing plan
30
+
31
+
The _standard_ plans:
29
32
30
-
- You should have at least **Contributor** access in your Azure subscription. If you created the subscription yourself, you're automatically an administrator with sufficient access. To learn more, see [What is Azure role-based access control?](../../role-based-access-control/overview.md).
31
33
- Let you create and manage IoT Central applications using any of the available methods.
32
34
- Let you connect as many devices as you need. You're billed by device. To learn more, see [Azure IoT Central pricing](https://azure.microsoft.com/pricing/details/iot-central/).
33
35
- Can be upgraded or downgraded to other standard plans.
@@ -48,33 +50,32 @@ The _subdomain_ you choose uniquely identifies your application. The subdomain i
48
50
49
51
### Application template ID
50
52
51
-
The application template you choose determines the initial contents of your application, such as dashboards and device templates. The template ID For a custom application, use `iotc-pnp-preview` as the template ID.
53
+
The application template you choose determines the initial contents of your application, such as dashboards and device templates. For a custom application, use `iotc-pnp-preview` as the template ID.
54
+
55
+
The following table lists the available application templates:
If you choose one of the standard plans, you need to provide billing information:
56
62
57
63
- The Azure subscription you're using.
58
64
- The directory that contains the subscription you're using.
59
-
- The location to host your application. IoT Central uses Azure regions as locations: Australia East, Canada Central, Central US, East US, East US 2, Japan East, North Europe, South Central US, Southeast Asia, UK South, West Europe, and West US.
60
65
61
-
##Azure portal
66
+
### Location
62
67
63
-
The easiest way to get started creating IoT Central applications is in the [Azure portal](https://portal.azure.com/#create/Microsoft.IoTCentral).
68
+
The location to host your application. IoT Central uses Azure regions as locations. Currently, you can choose from: Australia East, Canada Central, Central US, East US, East US 2, Japan East, North Europe, South Central US, Southeast Asia, UK South, West Europe, and West US.
64
69
65
-
[!INCLUDE [Warning About Access Required](../../../includes/iot-central-warning-contribitorrequireaccess.md)]
70
+
### Resource group
66
71
67
-
Enter the following information:
72
+
Some methods require you to specify a resource group in the Azure subscription where the application is created. You can create a new resource group or use an existing one.
68
73
69
-
| Field | Description |
70
-
| ----- | ----------- |
71
-
| Subscription | The Azure subscription you want to use. |
72
-
| Resource group | The resource group you want to use. You can create a new resource group or use an existing one. |
73
-
| Resource name | A valid Azure resource name. |
74
-
| Application URL | The URL subdomain for your application. The URL for an IoT Central application looks like `https://yoursubdomain.azureiotcentral.com`. |
75
-
| Template | The application template you want to use. For a blank application template, select **Custom application**.|
76
-
| Region | The Azure region you want to use. |
77
-
| Pricing plan | The pricing plan you want to use. |
74
+
## Create an application
75
+
76
+
# [Azure portal](#tab/azure-portal)
77
+
78
+
The easiest way to get started creating IoT Central applications is in the [Azure portal](https://portal.azure.com/#create/Microsoft.IoTCentral).
78
79
79
80
:::image type="content" source="media/howto-create-iot-central-application/create-app-portal.png" alt-text="Screenshot that shows the create application experience in the Azure portal.":::
80
81
@@ -84,34 +85,99 @@ When the app is ready, you can navigate to it from the Azure portal:
84
85
85
86
:::image type="content" source="media/howto-create-iot-central-application/view-app-portal.png" alt-text="Screenshot that shows the IoT Central application resource in the Azure portal. The application URL is highlighted.":::
86
87
87
-
To list all the IoT Central apps you've created, navigate to [IoT Central Applications](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.IoTCentral%2FIoTApps).
88
+
To list all the IoT Central apps in your subscription, navigate to [IoT Central Applications](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.IoTCentral%2FIoTApps).
89
+
90
+
# [Azure CLI](#tab/azure-cli)
91
+
92
+
If you haven't already installed the extension, run the following command to install it:
93
+
94
+
```azurecli
95
+
az extension add --name azure-iot
96
+
```
97
+
98
+
Use the [az iot central app create](/cli/azure/iot/central/app#az-iot-central-app-create) command to create an IoT Central application in your Azure subscription. For example, to create a custom application in the _MyIoTCentralResourceGroup_ resource group:
99
+
100
+
```azurecli
101
+
# Create a resource group for the IoT Central application
To list all the IoT Central apps in your subscription, run the following command:
114
+
115
+
```azurecli
116
+
az iot central app list
117
+
```
118
+
119
+
# [PowerShell](#tab/azure-powershell)
120
+
121
+
If you haven't already installed the PowerShell module, run the following command to install it:
122
+
123
+
```powershell
124
+
Install-Module Az.IotCentral
125
+
```
126
+
127
+
Use the [New-AzIotCentralApp](/powershell/module/az.iotcentral/New-AzIotCentralApp) cmdlet to create an IoT Central application in your Azure subscription. For example, to create a custom application in the _MyIoTCentralResourceGroup_ resource group:
128
+
129
+
```powershell
130
+
# Create a resource group for the IoT Central application
To list all the IoT Central apps in your subscription, run the following command:
142
+
143
+
```powershell
144
+
Get-AzIotCentralApp
145
+
```
146
+
147
+
---
88
148
89
149
To list all the IoT Central applications you have access to, navigate to [IoT Central Applications](https://apps.azureiotcentral.com/myapps).
90
150
91
151
## Copy an application
92
152
93
-
You can create a copy of any application, minus any device instances, device data history, and user data. The copy uses a standard pricing plan that you'll be billed for.
153
+
You can create a copy of any application, minus any device instances, device data history, and user data. The copy uses a standard pricing plan that you're billed for:
94
154
95
-
Navigate to **Application > Management** and select **Copy**. In the dialog box, enter the details for the new application. Then select **Copy** to confirm that you want to continue. To learn more about the fields in the form, see [Options](#options).
155
+
1. Sign in to the application you want to copy.
156
+
1. Navigate to **Application > Management** and select **Copy**.
157
+
1. In the dialog box, enter the details for the new application.
158
+
1. Select **Copy** to confirm that you want to continue.
96
159
97
160
:::image type="content" source="media/howto-create-iot-central-application/app-copy.png" alt-text="Screenshot that shows the copy application settings page." lightbox="media/howto-create-iot-central-application/app-copy.png":::
98
161
99
162
After the application copy operation succeeds, you can navigate to the new application using the link.
100
163
101
-
Copying an application also copies the definition of rules and email action. Some actions, such as Flow and Logic Apps, are tied to specific rules by the rule ID. When a rule is copied to a different application, it gets its own rule ID. In this case, users must create a new action and then associate the new rule with it. In general, it's a good idea to check the rules and actions to make sure they're up-to-date in the new application.
164
+
Be aware of the following issues in the new application:
102
165
103
-
> [!WARNING]
104
-
> If a dashboard includes tiles that display information about specific devices, then those tiles show **The requested resource was not found** in the new application. You must reconfigure these tiles to display information about devices in your new application.
166
+
- Copying an application also copies the definition of rules and email actions. Some actions, such as _Flow and Logic Apps_, are tied to specific rules by the rule ID. When a rule is copied to a different application, it gets its own rule ID. In this case, users must create a new action and then associate the new rule with it. In general, it's a good idea to check the rules and actions to make sure they're up-to-date in the new application.
167
+
168
+
- If a dashboard includes tiles that display information about specific devices, then those tiles show **The requested resource was not found** in the new application. You must reconfigure these tiles to display information about devices in your new application.
105
169
106
170
## Create and use a custom application template
107
171
108
172
When you create an Azure IoT Central application, you choose from the built-in sample templates. You can also create your own application templates from existing IoT Central applications. You can then use your own application templates when you create new applications.
109
173
174
+
### What's in your application template?
175
+
110
176
When you create an application template, it includes the following items from your existing application:
111
177
112
-
- The default application dashboard, including the dashboard layout and all the tiles you've defined.
113
-
- Device templates, including measurements, settings, properties, commands, and dashboard.
114
-
-Rules. All rule definitions are included. However actions, except for email actions, aren't included.
178
+
- The default application dashboard, including the dashboard layout and all the tiles you defined.
179
+
- Device templates, including measurements, settings, properties, commands, and views.
180
+
- All rule definitions are included. However actions, except for email actions, aren't included.
115
181
- Device groups, including their queries.
116
182
117
183
> [!WARNING]
@@ -125,9 +191,11 @@ When you create an application template, it doesn't include the following items:
125
191
126
192
Add these items manually to any applications created from an application template.
127
193
194
+
### Create an application template
195
+
128
196
To create an application template from an existing IoT Central application:
129
197
130
-
1.Go to the **Application** section in your application.
198
+
1.Navigate to the **Application** section in your application.
131
199
1. Select **Template Export**.
132
200
1. On the **Template Export** page, enter a name and description for your template.
133
201
1. Select the **Export** button to create the application template. You can now copy the **Shareable Link** that enables someone to create a new application from the template:
@@ -148,16 +216,9 @@ If you delete an application template, you can no longer use the previously gene
148
216
149
217
To update your application template, change the template name or description on the **Application Template Export** page. Then select the **Export** button again. This action generates a new **Shareable link** and invalidates any previous **Shareable link** URL.
150
218
151
-
## Other approaches
152
-
153
-
You can also use the following approaches to create an IoT Central application:
154
-
155
-
-[Create an IoT Central application using the command line](howto-manage-iot-central-from-cli.md#create-an-application)
156
-
-[Create an IoT Central application programmatically](/samples/azure-samples/azure-iot-central-arm-sdk-samples/azure-iot-central-arm-sdk-samples/)
157
-
158
-
## Next steps
219
+
## Next step
159
220
160
-
Now that you've learned how to manage Azure IoT Central applications from Azure CLI, here's the suggested next step:
221
+
Now that you've learned how to create Azure IoT Central applications, here's the suggested next step:
161
222
162
223
> [!div class="nextstepaction"]
163
-
> [Administer your application](howto-administer.md)
224
+
> [Manage and monitor IoT Central applications](howto-manage-and-monitor-iot-central.md)
Copy file name to clipboardExpand all lines: articles/iot-central/core/howto-integrate-with-devops.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -350,6 +350,6 @@ When your pipeline job completes successfully, sign in to your production IoT Ce
350
350
351
351
Now that you have a working pipeline you can manage your IoT Central instances directly by using configuration changes. You can upload new device templates into the *Device Models* folder and make changes directly to the configuration file. This approach lets you treat your IoT Central application's configuration the same as any other code.
352
352
353
-
## Next steps
353
+
## Next step
354
354
355
-
Now that you know how to integrate IoT Central configurations into your CI/CD pipelines, a suggested next step is to learn how to [Manage and monitor IoT Central from the Azure portal](howto-manage-iot-central-from-portal.md).
355
+
Now that you know how to integrate IoT Central configurations into your CI/CD pipelines, a suggested next step is to learn how to [Manage and monitor IoT Central applications](howto-manage-and-monitor-iot-central.md).
0 commit comments