Iot Dps Resource - List Keys

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

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

Параметры 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.

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

Scopes

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

Примеры

DPSListKeys

Sample Request

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

Sample Response

{
  "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

string

Код ошибки.

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][]

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