Share via

Microsoft.IoTCentral iotApps 2021-06-01

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-06-01' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    displayName: '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 resource location. 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
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)

ResourceTags

Name Description Value

SystemAssignedServiceIdentity

Name Description Value
type Type of managed service identity (either system assigned, or none). 'None'
'SystemAssigned' (required)

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-06-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "displayName": "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-06-01'
identity The managed identities for the IoT Central application. SystemAssignedServiceIdentity
location The resource location. 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
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)

ResourceTags

Name Description Value

SystemAssignedServiceIdentity

Name Description Value
type Type of managed service identity (either system assigned, or none). 'None'
'SystemAssigned' (required)

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-06-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      displayName = "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 resource location. 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-06-01"

AppProperties

Name Description Value
displayName The display name of the application. string
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)

ResourceTags

Name Description Value

SystemAssignedServiceIdentity

Name Description Value
type Type of managed service identity (either system assigned, or none). 'None'
'SystemAssigned' (required)