您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

Render - Get Copyright Caption

适用 于: S0 和 S1 定价层。

版权 API 旨在为呈现磁贴服务提供版权信息。 除了针对整个地图的基本版权,API 还为某些国家/地区的特定版权组提供服务。

作为地图请求的版权的替代方法,可以在地图上收到用于显示地图提供程序信息的标题。

GET https://atlas.microsoft.com/map/copyright/caption/{format}?api-version=1.0
GET https://atlas.microsoft.com/map/copyright/caption/{format}?subscription-key={subscription-key}&api-version=1.0

URI 参数

Name In Required Type Description
format
path True

所需的响应格式。 值可以是 jsonxml

api-version
query True
  • string

Azure Maps API 的版本号。 当前版本为1。0

subscription-key
query
  • string

从 Azure 地图帐户提供的 Azure Maps 密钥之一。 有关如何管理身份验证的详细信息,请参阅此

请求头

Name Required Type Description
x-ms-client-id
  • string

指定哪个帐户将与 Azure AD 安全模型结合使用。 它表示 Azure Maps 帐户的唯一 ID,并且可以从 "Azure Maps 管理平面帐户 API" 中检索。 若要在 Azure Maps 中使用 Azure AD 安全性,请参阅以下文章以获取指导。

响应

Name Type Description
200 OK

“确定”

Media Types: "application/json", "application/xml"

400 Bad Request

错误的请求:一个或多个参数未正确指定或互斥。

Media Types: "application/json", "application/xml"

401 Unauthorized

由于订阅密钥无效或无效的 Azure Active Directory (Azure AD) 持有者令牌,拒绝访问。 请确保为有效的 Azure 订阅提供有效密钥并地图资源。 否则,请验证 WWW 身份验证 标头中的错误代码和提供的 Azure AD 持有者令牌的说明。

Media Types: "application/json", "application/xml"

Headers

  • WWW-Authenticate: string
403 Forbidden

权限、容量或身份验证问题。

Media Types: "application/json", "application/xml"

404 Not Found

找不到:找不到请求的资源,但将来可能会再次提供该资源。

Media Types: "application/json", "application/xml"

500 Internal Server Error

处理该请求时出错。 请稍后再试。

Media Types: "application/json", "application/xml"

安全性

azure_auth

这些是Azure Active Directory OAuth2流。 与Azure 基于角色的访问控制配对时,可以使用它来控制对 Azure Maps REST api 的访问。 使用 Azure 基于角色的访问控制来指定对一个或多个 Azure Maps 资源帐户或子资源的访问权限。 任何用户、组或服务主体都可以通过内置角色或自定义角色授予访问权限,该角色由一个或多个权限来 Azure Maps REST Api。

若要实现方案,建议查看 身份验证概念。 总的来说,此安全定义提供一个解决方案,用于通过可访问控制的对象在特定的 Api 和作用域上对应用程序 () 建模。

说明

  • 此安全定义 需要 使用 x-ms-client-id 标头来指示应用程序请求访问的 Azure Maps 资源。 这可以从地图管理 API获取。

Authorization URL特定于 Azure 公有云实例。 主权云具有唯一的授权 Url 和 Azure Active directory 配置。 * Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure Sdk 或 REST Api 从 azure 管理平面 配置的。 * Azure Maps Web SDK的使用允许对多个用例的应用程序进行基于配置的配置。

  • 目前支持 Azure Active Directory 1.0版令牌。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

subscription-key

这是通过 Azure 门户、PowerShell、CLI、azure sdk 或 REST api 通过 Azure 管理平面创建Azure Maps 资源时预配的共享密钥。

使用此密钥,任何应用程序都有权访问所有 REST Api。 换句话说,这些密钥目前可以作为主密钥分配给颁发它们的帐户。

对于公开显示的应用程序,我们建议使用 Azure Maps REST Api 的服务器到服务器访问,可以安全地存储此密钥。

Type: apiKey
In: query

示例

GetCopyrightCaption

Sample Request

GET https://atlas.microsoft.com/map/copyright/caption/json?subscription-key=[subscription-key]&api-version=1.0

Sample Response

{
  "formatVersion": "0.0.1",
  "copyrightsCaption": "© 1992 - 2017 TomTom."
}
{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}
{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}
{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}
{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}
{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

定义

CopyrightCaptionResult

此对象从成功的版权标题调用返回

ODataError

Azure Maps API 中发生错误时,将返回此对象。

ODataErrorResponse

当 Azure Maps API 中出现错误时,将返回此响应对象。

TextFormat

所需的响应格式。 值可以是 jsonxml

CopyrightCaptionResult

此对象从成功的版权标题调用返回

Name Type Description
copyrightsCaption
  • string

版权标题属性

formatVersion
  • string

格式版本属性

ODataError

Azure Maps API 中发生错误时,将返回此对象。

Name Type Description
code
  • string

ODataError 代码。

details

Azure Maps API 中发生错误时,将返回此对象。

message
  • string

如果可用,则为错误的可读说明。

target
  • string

如果有,则目标导致错误。

ODataErrorResponse

当 Azure Maps API 中出现错误时,将返回此响应对象。

Name Type Description
error

Azure Maps API 中发生错误时,将返回此对象。

TextFormat

所需的响应格式。 值可以是 jsonxml

Name Type Description
json
  • string

JavaScript 对象表示法的数据交换格式

xml
  • string

可扩展标记语言