Admin Keys - Regenerate

Служба:
Search Management
Версия API:
2025-02-01-preview

Повторно создает ключ API первичного или дополнительного администратора. Одновременно можно повторно создать только один ключ.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}?api-version=2025-02-01-preview

Параметры URI

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

AdminKeyKind

Указывает, какой ключ необходимо повторно создать. Допустимые значения включают "primary" и "secondary".
resourceGroupName
 path True

string

Имя группы ресурсов в текущей подписке. Это значение можно получить из API Azure Resource Manager или портала.
searchServiceName
 path True

string

pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$

Имя службы поиска ИИ Azure, связанной с указанной группой ресурсов.
subscriptionId
 path True

string

Уникальный идентификатор подписки Microsoft Azure. Это значение можно получить из API Azure Resource Manager или портала.
api-version
 query True

string

Версия API, используемая для каждого запроса.

Заголовок запроса

Имя Обязательно Тип Описание
x-ms-client-request-id

string (uuid)

Значение GUID, созданное клиентом, идентифицирующее этот запрос. Если этот параметр указан, он будет включен в сведения о ответе в качестве способа отслеживания запроса.

Ответы

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

AdminKeyResult

Указанный ключ администратора успешно создан. Оба ключа администратора включены в ответ, включая вновь созданный ключ.
Other Status Codes

CloudError

HTTP 404 (не найдено): не удалось найти подписку, группу ресурсов или службу поиска. HTTP 409 (конфликт): указанная подписка отключена.

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

azure_auth

Указывает неявный поток предоставления, как поддерживается на платформе удостоверений Майкрософт.

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

Области

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

Примеры

SearchRegenerateAdminKey

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

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/regenerateAdminKey/primary?api-version=2025-02-01-preview

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

Код состояния:
200 
{
  "primaryKey": "<your primary admin API key>",
  "secondaryKey": "<your secondary admin API key>"
}

Определения

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

Указывает, какой ключ необходимо повторно создать. Допустимые значения включают "primary" и "secondary".
AdminKeyResult

Ответ, содержащий ключи API первичного и дополнительного администратора для данной службы поиска ИИ Azure.
CloudError

Содержит сведения об ошибке API.
CloudErrorBody

Описывает определенную ошибку API с кодом ошибки и сообщением.

AdminKeyKind

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

Указывает, какой ключ необходимо повторно создать. Допустимые значения включают "primary" и "secondary".

Значение Описание
primary

Первичный ключ API для службы поиска.
secondary

Дополнительный ключ API для службы поиска.

AdminKeyResult

Объект

Ответ, содержащий ключи API первичного и дополнительного администратора для данной службы поиска ИИ Azure.

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

string

Ключ API первичного администратора службы поиска.
secondaryKey

string

Ключ API вторичного администратора службы поиска.

CloudError

Объект

Содержит сведения об ошибке API.

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

CloudErrorBody

Описывает определенную ошибку API с кодом ошибки и сообщением.
message

string

Краткое описание ошибки, которая указывает на то, что пошло не так (для получения сведений или отладки см. свойство error.message).

CloudErrorBody

Объект

Описывает определенную ошибку API с кодом ошибки и сообщением.

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

string

Код ошибки, описывающий условие ошибки точнее, чем код состояния HTTP. Можно использовать для программной обработки конкретных случаев ошибок.
details

CloudErrorBody[]

Содержит вложенные ошибки, связанные с этой ошибкой.
message

string

Сообщение, описывающее ошибку подробно и предоставляющее сведения об отладке.
target

string

Целевой объект конкретной ошибки (например, имя свойства в ошибке).