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


Configuration Stores - List Keys

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

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2024-05-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2024-05-01&$skipToken={$skipToken}

Параметры URI

Имя В Обязательно Тип Описание
configStoreName
path True

string

minLength: 5
maxLength: 50
pattern: ^[a-zA-Z0-9_-]*$

Имя хранилища конфигурации.

resourceGroupName
path True

string

Имя группы ресурсов, к которой принадлежит реестр контейнеров.

subscriptionId
path True

string

Идентификатор подписки Microsoft Azure.

api-version
query True

string

Версия клиентского API.

$skipToken
query

string

Маркер пропуска используется для продолжения извлечения элементов после того, как операция возвращает частичный результат. Если предыдущий ответ содержит элемент nextLink, значение элемента nextLink будет включать параметр skipToken, указывающий начальную точку для последующих вызовов.

Ответы

Имя Тип Описание
200 OK

ApiKeyListResult

Запрос выполнен успешно; запрос был хорошо сформирован и получен должным образом.

Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

ConfigurationStores_ListKeys

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

POST https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/listKeys?api-version=2024-05-01

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

{
  "value": [
    {
      "id": "439AD01B4BE67DB1",
      "name": "Primary",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": false
    },
    {
      "id": "CB45E100456857B9",
      "name": "Secondary",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": false
    },
    {
      "id": "B3AC55B7E71431A9",
      "name": "Primary Read Only",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": true
    },
    {
      "id": "E2AF6A9A89DCC177",
      "name": "Secondary Read Only",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": true
    }
  ]
}

Определения

Имя Описание
ApiKey

Ключ API, используемый для проверки подлинности с помощью конечной точки хранилища конфигурации.

ApiKeyListResult

Результат запроса на перечисление ключей API.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetails

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

ErrorResponse

Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

ApiKey

Ключ API, используемый для проверки подлинности с помощью конечной точки хранилища конфигурации.

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

string

Строка подключения, которую можно использовать с помощью поддержки клиентов для проверки подлинности.

id

string

Идентификатор ключа.

lastModified

string (date-time)

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

name

string

Имя ключа, описывающего его использование.

readOnly

boolean

Можно ли использовать этот ключ только для операций чтения.

value

string

Значение ключа, используемого для проверки подлинности.

ApiKeyListResult

Результат запроса на перечисление ключей API.

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

string

Универсальный код ресурса (URI), который можно использовать для запроса следующего набора страничных результатов.

value

ApiKey[]

Значение коллекции.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

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

object

Дополнительные сведения.

type

string

Дополнительный тип сведений.

ErrorDetails

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

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

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

message

string

Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

ErrorResponse

Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

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

ErrorDetails

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