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

Iot Dps Resource - List Keys For Key Name

参考

服务:: IoT Hub Device Provisioning Service

API 版本:: 2022-12-12

从预配服务按名称获取共享访问策略。
列出特定密钥名称的主密钥和辅助密钥

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

URI 参数

名称	在	必需	类型	说明
keyName	path	True	string	要为其获取键值的逻辑键名称。
provisioningServiceName	path	True	string	预配服务的名称。
resourceGroupName	path	True	string	包含预配服务的资源组的名称。
subscriptionId	path	True	string	订阅标识符。
api-version	query	True	string	API 的版本。

响应

名称	类型	说明
200 OK	SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	这是一个同步作。正文包含 JSON 序列化的共享访问策略，包括可用于访问一个或多个预配服务终结点的密钥。
Other Status Codes	ErrorDetails	默认错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

DPSGetKey

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "keyName": "testKey",
  "primaryKey": "##################################",
  "secondaryKey": "################################",
  "rights": "RegistrationStatusWrite"
}

定义

名称	说明
AccessRightsDescription	此密钥具有的权限。
ErrorDetails	错误详细信息。
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	共享访问密钥的说明。

AccessRightsDescription

枚举

此密钥具有的权限。

值	说明
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

ErrorDetails

Object

错误详细信息。

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

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]