你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Devices provisioningServices 2020-03-01
Bicep 资源定义
可以使用目标操作部署 provisioningServices 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Devices/provisioningServices 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Devices/provisioningServices@2020-03-01' = {
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'
}
]
ipFilterRules: [
{
action: 'string'
filterName: 'string'
ipMask: 'string'
target: 'string'
}
]
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
provisioningState: 'string'
publicNetworkAccess: 'string'
state: 'string'
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
属性值
IotDpsPropertiesDescription
| 名字 | 描述 | 价值 |
|---|---|---|
| allocationPolicy | 此预配服务要使用的分配策略。 | “GeoLatency” “Hashed” “Static” |
| authorizationPolicies | 预配服务的授权密钥列表。 | SharedAccessSignatureAuthorizationRuleAccessRightsDescription[] |
| iotHubs | 与此预配服务关联的 IoT 中心列表。 | IotHubDefinitionDescription[] |
| ipFilterRules | IP 筛选器规则。 | IpFilterRule[] |
| privateEndpointConnections | 在此 IotHub 上创建的专用终结点连接 | PrivateEndpointConnection[] |
| provisioningState | 预配服务的 ARM 预配状态。 | 字符串 |
| publicNetworkAccess | 是否允许来自公用网络的请求 | “Disabled” “Enabled” |
| 州 | 预配服务的当前状态。 | “正在激活” '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 （必需） |
IpFilterRule
| 名字 | 描述 | 价值 |
|---|---|---|
| 行动 | 此规则捕获的请求的所需操作。 | “Accept” “拒绝”（必需） |
| filterName | IP 筛选器规则的名称。 | string （必需） |
| ipMask | 一个字符串，其中包含规则的 CIDR 表示法中的 IP 地址范围。 | string （必需） |
| 目标 | 此规则捕获的请求的目标。 | “all” “deviceApi” “serviceApi” |
Microsoft.Devices/provisioningServices
| 名字 | 描述 | 价值 |
|---|---|---|
| etag | Etag 字段 不需要。 如果在响应正文中提供，则还必须根据正常的 ETag 约定将其作为标头提供。 | 字符串 |
| 位置 | 资源位置。 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 预配服务的服务特定属性 | IotDpsPropertiesDescription（必需） |
| sku | 预配服务的 SKU 信息。 | IotDpsSkuInfo （必需） |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
PrivateEndpoint
| 名字 | 描述 | 价值 |
|---|
PrivateEndpointConnection
| 名字 | 描述 | 价值 |
|---|---|---|
| 性能 | 专用终结点连接的属性 | PrivateEndpointConnectionProperties（必需） |
PrivateEndpointConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| privateEndpoint | 专用终结点连接的专用终结点属性 | PrivateEndpoint |
| privateLinkServiceConnectionState | 专用终结点连接的当前状态 | PrivateLinkServiceConnectionState （必需） |
PrivateLinkServiceConnectionState
| 名字 | 描述 | 价值 |
|---|---|---|
| actionsRequired | 专用终结点连接所需的操作 | 字符串 |
| 描述 | 专用终结点连接的当前状态说明 | string （必需） |
| 地位 | 专用终结点连接的状态 | “已批准” “Disconnected” “Pending” “已拒绝”（必需） |
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": "2020-03-01",
"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"
}
],
"ipFilterRules": [
{
"action": "string",
"filterName": "string",
"ipMask": "string",
"target": "string"
}
],
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"provisioningState": "string",
"publicNetworkAccess": "string",
"state": "string"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
属性值
IotDpsPropertiesDescription
| 名字 | 描述 | 价值 |
|---|---|---|
| allocationPolicy | 此预配服务要使用的分配策略。 | “GeoLatency” “Hashed” “Static” |
| authorizationPolicies | 预配服务的授权密钥列表。 | SharedAccessSignatureAuthorizationRuleAccessRightsDescription[] |
| iotHubs | 与此预配服务关联的 IoT 中心列表。 | IotHubDefinitionDescription[] |
| ipFilterRules | IP 筛选器规则。 | IpFilterRule[] |
| privateEndpointConnections | 在此 IotHub 上创建的专用终结点连接 | PrivateEndpointConnection[] |
| provisioningState | 预配服务的 ARM 预配状态。 | 字符串 |
| publicNetworkAccess | 是否允许来自公用网络的请求 | “Disabled” “Enabled” |
| 州 | 预配服务的当前状态。 | “正在激活” '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 （必需） |
IpFilterRule
| 名字 | 描述 | 价值 |
|---|---|---|
| 行动 | 此规则捕获的请求的所需操作。 | “Accept” “拒绝”（必需） |
| filterName | IP 筛选器规则的名称。 | string （必需） |
| ipMask | 一个字符串，其中包含规则的 CIDR 表示法中的 IP 地址范围。 | string （必需） |
| 目标 | 此规则捕获的请求的目标。 | “all” “deviceApi” “serviceApi” |
Microsoft.Devices/provisioningServices
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2020-03-01' |
| etag | Etag 字段 不需要。 如果在响应正文中提供，则还必须根据正常的 ETag 约定将其作为标头提供。 | 字符串 |
| 位置 | 资源位置。 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 预配服务的服务特定属性 | IotDpsPropertiesDescription（必需） |
| sku | 预配服务的 SKU 信息。 | IotDpsSkuInfo （必需） |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
| 类型 | 资源类型 | “Microsoft.Devices/provisioningServices” |
PrivateEndpoint
| 名字 | 描述 | 价值 |
|---|
PrivateEndpointConnection
| 名字 | 描述 | 价值 |
|---|---|---|
| 性能 | 专用终结点连接的属性 | PrivateEndpointConnectionProperties（必需） |
PrivateEndpointConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| privateEndpoint | 专用终结点连接的专用终结点属性 | PrivateEndpoint |
| privateLinkServiceConnectionState | 专用终结点连接的当前状态 | PrivateLinkServiceConnectionState （必需） |
PrivateLinkServiceConnectionState
| 名字 | 描述 | 价值 |
|---|---|---|
| actionsRequired | 专用终结点连接所需的操作 | 字符串 |
| 描述 | 专用终结点连接的当前状态说明 | string （必需） |
| 地位 | 专用终结点连接的状态 | “已批准” “Disconnected” “Pending” “已拒绝”（必需） |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
SharedAccessSignatureAuthorizationRuleAccessRightsDescription
| 名字 | 描述 | 价值 |
|---|---|---|
| keyName | 密钥的名称。 | string （必需） |
| primaryKey | 主 SAS 密钥值。 | 字符串 |
| 权利 | 此密钥具有的权限。 | “DeviceConnect” “EnrollmentRead” “EnrollmentWrite” “RegistrationStatusRead” “RegistrationStatusWrite” “ServiceConfig”（必需） |
| secondaryKey | 辅助 SAS 密钥值。 | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
创建 IOT 中心和 Ubuntu 边缘模拟器
|
此模板创建 IOT 中心和虚拟机 Ubuntu 边缘模拟器。 |
|
创建 IoT 中心设备预配服务
|
使用此模板可以创建 IoT 中心和 IoT 中心设备预配服务，并将这两个服务链接在一起。 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署 provisioningServices 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Devices/provisioningServices 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/provisioningServices@2020-03-01"
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"
}
]
ipFilterRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
target = "string"
}
]
privateEndpointConnections = [
{
properties = {
privateEndpoint = {
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
provisioningState = "string"
publicNetworkAccess = "string"
state = "string"
}
})
}
属性值
IotDpsPropertiesDescription
| 名字 | 描述 | 价值 |
|---|---|---|
| allocationPolicy | 此预配服务要使用的分配策略。 | “GeoLatency” “Hashed” “Static” |
| authorizationPolicies | 预配服务的授权密钥列表。 | SharedAccessSignatureAuthorizationRuleAccessRightsDescription[] |
| iotHubs | 与此预配服务关联的 IoT 中心列表。 | IotHubDefinitionDescription[] |
| ipFilterRules | IP 筛选器规则。 | IpFilterRule[] |
| privateEndpointConnections | 在此 IotHub 上创建的专用终结点连接 | PrivateEndpointConnection[] |
| provisioningState | 预配服务的 ARM 预配状态。 | 字符串 |
| publicNetworkAccess | 是否允许来自公用网络的请求 | “Disabled” “Enabled” |
| 州 | 预配服务的当前状态。 | “正在激活” '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 （必需） |
IpFilterRule
| 名字 | 描述 | 价值 |
|---|---|---|
| 行动 | 此规则捕获的请求的所需操作。 | “Accept” “拒绝”（必需） |
| filterName | IP 筛选器规则的名称。 | string （必需） |
| ipMask | 一个字符串，其中包含规则的 CIDR 表示法中的 IP 地址范围。 | string （必需） |
| 目标 | 此规则捕获的请求的目标。 | “all” “deviceApi” “serviceApi” |
Microsoft.Devices/provisioningServices
| 名字 | 描述 | 价值 |
|---|---|---|
| etag | Etag 字段 不需要。 如果在响应正文中提供，则还必须根据正常的 ETag 约定将其作为标头提供。 | 字符串 |
| 位置 | 资源位置。 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 预配服务的服务特定属性 | IotDpsPropertiesDescription（必需） |
| sku | 预配服务的 SKU 信息。 | IotDpsSkuInfo （必需） |
| 标签 | 资源标记 | 标记名称和值的字典。 |
| 类型 | 资源类型 | “Microsoft.Devices/provisioningServices@2020-03-01” |
PrivateEndpoint
| 名字 | 描述 | 价值 |
|---|
PrivateEndpointConnection
| 名字 | 描述 | 价值 |
|---|---|---|
| 性能 | 专用终结点连接的属性 | PrivateEndpointConnectionProperties（必需） |
PrivateEndpointConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| privateEndpoint | 专用终结点连接的专用终结点属性 | PrivateEndpoint |
| privateLinkServiceConnectionState | 专用终结点连接的当前状态 | PrivateLinkServiceConnectionState （必需） |
PrivateLinkServiceConnectionState
| 名字 | 描述 | 价值 |
|---|---|---|
| actionsRequired | 专用终结点连接所需的操作 | 字符串 |
| 描述 | 专用终结点连接的当前状态说明 | string （必需） |
| 地位 | 专用终结点连接的状态 | “已批准” “Disconnected” “Pending” “已拒绝”（必需） |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
SharedAccessSignatureAuthorizationRuleAccessRightsDescription
| 名字 | 描述 | 价值 |
|---|---|---|
| keyName | 密钥的名称。 | string （必需） |
| primaryKey | 主 SAS 密钥值。 | 字符串 |
| 权利 | 此密钥具有的权限。 | “DeviceConnect” “EnrollmentRead” “EnrollmentWrite” “RegistrationStatusRead” “RegistrationStatusWrite” “ServiceConfig”（必需） |
| secondaryKey | 辅助 SAS 密钥值。 | 字符串 |