你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.Devices provisioningServices 2017-11-15

Bicep 资源定义

可以使用面向以下操作部署 provisioningServices 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Devices/provisioningServices 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Devices/provisioningServices@2017-11-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'S1'
  }
  etag: 'string'
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    iotHubs: [
      {
        allocationWeight: int
        applyAllocationPolicy: bool
        connectionString: 'string'
        location: 'string'
      }
    ]
    provisioningState: 'string'
    state: 'string'
  }
}

属性值

provisioningServices

名称 说明
name 资源名称 字符串 (必需)

字符限制:3-64

有效字符:
字母数字和连字符。

以字母数字结尾。
location 资源位置。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 预配服务的 SKU 信息。 IotDpsSkuInfo (必需)
etag Etag 字段 是必需的。 如果响应正文中提供了它,则还必须根据常规 ETag 约定将其作为标头提供。 string
properties 预配服务的服务特定属性 IotDpsPropertiesDescription (必需)

IotDpsPropertiesDescription

名称 说明
allocationPolicy 此预配服务要使用的分配策略。 “GeoLatency”
“Hashed”
'Static'
authorizationPolicies 预配服务的授权密钥列表。 SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs 与此预配服务关联的 IoT 中心列表。 IotHubDefinitionDescription[]
provisioningState 预配服务的 ARM 预配状态。 string
state 预配服务的当前状态。 'Activating'
'ActivationFailed'
'Active'
'Deleted'
'正在删除'
'DeletionFailed'
“FailingOver”
“FailoverFailed”
'Resuming'
“Suspended”
'Suspending'
“转换”

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

名称 说明
keyName 密钥的名称。 字符串 (必需)
primaryKey 主 SAS 密钥值。 字符串
权限 此密钥具有的权限。 “DeviceConnect”
“EnrollmentRead”
'EnrollmentWrite'
“RegistrationStatusRead”
“RegistrationStatusWrite”
需要“ServiceConfig” ()
secondaryKey 辅助 SAS 密钥值。 字符串
keyName 密钥的名称。 字符串 (必需)
primaryKey 主 SAS 密钥值。 字符串
权限 此密钥具有的权限。 “DeviceConnect”
“EnrollmentRead”
'EnrollmentWrite'
“RegistrationStatusRead”
“RegistrationStatusWrite”
需要“ServiceConfig” ()
secondaryKey 辅助 SAS 密钥值。 字符串

IotHubDefinitionDescription

名称 说明
allocationWeight 应用于给定 IoT 中心的权重。 int
applyAllocationPolicy 用于为给定 IoT 中心应用 allocationPolicy 或不应用的标志。 bool
connectionString IoT 中心的连接字符串。 字符串 (必需)
location IoT 中心的 ARM 区域。 字符串 (必需)

IotDpsSkuInfo

名称 说明
容量 要预配的单位数 int
name SKU 名称。 'S1'

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
创建 IOT 中心和 Ubuntu 边缘模拟器

部署到 Azure
此模板创建 IOT 中心和虚拟机 Ubuntu 边缘模拟器。
创建IoT 中心设备预配服务

部署到 Azure
使用此模板可以创建 IoT 中心和IoT 中心设备预配服务,并将这两个服务链接在一起。

ARM 模板资源定义

可以使用面向以下操作部署 provisioningServices 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Devices/provisioningServices 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2017-11-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "S1"
  },
  "etag": "string",
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string",
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "iotHubs": [
      {
        "allocationWeight": "int",
        "applyAllocationPolicy": "bool",
        "connectionString": "string",
        "location": "string"
      }
    ],
    "provisioningState": "string",
    "state": "string"
  }
}

属性值

provisioningServices

名称 说明 Value
type 资源类型 'Microsoft.Devices/provisioningServices'
apiVersion 资源 API 版本 '2017-11-15'
name 资源名称 字符串 (必需)

字符限制:3-64

有效字符:
字母数字和连字符。

以字母数字结尾。
location 资源位置。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 预配服务的 SKU 信息。 IotDpsSkuInfo (必需)
etag Etag 字段 是必需的。 如果响应正文中提供了它,则还必须根据常规 ETag 约定将其作为标头提供。 string
properties 预配服务的服务特定属性 IotDpsPropertiesDescription (必需)

IotDpsPropertiesDescription

名称 说明
allocationPolicy 此预配服务要使用的分配策略。 “GeoLatency”
“Hashed”
'Static'
authorizationPolicies 预配服务的授权密钥列表。 SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs 与此预配服务关联的 IoT 中心列表。 IotHubDefinitionDescription[]
provisioningState 预配服务的 ARM 预配状态。 string
state 预配服务的当前状态。 'Activating'
'ActivationFailed'
'Active'
'Deleted'
'正在删除'
'DeletionFailed'
“FailingOver”
“FailoverFailed”
'Resuming'
“Suspended”
'Suspending'
“转换”

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

名称 说明
keyName 密钥的名称。 字符串 (必需)
primaryKey 主 SAS 密钥值。 字符串
权限 此密钥具有的权限。 “DeviceConnect”
“EnrollmentRead”
'EnrollmentWrite'
“RegistrationStatusRead”
“RegistrationStatusWrite”
需要“ServiceConfig” ()
secondaryKey 辅助 SAS 密钥值。 字符串
keyName 密钥的名称。 字符串 (必需)
primaryKey 主 SAS 密钥值。 字符串
权限 此密钥具有的权限。 “DeviceConnect”
“EnrollmentRead”
'EnrollmentWrite'
“RegistrationStatusRead”
“RegistrationStatusWrite”
需要“ServiceConfig” ()
secondaryKey 辅助 SAS 密钥值。 字符串

IotHubDefinitionDescription

名称 说明
allocationWeight 应用于给定 IoT 中心的权重。 int
applyAllocationPolicy 用于为给定 IoT 中心应用 allocationPolicy 或不应用的标志。 bool
connectionString IoT 中心的连接字符串。 字符串 (必需)
location IoT 中心的 ARM 区域。 字符串 (必需)

IotDpsSkuInfo

名称 说明
容量 要预配的单位数 int
name SKU 名称。 'S1'

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
创建 IOT 中心和 Ubuntu 边缘模拟器

部署到 Azure
此模板创建 IOT 中心和虚拟机 Ubuntu 边缘模拟器。
创建IoT 中心设备预配服务

部署到 Azure
使用此模板可以创建 IoT 中心和IoT 中心设备预配服务,并将这两个服务链接在一起。

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 provisioningServices 资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Devices/provisioningServices 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2017-11-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      allocationPolicy = "string"
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      iotHubs = [
        {
          allocationWeight = int
          applyAllocationPolicy = bool
          connectionString = "string"
          location = "string"
        }
      ]
      provisioningState = "string"
      state = "string"
    }
    sku = {
      capacity = int
      name = "S1"
    }
    etag = "string"
  })
}

属性值

provisioningServices

名称 说明 Value
type 资源类型 “Microsoft.Devices/provisioningServices@2017-11-15”
name 资源名称 字符串 (必需)

字符限制:3-64

有效字符:
字母数字和连字符。

以字母数字结尾。
location 资源位置。 字符串 (必需)
parent_id 若要部署到资源组,请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
sku 预配服务的 SKU 信息。 IotDpsSkuInfo (必需)
etag Etag 字段 是必需的。 如果响应正文中提供了它,则还必须根据常规 ETag 约定将其作为标头提供。 string
properties 预配服务的服务特定属性 IotDpsPropertiesDescription (必需)

IotDpsPropertiesDescription

名称 说明
allocationPolicy 此预配服务要使用的分配策略。 “GeoLatency”
“Hashed”
“Static”
authorizationPolicies 预配服务的授权密钥列表。 SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs 与此预配服务关联的 IoT 中心列表。 IotHubDefinitionDescription[]
provisioningState 预配服务的 ARM 预配状态。 string
state 预配服务的当前状态。 “激活”
“ActivationFailed”
“Active”
“Deleted”
“正在删除”
“DeletionFailed”
“FailingOver”
“FailoverFailed”
“正在恢复”
“Suspended”
“Suspending”
“转换”

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

名称 说明
keyName 密钥的名称。 字符串 (必需)
primaryKey 主 SAS 密钥值。 字符串
权限 此密钥具有的权限。 “DeviceConnect”
“EnrollmentRead”
“EnrollmentWrite”
“RegistrationStatusRead”
“RegistrationStatusWrite”
“ServiceConfig” (必需)
secondaryKey 辅助 SAS 密钥值。 字符串
keyName 密钥的名称。 字符串 (必需)
primaryKey 主 SAS 密钥值。 字符串
权限 此密钥具有的权限。 “DeviceConnect”
“EnrollmentRead”
“EnrollmentWrite”
“RegistrationStatusRead”
“RegistrationStatusWrite”
“ServiceConfig” (必需)
secondaryKey 辅助 SAS 密钥值。 字符串

IotHubDefinitionDescription

名称 说明
allocationWeight 应用于给定 IoT 中心的权重。 int
applyAllocationPolicy 用于为给定 IoT 中心应用 allocationPolicy 或不应用的标志。 bool
connectionString IoT 中心的连接字符串。 字符串 (必需)
location IoT 中心的 ARM 区域。 字符串 (必需)

IotDpsSkuInfo

名称 说明
容量 要预配的单位数 int
name SKU 名称。 “S1”