通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Accounts - Regenerate Keys

服务:
Maps Management
API 版本:
2023-06-01

重新生成用于 Maps 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

目标订阅的 ID。
api-version
 query True

string

minLength: 1

用于此作的 API 版本。

请求正文

名称 必需 类型 说明
keyType True

KeyType

作是引用主密钥还是辅助密钥。

响应

名称 类型 说明
200 OK

MapsAccountKeys

请求成功。
Other Status Codes

ErrorResponse

发生意外错误。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Regenerate Key

示例请求

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

作是引用主密钥还是辅助密钥。