Iot Hub Resource - Get Keys For Key Name
Получение политики общего доступа по имени из Центра Интернета вещей. Дополнительные сведения см. на странице 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
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
key
|
path | True |
string |
Название политики общего доступа. |
resource
|
path | True |
string |
Имя группы ресурсов, содержащей Центр Интернета вещей. |
resource
|
path | True |
string |
Имя Центра Интернета вещей. |
subscription
|
path | True |
string |
Идентификатор подписки. |
api-version
|
query | True |
string |
Версия API. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Это синхронная операция. Текст содержит сериализованную в ФОРМАТЕ JSON политику общего доступа, включая ключи, которые можно использовать для доступа к одной или нескольким конечным точкам Центра Интернета вещей. |
|
Other Status Codes |
DefaultErrorResponse |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
IotHubResource_GetKeysForKeyName
Образец запроса
Пример ответа
{
"keyName": "iothubowner",
"primaryKey": "<primaryKey>",
"secondaryKey": "<secondaryKey>",
"rights": "RegistryWrite, ServiceConnect, DeviceConnect"
}
Определения
Имя | Описание |
---|---|
Access |
Разрешения, назначенные политике общего доступа. |
Error |
Сведения об ошибке. |
Shared |
Свойства политики общего доступа к Центру Интернета вещей. |
AccessRights
Разрешения, назначенные политике общего доступа.
Имя | Тип | Описание |
---|---|---|
DeviceConnect |
string |
|
RegistryRead |
string |
|
RegistryRead, DeviceConnect |
string |
|
RegistryRead, RegistryWrite |
string |
|
RegistryRead, RegistryWrite, DeviceConnect |
string |
|
RegistryRead, RegistryWrite, ServiceConnect |
string |
|
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect |
string |
|
RegistryRead, ServiceConnect |
string |
|
RegistryRead, ServiceConnect, DeviceConnect |
string |
|
RegistryWrite |
string |
|
RegistryWrite, DeviceConnect |
string |
|
RegistryWrite, ServiceConnect |
string |
|
RegistryWrite, ServiceConnect, DeviceConnect |
string |
|
ServiceConnect |
string |
|
ServiceConnect, DeviceConnect |
string |
ErrorDetails
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки. |
details |
string |
Сведения об ошибке. |
httpStatusCode |
string |
Код состояния HTTP. |
message |
string |
Сообщение об ошибке. |
SharedAccessSignatureAuthorizationRule
Свойства политики общего доступа к Центру Интернета вещей.
Имя | Тип | Описание |
---|---|---|
keyName |
string |
Название политики общего доступа. |
primaryKey |
string |
Первичный ключ. |
rights |
Разрешения, назначенные политике общего доступа. |
|
secondaryKey |
string |
Вторичный ключ. |