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

Iot Dps Resource - Create Or Update

服务:: IoT Hub Device Provisioning Service

API 版本:: 2022-12-12

创建或更新预配服务的元数据。修改属性的通常模式是检索预配服务元数据和安全元数据，然后将其与新正文中修改的值合并以更新预配服务。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}?api-version=2022-12-12

URI 参数

名称	在	必需	类型	说明
provisioningServiceName	path	True	string	要创建或更新的预配服务的名称。
resourceGroupName	path	True	string	资源组标识符。
subscriptionId	path	True	string	订阅标识符。
api-version	query	True	string	API 的版本。

请求正文

名称	必需	类型	说明
location	True	string	资源位置。
properties	True	IotDpsPropertiesDescription	预配服务的服务特定属性
sku	True	IotDpsSkuInfo	预配服务的 SKU 信息。
etag		string	Etag 字段不需要。如果在响应正文中提供，则还必须根据正常的 ETag 约定将其作为标头提供。
resourcegroup		string	资源的资源组。
subscriptionid		string	资源的订阅 ID。
tags		object	资源标记。

响应

名称	类型	说明
200 OK	ProvisioningServiceDescription	正文包含预配服务的所有非安全属性。与安全相关的属性设置为 null。
201 Created	ProvisioningServiceDescription	这是一项长时间运行的操作。如果验证完成，该作将返回 201。响应包括包含状态 URL 的 Azure-AsyncOperation 标头。客户端应轮询作状态的状态 URL。如果成功，该作将返回 HTTP 状态代码 201（确定）。
Other Status Codes	ErrorDetails	默认错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

DPSCreate

示例请求

HTTP

PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2022-12-12

{
  "location": "East US",
  "properties": {
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  },
  "tags": {}
}

示例响应

状态代码:: 200

{
  "etag": "AAAAAAAADGk=",
  "name": "myFirstProvisioningService",
  "location": "eastus",
  "properties": {
    "state": "Active",
    "allocationPolicy": "Hashed",
    "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
    "deviceProvisioningHostName": "global.azure-devices-provisioning.net",
    "idScope": "0ne00000012",
    "authorizationPolicies": [],
    "enableDataResidency": false,
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
  "tags": {},
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

状态代码:: 201

{
  "etag": "AAAAAAAADGk=",
  "name": "myFirstProvisioningService",
  "location": "eastus",
  "properties": {
    "state": "Active",
    "allocationPolicy": "Hashed",
    "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
    "deviceProvisioningHostName": "global.azure-devices-provisioning.net",
    "idScope": "0ne00000012",
    "authorizationPolicies": [],
    "enableDataResidency": false,
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
  "tags": {},
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

定义

名称	说明
AccessRightsDescription	此密钥具有的权限。
AllocationPolicy	此预配服务要使用的分配策略。
createdByType	创建资源的标识的类型。
ErrorDetails	错误详细信息。
IotDpsPropertiesDescription	预配服务的服务特定属性，包括密钥、链接的 iot 中心、当前状态和系统生成的属性，例如主机名和 idScope
IotDpsSku	Sku 名称。
IotDpsSkuInfo	可能的预配服务 SKU 列表。
IotHubDefinitionDescription	IoT 中心的说明。
IpFilterActionType	此规则捕获的请求的所需作。
IpFilterRule	预配服务的 IP 筛选器规则。
IpFilterTargetType	此规则捕获的请求的目标。
PrivateEndpoint	专用终结点连接的专用终结点属性
PrivateEndpointConnection	预配服务的专用终结点连接
PrivateEndpointConnectionProperties	专用终结点连接的属性
PrivateLinkServiceConnectionState	专用终结点连接的当前状态
PrivateLinkServiceConnectionStatus	专用终结点连接的状态
ProvisioningServiceDescription	预配服务的说明。
PublicNetworkAccess	是否允许来自公用网络的请求
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	共享访问密钥的说明。
state	预配服务的当前状态。
systemData	与创建和上次修改资源相关的元数据。

AccessRightsDescription

枚举

此密钥具有的权限。

值	说明
ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

AllocationPolicy

枚举

此预配服务要使用的分配策略。

值	说明
Hashed
GeoLatency
Static

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorDetails

Object

错误详细信息。

名称	类型	说明
code	integer (int32)	错误代码。
details	string	错误详细信息。
httpStatusCode	string	HTTP 状态代码。
message	string	错误消息。

IotDpsPropertiesDescription

Object

预配服务的服务特定属性，包括密钥、链接的 iot 中心、当前状态和系统生成的属性，例如主机名和 idScope

名称	类型	说明
allocationPolicy	AllocationPolicy	此预配服务要使用的分配策略。
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	预配服务的授权密钥列表。
deviceProvisioningHostName	string	此预配服务的设备终结点。
enableDataResidency	boolean	可选。指示 DPS 实例是否启用了数据驻留，从而删除跨异地对灾难恢复。
idScope	string	此预配服务的唯一标识符。
iotHubs	IotHubDefinitionDescription[]	与此预配服务关联的 IoT 中心列表。
ipFilterRules	IpFilterRule[]	IP 筛选器规则。
portalOperationsHostName	string	用于为此预配服务启用 CORS 的门户终结点。
privateEndpointConnections	PrivateEndpointConnection[]	在此 IotHub 上创建的专用终结点连接
provisioningState	string	预配服务的 ARM 预配状态。
publicNetworkAccess	PublicNetworkAccess	是否允许来自公用网络的请求
serviceOperationsHostName	string	用于预配服务的服务终结点。
state	state	预配服务的当前状态。

IotDpsSku

枚举

Sku 名称。

值	说明
S1

IotDpsSkuInfo

Object

可能的预配服务 SKU 列表。

名称	类型	说明
capacity	integer (int64)	要预配的单位数
name	IotDpsSku	Sku 名称。
tier	string	预配服务的定价层名称。

IotHubDefinitionDescription

Object

IoT 中心的说明。

名称	类型	说明
allocationWeight	integer (int32)	要申请给定 iot h 的权重。
applyAllocationPolicy	boolean	用于应用 allocationPolicy 或不应用于给定 iot 中心的标志。
connectionString	string	IoT 中心的连接字符串。
location	string	IoT 中心的 ARM 区域。
name	string	IoT 中心的主机名。

IpFilterActionType

枚举

此规则捕获的请求的所需作。

值	说明
Accept
Reject

IpFilterRule

Object

预配服务的 IP 筛选器规则。

名称	类型	说明
action	IpFilterActionType	此规则捕获的请求的所需作。
filterName	string	IP 筛选器规则的名称。
ipMask	string	一个字符串，其中包含规则的 CIDR 表示法中的 IP 地址范围。
target	IpFilterTargetType	此规则捕获的请求的目标。

IpFilterTargetType

枚举

此规则捕获的请求的目标。

值	说明
all
serviceApi
deviceApi

PrivateEndpoint

Object

专用终结点连接的专用终结点属性

名称	类型	说明
id	string	资源标识符。

PrivateEndpointConnection

Object

预配服务的专用终结点连接

名称	类型	说明
id	string	资源标识符。
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	资源名称。
properties	PrivateEndpointConnectionProperties	专用终结点连接的属性
systemData	systemData	与创建和上次修改资源相关的元数据。
type	string	资源类型。

PrivateEndpointConnectionProperties

Object

专用终结点连接的属性

名称	类型	说明
privateEndpoint	PrivateEndpoint	专用终结点连接的专用终结点属性
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	专用终结点连接的当前状态

PrivateLinkServiceConnectionState

Object

专用终结点连接的当前状态

名称	类型	说明
actionsRequired	string	专用终结点连接所需的作
description	string	专用终结点连接的当前状态说明
status	PrivateLinkServiceConnectionStatus	专用终结点连接的状态

PrivateLinkServiceConnectionStatus

枚举

专用终结点连接的状态

值	说明
Pending
Approved
Rejected
Disconnected

ProvisioningServiceDescription

Object

预配服务的说明。

名称	类型	说明
etag	string	Etag 字段不需要。如果在响应正文中提供，则还必须根据正常的 ETag 约定将其作为标头提供。
id	string	资源标识符。
location	string	资源位置。
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	资源名称。
properties	IotDpsPropertiesDescription	预配服务的服务特定属性
resourcegroup	string	资源的资源组。
sku	IotDpsSkuInfo	预配服务的 SKU 信息。
subscriptionid	string	资源的订阅 ID。
systemData	systemData	与创建和上次修改资源相关的元数据。
tags	object	资源标记。
type	string	资源类型。

PublicNetworkAccess

枚举

是否允许来自公用网络的请求

值	说明
Enabled
Disabled

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Object

共享访问密钥的说明。

名称	类型	说明
keyName	string	密钥的名称。
primaryKey	string	主 SAS 密钥值。
rights	AccessRightsDescription	此密钥具有的权限。
secondaryKey	string	辅助 SAS 密钥值。

state

枚举

预配服务的当前状态。

值	说明
Activating
Active
Deleting
Deleted
ActivationFailed
DeletionFailed
Transitioning
Suspending
Suspended
Resuming
FailingOver
FailoverFailed

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

通过

Iot Dps Resource - Create Or Update

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

DPSCreate

示例请求

示例响应

定义

AccessRightsDescription

AllocationPolicy

createdByType

ErrorDetails

IotDpsPropertiesDescription

IotDpsSku

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterActionType

IpFilterRule

IpFilterTargetType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningServiceDescription

PublicNetworkAccess

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

state

systemData