Accounts - Regenerate Keys

Служба:

Maps Management

Версия API:

2023-06-01

Повторно создайте первичный или вторичный ключ для использования с API Карт. Старый ключ перестанет работать немедленно.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/regenerateKey?api-version=2023-06-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
accountName	path	True	string	Имя учетной записи Карт.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Текст запроса

Имя	Обязательно	Тип	Описание
keyType	True	KeyType	Указывает, относится ли операция к первичному или вторичному ключу.

Ответы

Имя	Тип	Описание
200 OK	MapsAccountKeys	Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

Regenerate Key

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

HTTP

POST https://management.azure.com/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount/regenerateKey?api-version=2023-06-01

{
  "keyType": "primary"
}

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

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

200

{
  "primaryKey": "<primaryKey>",
  "primaryKeyLastUpdated": "2021-07-02T01:01:01.1075056Z",
  "secondaryKey": "<secondaryKey>",
  "secondaryKeyLastUpdated": "2021-07-02T01:01:01.1075056Z"
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
KeyType	Указывает, относится ли операция к первичному или вторичному ключу.
MapsAccountKeys	Набор ключей, которые можно использовать для доступа к REST API Карт. Два ключа предоставляются для смены ключей без прерывания.
MapsKeySpecification	Указывает, относится ли операция к первичному или вторичному ключу.

ErrorAdditionalInfo

Object

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

KeyType

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

Указывает, относится ли операция к первичному или вторичному ключу.

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

MapsAccountKeys

Object

Набор ключей, которые можно использовать для доступа к REST API Карт. Два ключа предоставляются для смены ключей без прерывания.

Имя	Тип	Описание
primaryKey	string	Первичный ключ для доступа к REST API Карт.
primaryKeyLastUpdated	string	Последняя обновленная дата и время первичного ключа.
secondaryKey	string	Вторичный ключ для доступа к REST API Карт.
secondaryKeyLastUpdated	string	Последняя обновленная дата и время вторичного ключа.

MapsKeySpecification

Object

Указывает, относится ли операция к первичному или вторичному ключу.

Имя	Тип	Описание
keyType	KeyType	Указывает, относится ли операция к первичному или вторичному ключу.