你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Render - Get Copyright Caption
用于获取呈现磁贴时要使用的版权信息。
API Get Copyright Caption 是一个 HTTP GET 请求，旨在提供版权信息，以便与从呈现服务请求的磁贴一起使用。 除了整个地图的基本版权外，它还可以为某些国家/地区提供特定的版权组。
作为地图请求版权的替代方法，可以接收用于在地图上显示地图提供程序信息的标题。
GET https://atlas.microsoft.com/map/copyright/caption/{format}?api-version=2022-08-01URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
format
|
path | True |
响应的所需格式。 值可以是 json 或 xml。 |
|
|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 当前版本为 2022-08-01 |
请求头
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| x-ms-client-id |
string |
指定要与Microsoft Entra ID安全模型一起使用的帐户。 它表示Azure Maps帐户的唯一 ID，可以从Azure Maps管理平面帐户 API 检索。 若要在 Azure Maps 中使用Microsoft Entra ID安全性，请参阅以下文章以获取指导。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
确定 |
|
| Other Status Codes |
发生了意外错误。 |
安全性
AADToken
这些是 OAuth 2.0 流Microsoft Entra。 与 Azure 基于角色的访问控制配对后，它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个Azure Maps资源帐户或子资源的访问权限。 可以通过内置角色或由一个或多个权限组成的自定义角色授予任何用户、组或服务主体访问权限，以Azure Maps REST API。
若要实现方案，建议查看 身份验证概念。 总之，此安全定义提供了一个解决方案，用于通过能够对特定 API 和作用域进行访问控制的对象对应用程序 () 建模。
备注
- 此安全定义需要使用
x-ms-client-id标头来指示应用程序请求访问哪个Azure Maps资源。 这可以从 地图管理 API 获取。
Authorization URL特定于 Azure 公有云实例。 主权云具有唯一的授权 URL 和Microsoft Entra ID配置。
* Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。
* 使用 Azure Maps Web SDK 可以针对多个用例基于配置设置应用程序。
- 有关Microsoft 标识平台的详细信息，请参阅Microsoft 标识平台概述。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| 名称 | 说明 |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
这是在通过 Azure 管理平面通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 创建Azure Maps资源时预配的共享密钥。
使用此密钥，任何应用程序都有权访问所有 REST API。 换句话说，这些密钥当前可以视为颁发它们的帐户的主密钥。
对于公开的应用程序，我们建议使用Azure Maps REST API 的服务器到服务器访问，其中可以安全地存储此密钥。
Type:
apiKey
In:
header
SAS Token
这是一个共享访问签名令牌，通过 Azure 管理平面通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 在Azure Maps资源上列出 SAS 操作创建。
使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域 () 。 换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。
对于公开的应用程序，我们建议在 映射帐户资源 上配置允许的来源的特定列表，以限制呈现滥用，并定期续订 SAS 令牌。
Type:
apiKey
In:
header
示例
Successful Copyright Caption Request
Sample Request
GET https://atlas.microsoft.com/map/copyright/caption/json?api-version=2022-08-01
Sample Response
{
"formatVersion": "0.0.1",
"copyrightsCaption": "©TomTom."
}定义
| 名称 | 说明 |
|---|---|
|
Copyright |
此对象是从成功的版权调用返回的 |
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详细信息。 |
|
Error |
错误响应 |
|
Response |
响应的所需格式。 值可以是 json 或 xml。 |
CopyrightCaption
此对象是从成功的版权调用返回的
| 名称 | 类型 | 说明 |
|---|---|---|
| copyrightsCaption |
string |
Copyrights Caption 属性 |
| formatVersion |
string |
Format Version 属性 |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
其他信息。 |
| type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
错误附加信息。 |
|
| code |
string |
错误代码。 |
| details |
错误详细信息。 |
|
| message |
string |
错误消息。 |
| target |
string |
错误目标。 |
ErrorResponse
错误响应
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |
ResponseFormat
响应的所需格式。 值可以是 json 或 xml。
| 名称 | 类型 | 说明 |
|---|---|---|
| json |
string |
|
| xml |
string |