你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.Devices provisioningServices 2021-10-15
Bicep 资源定义
provisioningServices 资源类型可以使用面向以下对象的操作进行部署:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Devices/provisioningServices 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Devices/provisioningServices@2021-10-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'
}
]
enableDataResidency: bool
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'
}
}
属性值
provisioningServices
名称 | 说明 | 值 |
---|---|---|
name | 资源名称 | 字符串 (必需) 字符限制:3-64 有效字符: 字母数字和连字符。 以字母数字结尾。 |
location | 资源位置。 | 字符串 (必需) |
标记 | 资源标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
sku | 预配服务的 SKU 信息。 | IotDpsSkuInfo (必需) |
etag | Etag 字段 不 是必需的。 如果在响应正文中提供,则还必须根据常规 ETag 约定将其作为标头提供。 | string |
properties | 预配服务的服务特定属性 | 所需的 IotDpsPropertiesDescription () |
IotDpsPropertiesDescription
名称 | 说明 | 值 |
---|---|---|
allocationPolicy | 此预配服务要使用的分配策略。 | “GeoLatency” “Hashed” “Static” |
authorizationPolicies | 预配服务的授权密钥列表。 | SharedAccessSignatureAuthorizationRuleAccessRightsDe...[] |
enableDataResidency | 可选。 指示 DPS 实例是否已启用Data Residency,从而删除跨异地对灾难恢复。 |
bool |
iotHubs | 与此预配服务关联的 IoT 中心列表。 | IotHubDefinitionDescription[] |
ipFilterRules | IP 筛选器规则。 | IpFilterRule[] |
专用终结点 | 在此 IotHub 上创建的专用终结点连接 | PrivateEndpointConnection[] |
provisioningState | 预配服务的 ARM 预配状态。 | 字符串 |
publicNetworkAccess | 是否允许来自公用网络的请求 | “Disabled” “已启用” |
state | 预配服务的当前状态。 | “激活” “ActivationFailed” “Active” “Deleted” “正在删除” “DeletionFailed” “FailingOver” “FailoverFailed” “恢复” “Suspended” “正在暂停” “转换” |
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 h 的 weight。 | int |
applyAllocationPolicy | 标志,用于为给定的 iot 中心应用 allocationPolicy 或不应用。 | bool |
connectionString | IoT 中心的连接字符串。 | 字符串 (必需) |
location | IoT 中心的 ARM 区域。 | 字符串 (必需) |
IpFilterRule
名称 | 说明 | 值 |
---|---|---|
action | 此规则捕获的请求的所需操作。 | “Accept” “拒绝” (必需) |
filterName | IP 筛选器规则的名称。 | 字符串 (必需) |
ipMask | 包含规则的 CIDR 表示法中的 IP 地址范围的字符串。 | 字符串 (必需) |
目标 | 此规则捕获的请求的目标。 | 'all' “deviceApi” “serviceApi” |
PrivateEndpointConnection
名称 | 说明 | 值 |
---|---|---|
properties | 专用终结点连接的属性 | PrivateEndpointConnectionProperties (必需) |
PrivateEndpointConnectionProperties
名称 | 说明 | 值 |
---|---|---|
privateEndpoint | 专用终结点连接的专用终结点属性 | PrivateEndpoint |
privateLinkServiceConnectionState | 专用终结点连接的当前状态 | PrivateLinkServiceConnectionState (必需) |
PrivateEndpoint
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
PrivateLinkServiceConnectionState
名称 | 说明 | 值 |
---|---|---|
actionsRequired | 专用终结点连接所需的操作 | 字符串 |
description | 专用终结点连接的当前状态的说明 | 字符串 (必需) |
status | 专用终结点连接的状态 | “已批准” “Disconnected” “挂起” “已拒绝” (必需) |
IotDpsSkuInfo
名称 | 说明 | 值 |
---|---|---|
容量 | 要预配的单位数 | int |
name | Sku 名称。 | “S1” |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 说明 |
---|---|
创建 IOT 中心和 Ubuntu 边缘模拟器 |
此模板创建 IOT 中心和虚拟机 Ubuntu 边缘模拟器。 |
创建IoT 中心设备预配服务 |
使用此模板可以创建 IoT 中心和IoT 中心设备预配服务,并将这两个服务链接在一起。 |
ARM 模板资源定义
provisioningServices 资源类型可以使用面向以下对象的操作进行部署:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Devices/provisioningServices 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.Devices/provisioningServices",
"apiVersion": "2021-10-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"
}
],
"enableDataResidency": "bool",
"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"
}
}
属性值
provisioningServices
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.Devices/provisioningServices” |
apiVersion | 资源 API 版本 | '2021-10-15' |
name | 资源名称 | 字符串 (必需) 字符限制:3-64 有效字符: 字母数字和连字符。 以字母数字结尾。 |
location | 资源位置。 | 字符串 (必需) |
标记 | 资源标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
sku | 预配服务的 SKU 信息。 | IotDpsSkuInfo (必需) |
etag | Etag 字段 不 是必需的。 如果在响应正文中提供,则还必须根据常规 ETag 约定将其作为标头提供。 | string |
properties | 预配服务的服务特定属性 | 所需的 IotDpsPropertiesDescription () |
IotDpsPropertiesDescription
名称 | 说明 | 值 |
---|---|---|
allocationPolicy | 此预配服务要使用的分配策略。 | “GeoLatency” “Hashed” “Static” |
authorizationPolicies | 预配服务的授权密钥列表。 | SharedAccessSignatureAuthorizationRuleAccessRightsDe...[] |
enableDataResidency | 可选。 指示 DPS 实例是否已启用Data Residency,从而删除跨异地对灾难恢复。 |
bool |
iotHubs | 与此预配服务关联的 IoT 中心列表。 | IotHubDefinitionDescription[] |
ipFilterRules | IP 筛选器规则。 | IpFilterRule[] |
专用终结点 | 在此 IotHub 上创建的专用终结点连接 | PrivateEndpointConnection[] |
provisioningState | 预配服务的 ARM 预配状态。 | 字符串 |
publicNetworkAccess | 是否允许来自公用网络的请求 | “Disabled” “已启用” |
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 h 的权重。 | int |
applyAllocationPolicy | 用于为给定 iot 中心应用 allocationPolicy 或不应用的标志。 | bool |
connectionString | IoT 中心的连接字符串。 | 字符串 (必需) |
location | IoT 中心的 ARM 区域。 | 字符串 (必需) |
IpFilterRule
名称 | 说明 | 值 |
---|---|---|
action | 此规则捕获的请求的所需操作。 | 'Accept' 需要“拒绝” () |
filterName | IP 筛选器规则的名称。 | 字符串 (必需) |
ipMask | 一个字符串,其中包含规则的 CIDR 表示法中的 IP 地址范围。 | 字符串 (必需) |
目标 | 此规则捕获的请求的目标。 | 'all' 'deviceApi' 'serviceApi' |
PrivateEndpointConnection
名称 | 说明 | 值 |
---|---|---|
properties | 专用终结点连接的属性 | PrivateEndpointConnectionProperties (必需) |
PrivateEndpointConnectionProperties
名称 | 说明 | 值 |
---|---|---|
privateEndpoint | 专用终结点连接的专用终结点属性 | PrivateEndpoint |
privateLinkServiceConnectionState | 专用终结点连接的当前状态 | PrivateLinkServiceConnectionState (必需) |
PrivateEndpoint
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
PrivateLinkServiceConnectionState
名称 | 说明 | 值 |
---|---|---|
actionsRequired | 专用终结点连接所需的操作 | 字符串 |
description | 专用终结点连接的当前状态的说明 | 字符串 (必需) |
status | 专用终结点连接的状态 | “已批准” “Disconnected” “挂起” “已拒绝” (必需) |
IotDpsSkuInfo
名称 | 说明 | 值 |
---|---|---|
容量 | 要预配的单位数 | int |
name | Sku 名称。 | “S1” |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 说明 |
---|---|
创建 IOT 中心和 Ubuntu 边缘模拟器 |
此模板创建 IOT 中心和虚拟机 Ubuntu 边缘模拟器。 |
创建IoT 中心设备预配服务 |
使用此模板可以创建 IoT 中心和IoT 中心设备预配服务,并将这两个服务链接在一起。 |
Terraform (AzAPI 提供程序) 资源定义
provisioningServices 资源类型可以使用面向以下对象的操作进行部署:
- 资源组
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Devices/provisioningServices 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/provisioningServices@2021-10-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"
}
]
enableDataResidency = bool
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 = "S1"
}
etag = "string"
})
}
属性值
provisioningServices
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.Devices/provisioningServices@2021-10-15” |
name | 资源名称 | 字符串 (必需) 字符限制:3-64 有效字符: 字母数字和连字符。 以字母数字结尾。 |
location | 资源位置。 | 字符串 (必需) |
parent_id | 若要部署到资源组,请使用该资源组的 ID。 | 字符串 (必需) |
标记 | 资源标记。 | 标记名称和值的字典。 |
sku | 预配服务的 SKU 信息。 | IotDpsSkuInfo (必需) |
etag | Etag 字段 不 是必需的。 如果在响应正文中提供,则还必须根据常规 ETag 约定将其作为标头提供。 | string |
properties | 预配服务的服务特定属性 | 所需的 IotDpsPropertiesDescription () |
IotDpsPropertiesDescription
名称 | 说明 | 值 |
---|---|---|
allocationPolicy | 此预配服务要使用的分配策略。 | “GeoLatency” “Hashed” “Static” |
authorizationPolicies | 预配服务的授权密钥列表。 | SharedAccessSignatureAuthorizationRuleAccessRightsDe...[] |
enableDataResidency | 可选。 指示 DPS 实例是否已启用Data Residency,从而删除跨异地对灾难恢复。 |
bool |
iotHubs | 与此预配服务关联的 IoT 中心列表。 | IotHubDefinitionDescription[] |
ipFilterRules | IP 筛选器规则。 | IpFilterRule[] |
专用终结点 | 在此 IotHub 上创建的专用终结点连接 | PrivateEndpointConnection[] |
provisioningState | 预配服务的 ARM 预配状态。 | 字符串 |
publicNetworkAccess | 是否允许来自公用网络的请求 | “Disabled” “Enabled” |
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 h 的权重。 | int |
applyAllocationPolicy | 用于为给定 iot 中心应用 allocationPolicy 或不应用的标志。 | bool |
connectionString | IoT 中心的连接字符串。 | 字符串 (必需) |
location | IoT 中心的 ARM 区域。 | 字符串 (必需) |
IpFilterRule
名称 | 说明 | 值 |
---|---|---|
action | 此规则捕获的请求的所需操作。 | "Accept" 需要“拒绝” () |
filterName | IP 筛选器规则的名称。 | 字符串 (必需) |
ipMask | 一个字符串,其中包含规则的 CIDR 表示法中的 IP 地址范围。 | 字符串 (必需) |
目标 | 此规则捕获的请求的目标。 | “all” “deviceApi” “serviceApi” |
PrivateEndpointConnection
名称 | 说明 | 值 |
---|---|---|
properties | 专用终结点连接的属性 | PrivateEndpointConnectionProperties (必需) |
PrivateEndpointConnectionProperties
名称 | 说明 | 值 |
---|---|---|
privateEndpoint | 专用终结点连接的专用终结点属性 | PrivateEndpoint |
privateLinkServiceConnectionState | 专用终结点连接的当前状态 | PrivateLinkServiceConnectionState (必需) |
PrivateEndpoint
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
PrivateLinkServiceConnectionState
名称 | 说明 | 值 |
---|---|---|
actionsRequired | 专用终结点连接所需的操作 | 字符串 |
description | 专用终结点连接的当前状态的说明 | 字符串 (必需) |
status | 专用终结点连接的状态 | “已批准” “已断开连接” “挂起” “已拒绝” (必需) |
IotDpsSkuInfo
名称 | 说明 | 值 |
---|---|---|
容量 | 要预配的单位数 | int |
name | Sku 名称。 | “S1” |