Routeset - Get

服务:

Maps Creator

API 版本:

2023-03-01-preview

用于获取路由集的详细信息。

注释

Azure Maps Creator 停用

Azure Maps Creator 室内地图服务现已弃用，将于 2025 年 9 月 30 日停用。 有关详细信息，请参阅 Azure Maps Creator 生命周期结束公告。

Creator 允许使用 Azure Maps API 和 SDK 基于专用室内地图数据开发应用程序。 有关 Azure Maps Creator 概念和工具简介，请参阅 创建者室内地图 一文。

提交获取请求

Get API 是一个 HTTP GET 请求，允许调用方提取由 routesetId指定的现有路由集的详细信息。

GET https://{geography}.atlas.microsoft.com/routesets/{routesetId}?api-version=2023-03-01-preview

URI 参数

名称	在	必需	类型	说明
geography	path	True	string	此参数指定 Azure Maps Creator 资源所在的位置。 有效值是我们和欧盟。
routesetId	path	True	string	要查询的路由集的 ID。
api-version	query	True	string	Azure Maps API 的版本号。

请求头

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

响应

名称	类型	说明
200 OK	Routeset	获取路由集请求已成功完成。
Other Status Codes	ErrorResponse	发生意外错误。

安全性

AADToken

这些是 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 v1.0 或 v2.0 支持工作、学校和来宾，但不支持个人帐户。

类型: 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 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面在 azure Maps 资源 上的列表 SAS 操作创建。

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

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

类型: apiKey
在: header

示例

Get details for a previously created dataset

示例请求

HTTP

GET https://us.atlas.microsoft.com/routesets/[routeset-Id]?api-version=2023-03-01-preview

示例响应

状态代码:

200

{
  "routesetId": "[routesetid 1]",
  "datasetId": "[datasetid A]",
  "description": "routeset_name",
  "facilities": [
    {
      "facilityId": "FCL20",
      "levelOrdinals": [
        0,
        1
      ]
    }
  ],
  "created": "2022-09-01T00:00:00.000+00:00"
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
FacilityDetails	有关路由集中每个设施的详细信息。
Routeset	路由集的详细信息。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

ErrorDetail

Object

错误详细信息。

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

ErrorResponse

Object

错误响应

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

FacilityDetails

Object

有关路由集中每个设施的详细信息。

名称	类型	说明
facilityId	string	创建此路由集的结构的标识符。
levelOrdinals	number[]	此设施中的级别标识符。

Routeset

Object

路由集的详细信息。

名称	类型	说明
created	string (date-time)	创建路由集对象的日期和时间。
datasetId	string	用于创建此路由集的数据集的 ID。
description	string	具有本体版本号的建筑物的说明代码。
facilities	FacilityDetails[]	设施信息和建筑物级序号。
routesetId	string	路由集的唯一 ID。