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

Iot Dps Resource - Create Or Update

参考

Service:: IoT Hub Device Provisioning Service

API Version:: 2018-01-22

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

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

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 约定将其作为标头提供。
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 流。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

DPSCreate

Sample Request

HTTP

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

{
  "location": "East US",
  "type": "Microsoft.Devices/ProvisioningServices",
  "properties": {},
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "tags": {}
}

Sample Response

Status code:: 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": []
  },
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "tags": {},
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

Status code:: 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": []
  },
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "tags": {},
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

定义

名称	说明
AccessRightsDescription	此密钥具有的权限。
AllocationPolicy	此预配服务要使用的分配策略。
ErrorDetails	错误详细信息。
IotDpsPropertiesDescription	预配服务的服务特定属性，包括密钥、链接的 IoT 中心、当前状态和系统生成的属性（如主机名和 idScope）
IotDpsSku	SKU 名称。
IotDpsSkuInfo	可能的预配服务 SKU 列表。
IotHubDefinitionDescription	IoT 中心的说明。
ProvisioningServiceDescription	预配服务的说明。
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	共享访问密钥的说明。
state	预配服务的当前状态。

AccessRightsDescription

此密钥具有的权限。

名称	类型	说明
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

AllocationPolicy

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

名称	类型	说明
GeoLatency	string
Hashed	string
Static	string

ErrorDetails

错误详细信息。

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

IotDpsPropertiesDescription

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

名称	类型	说明
allocationPolicy	AllocationPolicy	此预配服务要使用的分配策略。
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	预配服务的授权密钥列表。
deviceProvisioningHostName	string	此预配服务的设备终结点。
idScope	string	此预配服务的唯一标识符。
iotHubs	IotHubDefinitionDescription[]	与此预配服务关联的 IoT 中心列表。
provisioningState	string	预配服务的 ARM 预配状态。
serviceOperationsHostName	string	用于预配服务的服务终结点。
state	state	预配服务的当前状态。

IotDpsSku

SKU 名称。

名称	类型	说明
S1	string

IotDpsSkuInfo

可能的预配服务 SKU 列表。

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

IotHubDefinitionDescription

IoT 中心的说明。

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

ProvisioningServiceDescription

预配服务的说明。

名称	类型	说明
etag	string	Etag 字段不是必需的。如果响应正文中提供了它，则还必须根据常规 ETag 约定将其作为标头提供。
id	string	资源标识符。
location	string	资源位置。
name	string	资源名称。
properties	IotDpsPropertiesDescription	预配服务的服务特定属性
sku	IotDpsSkuInfo	预配服务的 SKU 信息。
tags	object	资源标记。
type	string	资源类型。

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

共享访问密钥的说明。

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

state

预配服务的当前状态。

名称	类型	说明
Activating	string
ActivationFailed	string
Active	string
Deleted	string
Deleting	string
DeletionFailed	string
FailingOver	string
FailoverFailed	string
Resuming	string
Suspended	string
Suspending	string
Transitioning	string