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

Alias - Create

适用于: 请参阅定价

创建者可以使用 Azure Maps API 和 SDK 基于专用室内地图数据开发应用程序。 本文介绍适用于Azure Maps Creator 的概念和工具。

此 API 允许调用方创建别名。 还可以在创建请求期间分配别名。 别名可以引用创建者服务生成的 ID,但不能引用另一个别名 ID。

提交创建请求

若要创建别名,请使用 POST 请求。 如果要在创建过程中分配别名,将传递 resourceId 查询参数。

创建别名响应

Create API 返回包含正文中别名资源的 HTTP 201 Created 响应。

创建别名的示例响应:

{
  "createdTimestamp": "2020-02-13T21:19:11.123Z",
  "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
  "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
  "lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z"
}
POST https://{geography}.atlas.microsoft.com/aliases?api-version=2.0
POST https://{geography}.atlas.microsoft.com/aliases?api-version=2.0&creatorDataItemId={creatorDataItemId}

URI 参数

Name In Required Type Description
geography
path True
  • string

此参数指定Azure Maps Creator 资源所在的位置。 有效值是我们和欧盟。

api-version
query True
  • string

Azure Maps API 的版本号。

creatorDataItemId
query
  • string

引用要别名的创建者数据项的唯一 ID。

请求头

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

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

响应

Name Type Description
201 Created

成功创建的内容。 响应正文包含新创建的别名 ID aliasId

Headers

  • Access-Control-Expose-Headers: string
Other Status Codes

发生了意外错误。

安全性

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 支持工作、学校和来宾,但不支持个人帐户。

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

Scopes

Name Description
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,以便安全地存储密钥。

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

示例

Create an alias that does not reference any resource

Sample Request

POST https://us.atlas.microsoft.com/aliases?api-version=2.0

Sample Response

{
  "createdTimestamp": "2021-05-01T01:02:03.456Z",
  "aliasId": "25084fb7-307a-4720-8f91-7952a0b91012",
  "creatorDataItemId": null,
  "lastUpdatedTimestamp": "2021-05-01T01:02:03.456Z"
}

定义

Alias

别名的详细信息。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

Alias

别名的详细信息。

Name Type Description
aliasId
  • string

别名的 ID。

createdTimestamp
  • string

别名的已创建时间戳。

creatorDataItemId
  • string

如果别名未) 分配别名 (,则此别名引用的创建者数据项的 ID 可以为 null。

lastUpdatedTimestamp
  • string

上次分配别名的时间戳。

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

错误响应

Name Type Description
error

错误对象。