Microsoft.IoTCentral iotApps 2018-09-01
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@2018-09-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
}
properties: {
displayName: '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 resource location. | string (required) |
| tags | The resource tags. | Dictionary of tag names and values. See Tags in templates |
| sku | A valid instance SKU. | AppSkuInfo (required) |
| properties | The common properties of an IoT Central application. | AppProperties |
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. | 'F1' 'S1' '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": "2018-09-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string"
},
"properties": {
"displayName": "string",
"subdomain": "string",
"template": "string"
}
}
Property values
iotApps
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.IoTCentral/iotApps' |
| apiVersion | The resource api version | '2018-09-01' |
| 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 resource location. | string (required) |
| tags | The resource tags. | Dictionary of tag names and values. See Tags in templates |
| sku | A valid instance SKU. | AppSkuInfo (required) |
| properties | The common properties of an IoT Central application. | AppProperties |
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. | 'F1' 'S1' '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@2018-09-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
displayName = "string"
subdomain = "string"
template = "string"
}
sku = {
name = "string"
}
})
}
Property values
iotApps
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.IoTCentral/iotApps@2018-09-01" |
| 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 resource location. | string (required) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | The resource tags. | Dictionary of tag names and values. |
| sku | A valid instance SKU. | AppSkuInfo (required) |
| properties | The common properties of an IoT Central application. | AppProperties |
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. | "F1" "S1" "ST0" "ST1" "ST2" (required) |