Iot Hub Resource - List Keys

获取 IoT 中心的安全元数据。 有关详细信息,请参阅:https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys?api-version=2023-06-30

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

包含 IoT 中心的资源组的名称。

resourceName
path True

string

IoT 中心的名称。

subscriptionId
path True

string

订阅标识符。

api-version
query True

string

API 的版本。

响应

名称 类型 说明
200 OK

SharedAccessSignatureAuthorizationRuleListResult

这是一个同步作。 正文包含 JSON 序列化的共享访问策略数组,包括可用于访问 IoT 中心终结点的密钥。

Other Status Codes

ErrorDetails

DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

IotHubResource_ListKeys

示例请求

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/listkeys?api-version=2023-06-30

示例响应

{
  "value": [
    {
      "keyName": "iothubowner",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "RegistryWrite, ServiceConnect, DeviceConnect"
    },
    {
      "keyName": "service",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "ServiceConnect"
    },
    {
      "keyName": "device",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "DeviceConnect"
    },
    {
      "keyName": "registryRead",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "RegistryRead"
    },
    {
      "keyName": "registryReadWrite",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "RegistryWrite"
    }
  ]
}

定义

名称 说明
AccessRights

分配给共享访问策略的权限。

ErrorDetails

错误详细信息。

SharedAccessSignatureAuthorizationRule

IoT 中心共享访问策略的属性。

SharedAccessSignatureAuthorizationRuleListResult

具有下一个链接的共享访问策略列表。

AccessRights

分配给共享访问策略的权限。

说明
DeviceConnect
RegistryRead
RegistryRead, DeviceConnect
RegistryRead, RegistryWrite
RegistryRead, RegistryWrite, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect
RegistryRead, ServiceConnect
RegistryRead, ServiceConnect, DeviceConnect
RegistryWrite
RegistryWrite, DeviceConnect
RegistryWrite, ServiceConnect
RegistryWrite, ServiceConnect, DeviceConnect
ServiceConnect
ServiceConnect, DeviceConnect

ErrorDetails

错误详细信息。

名称 类型 说明
code

string

错误代码。

details

string

错误详细信息。

httpStatusCode

string

HTTP 状态代码。

message

string

错误消息。

SharedAccessSignatureAuthorizationRule

IoT 中心共享访问策略的属性。

名称 类型 说明
keyName

string

共享访问策略的名称。

primaryKey

string

主键。

rights

AccessRights

分配给共享访问策略的权限。

secondaryKey

string

辅助密钥。

SharedAccessSignatureAuthorizationRuleListResult

具有下一个链接的共享访问策略列表。

名称 类型 说明
nextLink

string

下一个链接。

value

SharedAccessSignatureAuthorizationRule[]

共享访问策略的列表。