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

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

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

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

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

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

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

ErrorDetails

Object

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

Имя Тип Описание
code

integer (int32)

Код ошибки.
details

string

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

string

Код состояния HTTP.
message

string

Сообщение об ошибке.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Object

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

Имя Тип Описание
keyName

string

Имя ключа.
primaryKey

string

Значение ключа первичного SAS.
rights

AccessRightsDescription

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

string

Значение дополнительного ключа SAS.

SharedAccessSignatureAuthorizationRuleListResult

Object

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

Имя Тип Описание
nextLink

string

Следующая ссылка.
value

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

Список политик общего доступа.