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' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
}
identity: {
type: 'string'
}
properties: {
displayName: 'string'
networkRuleSets: {
applyToDevices: bool
applyToIoTCentral: bool
defaultAction: 'string'
ipRules: [
{
filterName: 'string'
ipMask: 'string'
}
]
}
publicNetworkAccess: 'string'
subdomain: 'string'
template: 'string'
}
}
Property values
iotApps
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: 2-63 Valid characters: Lowercase letters, numbers and hyphens. Start with lowercase letter or number. Resource name must be unique across Azure. |
| location | The geo-location where the resource lives | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| sku | A valid instance SKU. | AppSkuInfo (required) |
| identity | The managed identities for the IoT Central application. | SystemAssignedServiceIdentity |
| properties | The common properties of an IoT Central application. | AppProperties |
SystemAssignedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (either system assigned, or none). | 'None' 'SystemAssigned' (required) |
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 |
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[] |
NetworkRuleSetIpRule
| Name | Description | Value |
|---|---|---|
| filterName | The readable name of the IP rule. | string |
| ipMask | The CIDR block defining the IP range. | string |
AppSkuInfo
| Name | Description | Value |
|---|---|---|
| name | The name of the SKU. | 'ST0' 'ST1' 'ST2' (required) |
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",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string"
},
"identity": {
"type": "string"
},
"properties": {
"displayName": "string",
"networkRuleSets": {
"applyToDevices": "bool",
"applyToIoTCentral": "bool",
"defaultAction": "string",
"ipRules": [
{
"filterName": "string",
"ipMask": "string"
}
]
},
"publicNetworkAccess": "string",
"subdomain": "string",
"template": "string"
}
}
Property values
iotApps
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.IoTCentral/iotApps' |
| apiVersion | The resource api version | '2021-11-01-preview' |
| name | The resource name | string (required) Character limit: 2-63 Valid characters: Lowercase letters, numbers and hyphens. Start with lowercase letter or number. Resource name must be unique across Azure. |
| location | The geo-location where the resource lives | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| sku | A valid instance SKU. | AppSkuInfo (required) |
| identity | The managed identities for the IoT Central application. | SystemAssignedServiceIdentity |
| properties | The common properties of an IoT Central application. | AppProperties |
SystemAssignedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (either system assigned, or none). | 'None' 'SystemAssigned' (required) |
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 |
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[] |
NetworkRuleSetIpRule
| Name | Description | Value |
|---|---|---|
| filterName | The readable name of the IP rule. | string |
| ipMask | The CIDR block defining the IP range. | string |
AppSkuInfo
| Name | Description | Value |
|---|---|---|
| name | The name of the SKU. | 'ST0' 'ST1' 'ST2' (required) |
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"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "SystemAssigned"
}
body = jsonencode({
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
iotApps
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.IoTCentral/iotApps@2021-11-01-preview" |
| name | The resource name | string (required) Character limit: 2-63 Valid characters: Lowercase letters, numbers and hyphens. Start with lowercase letter or number. Resource name must be unique across Azure. |
| location | The geo-location where the resource lives | string (required) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. |
| sku | A valid instance SKU. | AppSkuInfo (required) |
| identity | The managed identities for the IoT Central application. | SystemAssignedServiceIdentity |
| properties | The common properties of an IoT Central application. | AppProperties |
SystemAssignedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (either system assigned, or none). | "SystemAssigned" (required) |
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 |
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[] |
NetworkRuleSetIpRule
| Name | Description | Value |
|---|---|---|
| filterName | The readable name of the IP rule. | string |
| ipMask | The CIDR block defining the IP range. | string |
AppSkuInfo
| Name | Description | Value |
|---|---|---|
| name | The name of the SKU. | "ST0" "ST1" "ST2" (required) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for