Iot Dps Resource - List Keys

Ссылка

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

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

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

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

Параметры URI

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

Ответы

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

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Области

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

Примеры

DPSListKeys

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

HTTP

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

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

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

{
  "value": [
    {
      "keyName": "key1",
      "primaryKey": "#####################################",
      "secondaryKey": "###################################",
      "rights": "ServiceConfig"
    },
    {
      "keyName": "key2",
      "primaryKey": "#######################################",
      "secondaryKey": "####################################=",
      "rights": "ServiceConfig"
    }
  ]
}

Определения

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

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.

SharedAccessSignatureAuthorizationRuleListResult

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

Имя	Тип	Описание
nextLink	string	Следующая ссылка.
value	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Список политик общего доступа.

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