你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Bicep 资源定义
可以使用目标操作部署 iotApps 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.IoTCentral/iotApps 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.IoTCentral/iotApps@2021-11-01-preview' = {
scope: resourceSymbolicName or scope
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'
}
}
属性值
Microsoft.IoTCentral/iotApps
| 名字 | 描述 | 价值 |
|---|---|---|
| 标识 | IoT Central 应用程序的托管标识。 | SystemAssignedServiceIdentity |
| 位置 | 资源所在的地理位置 | string (必需) |
| 名字 | 资源名称 | string (必需) |
| 性能 | IoT Central 应用程序的常见属性。 | App属性 |
| 作用域 | 在与部署范围不同的范围内创建资源时使用。 | 将此属性设置为资源的符号名称以应用 扩展资源。 |
| SKU | 有效的实例 SKU。 | AppSkuInfo (必需) |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
App属性
| 名字 | 描述 | 价值 |
|---|---|---|
| displayName (显示名称) | 应用程序的显示名称。 | 字符串 |
| networkRuleSets 网络规则集 | 此 IoT Central 应用程序的网络规则集属性。 | NetworkRuleSets 网络规则集 |
| publicNetworkAccess | 是否允许来自公共网络的请求。 | “Disabled” “Enabled” |
| 子域 | 应用程序的子域。 | 字符串 |
| 模板 | 应用程序模板的 ID,它是一个蓝图,用于定义应用程序的特征和行为。 自选;如果未指定,则默认为空白蓝图,并允许从头开始定义应用程序。 | 字符串 |
AppSkuInfo
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | SKU 的名称。 | “ST0” “ST1” “ST2”(必需) |
NetworkRuleSetIpRule
| 名字 | 描述 | 价值 |
|---|---|---|
| filterName (过滤器名称) | IP 规则的可读名称。 | 字符串 |
| ipMask 的 | 定义 IP 范围的 CIDR 块。 | 字符串 |
NetworkRuleSets 网络规则集
| 名字 | 描述 | 价值 |
|---|---|---|
| applyToDevices | 这些规则是否适用于与 IoT 中心和与此应用程序关联的设备预配服务的设备连接。 | 布尔 |
| applyToIoTCentral | 这些规则是否适用于通过 IoT Central Web 门户和 API 建立连接。 | 布尔 |
| defaultAction | 要应用的默认网络操作。 | “允许” “拒绝” |
| ip规则 | IP 规则列表。 | NetworkRuleSetIpRule[] |
SystemAssignedServiceIdentity
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 托管服务标识的类型(系统分配或无)。 | “None” “SystemAssigned”(必需) |
TrackedResourceTags
| 名字 | 描述 | 价值 |
|---|
ARM 模板资源定义
可以使用目标操作部署 iotApps 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.IoTCentral/iotApps 资源,请将以下 JSON 添加到模板。
{
"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"
}
}
属性值
Microsoft.IoTCentral/iotApps
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | “2021-11-01-预览” |
| 标识 | IoT Central 应用程序的托管标识。 | SystemAssignedServiceIdentity |
| 位置 | 资源所在的地理位置 | string (必需) |
| 名字 | 资源名称 | string (必需) |
| 性能 | IoT Central 应用程序的常见属性。 | App属性 |
| SKU | 有效的实例 SKU。 | AppSkuInfo (必需) |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
| 类型 | 资源类型 | “Microsoft.IoTCentral/iotApps” |
App属性
| 名字 | 描述 | 价值 |
|---|---|---|
| displayName (显示名称) | 应用程序的显示名称。 | 字符串 |
| networkRuleSets 网络规则集 | 此 IoT Central 应用程序的网络规则集属性。 | NetworkRuleSets 网络规则集 |
| publicNetworkAccess | 是否允许来自公共网络的请求。 | “Disabled” “Enabled” |
| 子域 | 应用程序的子域。 | 字符串 |
| 模板 | 应用程序模板的 ID,它是一个蓝图,用于定义应用程序的特征和行为。 自选;如果未指定,则默认为空白蓝图,并允许从头开始定义应用程序。 | 字符串 |
AppSkuInfo
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | SKU 的名称。 | “ST0” “ST1” “ST2”(必需) |
NetworkRuleSetIpRule
| 名字 | 描述 | 价值 |
|---|---|---|
| filterName (过滤器名称) | IP 规则的可读名称。 | 字符串 |
| ipMask 的 | 定义 IP 范围的 CIDR 块。 | 字符串 |
NetworkRuleSets 网络规则集
| 名字 | 描述 | 价值 |
|---|---|---|
| applyToDevices | 这些规则是否适用于与 IoT 中心和与此应用程序关联的设备预配服务的设备连接。 | 布尔 |
| applyToIoTCentral | 这些规则是否适用于通过 IoT Central Web 门户和 API 建立连接。 | 布尔 |
| defaultAction | 要应用的默认网络操作。 | “允许” “拒绝” |
| ip规则 | IP 规则列表。 | NetworkRuleSetIpRule[] |
SystemAssignedServiceIdentity
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 托管服务标识的类型(系统分配或无)。 | “None” “SystemAssigned”(必需) |
TrackedResourceTags
| 名字 | 描述 | 价值 |
|---|
用法示例
Terraform (AzAPI 提供程序)资源定义
可以使用目标操作部署 iotApps 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.IoTCentral/iotApps 资源,请将以下 Terraform 添加到模板。
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"
}
}
}
属性值
Microsoft.IoTCentral/iotApps
| 名字 | 描述 | 价值 |
|---|---|---|
| 标识 | IoT Central 应用程序的托管标识。 | SystemAssignedServiceIdentity |
| 位置 | 资源所在的地理位置 | string (必需) |
| 名字 | 资源名称 | string (必需) |
| parent_id | 要向其应用此扩展资源的资源的 ID。 | string (必需) |
| 性能 | IoT Central 应用程序的常见属性。 | App属性 |
| SKU | 有效的实例 SKU。 | AppSkuInfo (必需) |
| 标签 | 资源标记 | 标记名称和值的字典。 |
| 类型 | 资源类型 | “Microsoft.IoTCentral/iotApps@2021-11-01-preview” |
App属性
| 名字 | 描述 | 价值 |
|---|---|---|
| displayName (显示名称) | 应用程序的显示名称。 | 字符串 |
| networkRuleSets 网络规则集 | 此 IoT Central 应用程序的网络规则集属性。 | NetworkRuleSets 网络规则集 |
| publicNetworkAccess | 是否允许来自公共网络的请求。 | “Disabled” “Enabled” |
| 子域 | 应用程序的子域。 | 字符串 |
| 模板 | 应用程序模板的 ID,它是一个蓝图,用于定义应用程序的特征和行为。 自选;如果未指定,则默认为空白蓝图,并允许从头开始定义应用程序。 | 字符串 |
AppSkuInfo
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | SKU 的名称。 | “ST0” “ST1” “ST2”(必需) |
NetworkRuleSetIpRule
| 名字 | 描述 | 价值 |
|---|---|---|
| filterName (过滤器名称) | IP 规则的可读名称。 | 字符串 |
| ipMask 的 | 定义 IP 范围的 CIDR 块。 | 字符串 |
NetworkRuleSets 网络规则集
| 名字 | 描述 | 价值 |
|---|---|---|
| applyToDevices | 这些规则是否适用于与 IoT 中心和与此应用程序关联的设备预配服务的设备连接。 | 布尔 |
| applyToIoTCentral | 这些规则是否适用于通过 IoT Central Web 门户和 API 建立连接。 | 布尔 |
| defaultAction | 要应用的默认网络操作。 | “允许” “拒绝” |
| ip规则 | IP 规则列表。 | NetworkRuleSetIpRule[] |
SystemAssignedServiceIdentity
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 托管服务标识的类型(系统分配或无)。 | “None” “SystemAssigned”(必需) |
TrackedResourceTags
| 名字 | 描述 | 价值 |
|---|
用法示例
Terraform 示例
部署 IotCentral 应用程序的基本示例。
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 = ["*"]
}