Iot Hub Resource - Get Keys For Key Name

Служба:: IoT Hub

Версия API:: 2023-06-30

Получите политику общего доступа по имени из Центра Интернета вещей. Дополнительные сведения см. в статье 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}/IotHubKeys/{keyName}/listkeys?api-version=2023-06-30

Параметры URI

Имя	В	Обязательно	Тип	Описание
keyName	path	True	string	Имя политики общего доступа.
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей Центр Интернета вещей.
resourceName	path	True	string	Имя Центра Интернета вещей.
subscriptionId	path	True	string	Идентификатор подписки.
api-version	query	True	string	Версия API.

Ответы

Имя	Тип	Описание
200 OK	SharedAccessSignatureAuthorizationRule	Это синхронная операция. Текст содержит политику общего доступа, сериализованную в ФОРМАТЕ 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_GetKeysForKeyName

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

{
  "keyName": "iothubowner",
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>",
  "rights": "RegistryWrite, ServiceConnect, DeviceConnect"
}

Определения

Имя	Описание
AccessRights	Разрешения, назначенные политике общего доступа.
ErrorDetails	Сведения об ошибке.
SharedAccessSignatureAuthorizationRule	Свойства политики общего доступа Центра Интернета вещей.

AccessRights

Перечисление

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

Значение	Описание
RegistryRead
RegistryWrite
ServiceConnect
DeviceConnect
RegistryRead, RegistryWrite
RegistryRead, ServiceConnect
RegistryRead, DeviceConnect
RegistryWrite, ServiceConnect
RegistryWrite, DeviceConnect
ServiceConnect, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect
RegistryRead, RegistryWrite, DeviceConnect
RegistryRead, ServiceConnect, DeviceConnect
RegistryWrite, ServiceConnect, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

ErrorDetails

Object

Сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
details	string	Сведения об ошибке.
httpStatusCode	string	Код состояния HTTP.
message	string	Сообщение об ошибке.

SharedAccessSignatureAuthorizationRule