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

Render - Get Copyright From Bounding Box

参考

服务:: Maps

API 版本:: 1.0

返回指定边界框的版权信息。

注意

Azure Maps 呈现 v1 服务停用

Azure Maps Render v1 服务现已弃用，将于 26 年 9 月 17 日停用。为了避免服务中断，所有对 Render v1 API 的调用都需要更新为在 9/17/ 26 使用 Render v2 API。

边界框请求应指定最小和最大经度和纬度 (EPSG-3857) 坐标

GET https://atlas.microsoft.com/map/copyright/bounding/{format}?api-version=1.0&mincoordinates={mincoordinates}&maxcoordinates={maxcoordinates}

具有可选参数:

GET https://atlas.microsoft.com/map/copyright/bounding/{format}?api-version=1.0&mincoordinates={mincoordinates}&maxcoordinates={maxcoordinates}&text={text}

URI 参数

名称	在	必需	类型	说明
format	path	True	ResponseFormat	响应的所需格式。值可以是 json 或 xml。
api-version	query	True	string	Azure Maps API 的版本号。
maxcoordinates	query	True	number[]	纬度经度坐标系中边界框) (东北点的最大坐标。例如 52.41064,4.84228
mincoordinates	query	True	number[]	纬度经度坐标系中边界框) (西南点的最小坐标。例如 52.41064,4.84228
text	query		IncludeText	是/否值，用于从响应中排除文本数据。只有图像和国家/地区名称将作为响应。

请求头

名称	必需	类型	说明
x-ms-client-id		string	指定要与Microsoft Entra ID安全模型一起使用的帐户。它表示Azure Maps帐户的唯一 ID，可以从Azure Maps管理平面帐户 API 检索。若要在 Azure Maps 中使用Microsoft Entra ID安全性，请参阅以下文章以获取指导。

响应

名称	类型	说明
200 OK	Copyright	确定
Other Status Codes	ErrorResponse	发生了意外错误。

安全性

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 标识平台概述。

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

作用域

名称	说明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

这是在Azure 门户或使用 PowerShell、CLI、Azure SDK 或 REST API 创建Azure Maps帐户时预配的共享密钥。

使用此密钥，任何应用程序都可以访问所有 REST API。换句话说，此密钥可以用作颁发它们的帐户中的主密钥。

对于公开的应用程序，我们建议使用机密客户端应用程序方法来访问Azure Maps REST API，以便安全地存储密钥。

类型: apiKey
在: query

SAS Token

这是一个共享访问签名令牌，通过 Azure 管理平面通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 在Azure Maps资源上列出 SAS 操作创建。

使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域 () 。换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序，我们建议在映射帐户资源上配置允许的来源的特定列表，以限制呈现滥用，并定期续订 SAS 令牌。

类型: apiKey
在: header

示例

Successful Bounding Box Copyright Request

示例请求

HTTP

GET https://atlas.microsoft.com/map/copyright/bounding/json?api-version=1.0&mincoordinates=52.41064,4.84228&maxcoordinates=52.41072,4.84239&text=yes

示例响应

状态代码:: 200

{
  "formatVersion": "0.0.1",
  "generalCopyrights": [
    "© 1992 – 2016 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.",
    "Data Source © 2016 TomTom",
    "based on"
  ],
  "regions": [
    {
      "copyrights": [
        "Topografische onderground Copyright © dienst voor het kadaster en de openbare registers, Apeldoorn 2016."
      ],
      "country": {
        "ISO3": "NLD",
        "label": "Netherlands"
      }
    }
  ]
}

定义

名称	说明
Copyright	此对象是从成功的版权请求返回的
Country	Country 属性
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
IncludeText	是/否值，用于从响应中排除文本数据。只有图像和国家/地区名称将作为响应。
RegionCopyrights
ResponseFormat	响应的所需格式。值可以是 json 或 xml。

Copyright

此对象是从成功的版权请求返回的

名称	类型	说明
formatVersion	string	Format Version 属性
generalCopyrights	string[]	常规版权数组
regions	RegionCopyrights[]	Regions 数组

Country

Country 属性

名称	类型	说明
ISO3	string	ISO3 属性
label	string	“标签”属性

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

IncludeText

是/否值，用于从响应中排除文本数据。只有图像和国家/地区名称将作为响应。

名称	类型	说明
no	string	从响应中排除文本数据。只有图像和国家/地区名称将作为响应。
yes	string	在响应中包含所有文本数据。

RegionCopyrights

名称	类型	说明
copyrights	string[]	Copyrights 数组
country	Country	Country 属性

ResponseFormat

响应的所需格式。值可以是 json 或 xml。

名称	类型	说明
json	string	JavaScript 对象表示法数据交换格式
xml	string	可扩展标记语言

通过