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

Dataset - Create

Service:

Maps Creator

API Version:

2.0

使用 创建数据集。

API Create 是一个 HTTP POST 请求，它采用 conversionId 转换后的绘图包的值并返回 datasetId 新创建的数据集的 属性。 有关详细信息，请参阅 创建数据集。

可以在为建筑物上传 DWG zip 包、使用 Azure Maps 转换服务转换 zip 包以及从转换后的 zip 包创建数据集等方案中使用此请求。 创建的数据集可用于使用Azure Maps磁贴集服务创建磁贴集，并且可以通过Azure Maps WFS 服务进行查询。

提交创建请求

若要创建数据集，你将使用一个 POST 请求，其中 conversionId 查询参数是表示转换后的 DWG zip 包的 ID， datasetId 参数是以前创建的数据集的 ID，要追加到当前数据集，并且（可选） description 查询参数将包含说明 (如果未提供说明，则会) 提供默认说明。

创建 API 是一项 长时间运行的操作。

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}

With optional parameters:

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}&datasetId={datasetId}&description={description}

URI 参数

名称	在	必需	类型	说明
geography	path	True	string	此参数指定 Azure Maps Creator 资源所在的位置。 有效值是 us 和 eu。
api-version	query	True	string	Azure Maps API 的版本号。
conversionId	query	True	string	用于创建数据集的唯一 ID。 必须是从成功调用转换服务转换 API 获取的，conversionId如果) 提供了多个同名查询参数， (可能会提供多个同名的查询参数。
datasetId	query		string	要追加的数据集的 ID。 数据集必须源自与 datasetId 匹配的上一个数据集创建调用
description	query		string	要提供给数据集的说明。

请求头

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

响应

名称	类型	说明
200 OK	LongRunningOperationResult	操作正在运行或已完成。 如果操作成功，请使用 Resource-Location 标头获取结果的路径。 Headers Resource-Location: string
202 Accepted		请求已接受：已接受请求进行处理。 请使用 Operation-Location 标头中的 URL 获取状态。 Headers Operation-Location: string
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 标识平台概述。

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 门户或使用 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 dataset from a converted CAD file provided by conversionId

Sample Request

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2.0&conversionId=[conversionId]

Sample Response

Status code:

200

Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0

Response Body

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Status code:

202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
LongRunningOperationResult	Long-Running 操作 API 的响应模型。
LroStatus	请求的状态。

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ErrorResponse

错误响应

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

LongRunningOperationResult

Long-Running 操作 API 的响应模型。

名称	类型	说明
created	string	创建的时间戳。
error	ErrorDetail	错误详细信息。
operationId	string	此长时间运行的操作的 ID。
status	LroStatus	请求的状态。
warning	ErrorDetail	错误详细信息。

LroStatus

请求的状态。

名称	类型	说明
Failed	string	请求有一个或多个失败。
NotStarted	string	请求尚未开始处理。
Running	string	请求已开始处理。
Succeeded	string	请求已成功完成。