Поделиться через


Iot Hub Resource - List Keys

Получение метаданных безопасности для Центра Интернета вещей. Дополнительные сведения см. в статье 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

Имя группы ресурсов, содержащей Центр Интернета вещей.

resourceName
path True

string

Имя Центра Интернета вещей.

subscriptionId
path True

string

Идентификатор подписки.

api-version
query True

string

Версия API.

Ответы

Имя Тип Описание
200 OK

SharedAccessSignatureAuthorizationRuleListResult

Это синхронная операция. Текст содержит сериализованный в ФОРМАТЕ JSON массив политик общего доступа, включая ключи, которые можно использовать для доступа к конечным точкам Центра Интернета вещей.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: 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

Свойства политики общего доступа Центра Интернета вещей.

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

Свойства политики общего доступа Центра Интернета вещей.

Имя Тип Описание
keyName

string

Имя политики общего доступа.

primaryKey

string

Первичный ключ.

rights

AccessRights

Разрешения, назначенные политике общего доступа.

secondaryKey

string

Вторичный ключ.

SharedAccessSignatureAuthorizationRuleListResult

Список политик общего доступа со следующей ссылкой.

Имя Тип Описание
nextLink

string

Следующая ссылка.

value

SharedAccessSignatureAuthorizationRule[]

Список политик общего доступа.