通过

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

Microsoft.Devices provisioningServices 2018-01-22

  • 项目

Bicep 资源定义

可以使用目标操作部署 provisioningServices 资源类型：

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

资源格式

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

resource symbolicname 'Microsoft.Devices/provisioningServices@2018-01-22' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        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: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

IotDpsPropertiesDescription

名字 描述 价值
allocationPolicy 此预配服务要使用的分配策略。 “GeoLatency”
“Hashed”
“Static”
authorizationPolicies 预配服务的授权密钥列表。 SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
iotHubs 与此预配服务关联的 IoT 中心列表。 IotHubDefinitionDescription[]
provisioningState 预配服务的 ARM 预配状态。 字符串
州 预配服务的当前状态。 “正在激活”
'ActivationFailed'
“Active”
“Deleted”
“删除”
“DeletionFailed”
“FailingOver”
“FailoverFailed”
“恢复”
“Suspended”
“挂起”
“转换”

IotDpsSkuInfo

名字 描述 价值
能力 要预配的单位数 int
名字 Sku 名称。 “S1”

IotHubDefinitionDescription

名字 描述 价值
allocationWeight 要申请给定 iot h 的权重。 int
applyAllocationPolicy 用于应用 allocationPolicy 或不应用于给定 iot 中心的标志。 bool
connectionString 连接字符串对 IoT 中心进行管理。 string （必需）
位置 IoT 中心的 ARM 区域。 string （必需）

Microsoft.Devices/provisioningServices

名字 描述 价值
etag Etag 字段 不需要。 如果在响应正文中提供，则还必须根据正常的 ETag 约定将其作为标头提供。 字符串
位置 资源位置。 string （必需）
名字 资源名称 string （必需）
性能 预配服务的服务特定属性 IotDpsPropertiesDescription（必需）
sku 预配服务的 SKU 信息。 IotDpsSkuInfo （必需）
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

ResourceTags

名字 描述 价值

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

名字 描述 价值
keyName 密钥的名称。 string （必需）
primaryKey 主 SAS 密钥值。 字符串
权利 此密钥具有的权限。 “DeviceConnect”
“EnrollmentRead”
“EnrollmentWrite”
“RegistrationStatusRead”
“RegistrationStatusWrite”
“ServiceConfig”（必需）
secondaryKey 辅助 SAS 密钥值。 字符串

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
创建 IoT 中心设备预配服务 使用此模板可以创建 IoT 中心和 IoT 中心设备预配服务，并将这两个服务链接在一起。

ARM 模板资源定义

可以使用目标操作部署 provisioningServices 资源类型：

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

资源格式

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

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2018-01-22",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "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": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

IotDpsPropertiesDescription

名字 描述 价值
allocationPolicy 此预配服务要使用的分配策略。 “GeoLatency”
“Hashed”
“Static”
authorizationPolicies 预配服务的授权密钥列表。 SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
iotHubs 与此预配服务关联的 IoT 中心列表。 IotHubDefinitionDescription[]
provisioningState 预配服务的 ARM 预配状态。 字符串
州 预配服务的当前状态。 “正在激活”
'ActivationFailed'
“Active”
“Deleted”
“删除”
“DeletionFailed”
“FailingOver”
“FailoverFailed”
“恢复”
“Suspended”
“挂起”
“转换”

IotDpsSkuInfo

名字 描述 价值
能力 要预配的单位数 int
名字 Sku 名称。 “S1”

IotHubDefinitionDescription

名字 描述 价值
allocationWeight 要申请给定 iot h 的权重。 int
applyAllocationPolicy 用于应用 allocationPolicy 或不应用于给定 iot 中心的标志。 bool
connectionString 连接字符串对 IoT 中心进行管理。 string （必需）
位置 IoT 中心的 ARM 区域。 string （必需）

Microsoft.Devices/provisioningServices

名字 描述 价值
apiVersion API 版本 '2018-01-22'
etag Etag 字段 不需要。 如果在响应正文中提供，则还必须根据正常的 ETag 约定将其作为标头提供。 字符串
位置 资源位置。 string （必需）
名字 资源名称 string （必需）
性能 预配服务的服务特定属性 IotDpsPropertiesDescription（必需）
sku 预配服务的 SKU 信息。 IotDpsSkuInfo （必需）
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Devices/provisioningServices”

ResourceTags

名字 描述 价值

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

名字 描述 价值
keyName 密钥的名称。 string （必需）
primaryKey 主 SAS 密钥值。 字符串
权利 此密钥具有的权限。 “DeviceConnect”
“EnrollmentRead”
“EnrollmentWrite”
“RegistrationStatusRead”
“RegistrationStatusWrite”
“ServiceConfig”（必需）
secondaryKey 辅助 SAS 密钥值。 字符串

快速入门模板

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

模板 描述
创建 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@2018-01-22"
  name = "string"
  etag = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      allocationPolicy = "string"
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      iotHubs = [
        {
          allocationWeight = int
          applyAllocationPolicy = bool
          connectionString = "string"
          location = "string"
        }
      ]
      provisioningState = "string"
      state = "string"
    }
  })
}

属性值

IotDpsPropertiesDescription

名字 描述 价值
allocationPolicy 此预配服务要使用的分配策略。 “GeoLatency”
“Hashed”
“Static”
authorizationPolicies 预配服务的授权密钥列表。 SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
iotHubs 与此预配服务关联的 IoT 中心列表。 IotHubDefinitionDescription[]
provisioningState 预配服务的 ARM 预配状态。 字符串
州 预配服务的当前状态。 “正在激活”
'ActivationFailed'
“Active”
“Deleted”
“删除”
“DeletionFailed”
“FailingOver”
“FailoverFailed”
“恢复”
“Suspended”
“挂起”
“转换”

IotDpsSkuInfo

名字 描述 价值
能力 要预配的单位数 int
名字 Sku 名称。 “S1”

IotHubDefinitionDescription

名字 描述 价值
allocationWeight 要申请给定 iot h 的权重。 int
applyAllocationPolicy 用于应用 allocationPolicy 或不应用于给定 iot 中心的标志。 bool
connectionString 连接字符串对 IoT 中心进行管理。 string （必需）
位置 IoT 中心的 ARM 区域。 string （必需）

Microsoft.Devices/provisioningServices

名字 描述 价值
etag Etag 字段 不需要。 如果在响应正文中提供，则还必须根据正常的 ETag 约定将其作为标头提供。 字符串
位置 资源位置。 string （必需）
名字 资源名称 string （必需）
性能 预配服务的服务特定属性 IotDpsPropertiesDescription（必需）
sku 预配服务的 SKU 信息。 IotDpsSkuInfo （必需）
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Devices/provisioningServices@2018-01-22”

ResourceTags

名字 描述 价值

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

名字 描述 价值
keyName 密钥的名称。 string （必需）
primaryKey 主 SAS 密钥值。 字符串
权利 此密钥具有的权限。 “DeviceConnect”
“EnrollmentRead”
“EnrollmentWrite”
“RegistrationStatusRead”
“RegistrationStatusWrite”
“ServiceConfig”（必需）
secondaryKey 辅助 SAS 密钥值。 字符串