Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Microsoft.IoTCentral iotApps
Bicep resource definition
The iotApps resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.IoTCentral/iotApps resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.IoTCentral/iotApps@2021-11-01-preview' = {
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
displayName: 'string'
networkRuleSets: {
applyToDevices: bool
applyToIoTCentral: bool
defaultAction: 'string'
ipRules: [
{
filterName: 'string'
ipMask: 'string'
}
]
}
publicNetworkAccess: 'string'
subdomain: 'string'
template: 'string'
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.IoTCentral/iotApps
| Name | Description | Value |
|---|---|---|
| identity | The managed identities for the IoT Central application. | SystemAssignedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The common properties of an IoT Central application. | AppProperties |
| sku | A valid instance SKU. | AppSkuInfo (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AppProperties
| Name | Description | Value |
|---|---|---|
| displayName | The display name of the application. | string |
| networkRuleSets | Network Rule Set Properties of this IoT Central application. | NetworkRuleSets |
| publicNetworkAccess | Whether requests from the public network are allowed. | 'Disabled' 'Enabled' |
| subdomain | The subdomain of the application. | string |
| template | The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. | string |
AppSkuInfo
| Name | Description | Value |
|---|---|---|
| name | The name of the SKU. | 'ST0' 'ST1' 'ST2' (required) |
NetworkRuleSetIpRule
| Name | Description | Value |
|---|---|---|
| filterName | The readable name of the IP rule. | string |
| ipMask | The CIDR block defining the IP range. | string |
NetworkRuleSets
| Name | Description | Value |
|---|---|---|
| applyToDevices | Whether these rules apply for device connectivity to IoT Hub and Device Provisioning service associated with this application. | bool |
| applyToIoTCentral | Whether these rules apply for connectivity via IoT Central web portal and APIs. | bool |
| defaultAction | The default network action to apply. | 'Allow' 'Deny' |
| ipRules | List of IP rules. | NetworkRuleSetIpRule[] |
SystemAssignedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (either system assigned, or none). | 'None' 'SystemAssigned' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Bicep Samples
A basic example of deploying IotCentral Application.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource iotApp 'Microsoft.IoTCentral/iotApps@2021-11-01-preview' = {
name: resourceName
location: location
sku: {
name: 'ST1'
}
properties: {
displayName: resourceName
publicNetworkAccess: 'Enabled'
subdomain: 'subdomain-2306300333537'
template: 'iotc-pnp-preview@1.0.0'
}
}
ARM template resource definition
The iotApps resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.IoTCentral/iotApps resource, add the following JSON to your template.
{
"type": "Microsoft.IoTCentral/iotApps",
"apiVersion": "2021-11-01-preview",
"name": "string",
"identity": {
"type": "string"
},
"location": "string",
"properties": {
"displayName": "string",
"networkRuleSets": {
"applyToDevices": "bool",
"applyToIoTCentral": "bool",
"defaultAction": "string",
"ipRules": [
{
"filterName": "string",
"ipMask": "string"
}
]
},
"publicNetworkAccess": "string",
"subdomain": "string",
"template": "string"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.IoTCentral/iotApps
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-11-01-preview' |
| identity | The managed identities for the IoT Central application. | SystemAssignedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The common properties of an IoT Central application. | AppProperties |
| sku | A valid instance SKU. | AppSkuInfo (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.IoTCentral/iotApps' |
AppProperties
| Name | Description | Value |
|---|---|---|
| displayName | The display name of the application. | string |
| networkRuleSets | Network Rule Set Properties of this IoT Central application. | NetworkRuleSets |
| publicNetworkAccess | Whether requests from the public network are allowed. | 'Disabled' 'Enabled' |
| subdomain | The subdomain of the application. | string |
| template | The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. | string |
AppSkuInfo
| Name | Description | Value |
|---|---|---|
| name | The name of the SKU. | 'ST0' 'ST1' 'ST2' (required) |
NetworkRuleSetIpRule
| Name | Description | Value |
|---|---|---|
| filterName | The readable name of the IP rule. | string |
| ipMask | The CIDR block defining the IP range. | string |
NetworkRuleSets
| Name | Description | Value |
|---|---|---|
| applyToDevices | Whether these rules apply for device connectivity to IoT Hub and Device Provisioning service associated with this application. | bool |
| applyToIoTCentral | Whether these rules apply for connectivity via IoT Central web portal and APIs. | bool |
| defaultAction | The default network action to apply. | 'Allow' 'Deny' |
| ipRules | List of IP rules. | NetworkRuleSetIpRule[] |
SystemAssignedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (either system assigned, or none). | 'None' 'SystemAssigned' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The iotApps resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.IoTCentral/iotApps resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.IoTCentral/iotApps@2021-11-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
displayName = "string"
networkRuleSets = {
applyToDevices = bool
applyToIoTCentral = bool
defaultAction = "string"
ipRules = [
{
filterName = "string"
ipMask = "string"
}
]
}
publicNetworkAccess = "string"
subdomain = "string"
template = "string"
}
sku = {
name = "string"
}
}
}
Property Values
Microsoft.IoTCentral/iotApps
| Name | Description | Value |
|---|---|---|
| identity | The managed identities for the IoT Central application. | SystemAssignedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The common properties of an IoT Central application. | AppProperties |
| sku | A valid instance SKU. | AppSkuInfo (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.IoTCentral/iotApps@2021-11-01-preview" |
AppProperties
| Name | Description | Value |
|---|---|---|
| displayName | The display name of the application. | string |
| networkRuleSets | Network Rule Set Properties of this IoT Central application. | NetworkRuleSets |
| publicNetworkAccess | Whether requests from the public network are allowed. | 'Disabled' 'Enabled' |
| subdomain | The subdomain of the application. | string |
| template | The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. | string |
AppSkuInfo
| Name | Description | Value |
|---|---|---|
| name | The name of the SKU. | 'ST0' 'ST1' 'ST2' (required) |
NetworkRuleSetIpRule
| Name | Description | Value |
|---|---|---|
| filterName | The readable name of the IP rule. | string |
| ipMask | The CIDR block defining the IP range. | string |
NetworkRuleSets
| Name | Description | Value |
|---|---|---|
| applyToDevices | Whether these rules apply for device connectivity to IoT Hub and Device Provisioning service associated with this application. | bool |
| applyToIoTCentral | Whether these rules apply for connectivity via IoT Central web portal and APIs. | bool |
| defaultAction | The default network action to apply. | 'Allow' 'Deny' |
| ipRules | List of IP rules. | NetworkRuleSetIpRule[] |
SystemAssignedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (either system assigned, or none). | 'None' 'SystemAssigned' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform Samples
A basic example of deploying IotCentral Application.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "iotApp" {
type = "Microsoft.IoTCentral/iotApps@2021-11-01-preview"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
displayName = var.resource_name
publicNetworkAccess = "Enabled"
subdomain = "subdomain-2306300333537"
template = "iotc-pnp-preview@1.0.0"
}
sku = {
name = "ST1"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Feedback
Was this page helpful?