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

Iot Dps Resource - List Keys

获取预配服务的安全元数据。
列出预配服务的主密钥和辅助密钥。

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

URI 参数

名称 必需 类型 说明
provisioningServiceName
path True

string

要获取共享访问密钥的预配服务名称。

resourceGroupName
path True

string

资源组名称

subscriptionId
path True

string

订阅标识符。

api-version
query True

string

API 的版本。

响应

名称 类型 说明
200 OK

SharedAccessSignatureAuthorizationRuleListResult

这是一个同步操作。 正文包含共享访问策略(包括密钥)的 JSON 序列化数组,可用于访问预配服务终结点。

Other Status Codes

ErrorDetails

默认错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

DPSListKeys

示例请求

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

示例响应

{
  "value": [
    {
      "keyName": "key1",
      "primaryKey": "#####################################",
      "secondaryKey": "###################################",
      "rights": "ServiceConfig"
    },
    {
      "keyName": "key2",
      "primaryKey": "#######################################",
      "secondaryKey": "####################################=",
      "rights": "ServiceConfig"
    }
  ]
}

定义

名称 说明
AccessRightsDescription

此密钥具有的权限。

ErrorDetails

错误详细信息。

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

共享访问密钥的说明。

SharedAccessSignatureAuthorizationRuleListResult

共享访问密钥列表。

AccessRightsDescription

此密钥具有的权限。

名称 类型 说明
DeviceConnect

string

EnrollmentRead

string

EnrollmentWrite

string

RegistrationStatusRead

string

RegistrationStatusWrite

string

ServiceConfig

string

ErrorDetails

错误详细信息。

名称 类型 说明
code

integer

错误代码。

details

string

错误详细信息。

httpStatusCode

string

HTTP 状态代码。

message

string

错误消息。

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

共享访问密钥的说明。

名称 类型 说明
keyName

string

密钥的名称。

primaryKey

string

主 SAS 密钥值。

rights

AccessRightsDescription

此密钥具有的权限。

secondaryKey

string

辅助 SAS 密钥值。

SharedAccessSignatureAuthorizationRuleListResult

共享访问密钥列表。

名称 类型 说明
nextLink

string

下一个链接。

value

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

共享访问策略的列表。