Microsoft.IoTCentral iotApps

Bicep resource definition

The iotApps resource type can be deployed with operations that target:

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

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)

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

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

ARM template resource definition

The iotApps resource type can be deployed with operations that target:

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

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)

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'

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

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"
  identity = {
    type = "string"
  }
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      displayName = "string"
      networkRuleSets = {
        applyToDevices = bool
        applyToIoTCentral = bool
        defaultAction = "string"
        ipRules = [
          {
            filterName = "string"
            ipMask = "string"
          }
        ]
      }
      publicNetworkAccess = "string"
      subdomain = "string"
      template = "string"
    }
  })
}

Property values

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)

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"

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