Iot Dps Resource - List Keys For Key Name

Ссылка

Service:: IoT Hub Device Provisioning Service

API Version:: 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.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

DPSGetKey

Sample Request

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

Sample Response

Status code:: 200

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

Определения

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

AccessRightsDescription

Права, которые имеет этот ключ.

Имя	Тип	Описание
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

ErrorDetails

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

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

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Описание общего ключа доступа.

Имя	Тип	Описание
keyName	string	Имя ключа.
primaryKey	string	Значение первичного ключа SAS.
rights	AccessRightsDescription	Права, которые имеет этот ключ.
secondaryKey	string	Значение вторичного ключа SAS.