Iot Dps Resource - List Keys For Key Name

Ссылка

Служба:: IoT Hub Device Provisioning Service

Версия API:: 2022-12-12

Получите политику общего доступа по имени из службы подготовки.
Вывод списка первичных и вторичных ключей для определенного имени ключа

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

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Это синхронная операция. Текст содержит политику общего доступа, сериализованную в формате JSON, включая ключи, которые можно использовать для доступа к одной или нескольким конечным точкам службы подготовки.
Other Status Codes	ErrorDetails	Ответ об ошибке по умолчанию.

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

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

DPSGetKey

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

HTTP

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

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

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

{
  "keyName": "testKey",
  "primaryKey": "##################################",
  "secondaryKey": "################################",
  "rights": "RegistrationStatusWrite"
}

Определения

Имя	Описание
AccessRightsDescription	Права, имеющиеся у этого ключа.
ErrorDetails	Сведения об ошибке.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Описание общего ключа доступа.

AccessRightsDescription

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

Права, имеющиеся у этого ключа.

Значение	Описание
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

ErrorDetails

Object

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

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

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]