Dataset - Create

Ссылка

Service:: Maps Creator

API Version:: 2.0

Используйте для создания набора данных.

Create API — это HTTP-запросPOST, который принимает conversionId значение преобразованного пакета рисования и возвращает datasetId свойство только что созданного набора данных. Дополнительные сведения см. в статье Создание набора данных.

Этот запрос можно использовать в таких сценариях, как отправка ZIP-пакета DWG для здания, преобразование ZIP-пакета с помощью службы преобразования Azure Maps и создание набора данных из преобразованного ZIP-пакета. Созданный набор данных можно использовать для создания наборов плиток с помощью службы Azure Maps набора плиток, а также для запроса через службу Azure Maps WFS.

Отправка запроса на создание

Для создания набора данных используется POST запрос, в conversionId котором параметр запроса представляет собой идентификатор, представляющий преобразованный ZIP-пакет DWG, datasetId параметр — идентификатор ранее созданного набора данных для добавления к текущему набору данных. При необходимости 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	Номер версии API Azure Maps
conversionId	query	True	string	Уникальный идентификатор, используемый для создания набора данных. Объект `conversionId` должен быть получен в результате успешного вызова API преобразования службы преобразования и может быть предоставлен с несколькими параметрами запроса с одинаковыми именами (если указано несколько).
datasetId	query		string	Идентификатор добавляемого набора данных. Набор данных должен исходить из предыдущего вызова создания набора данных, который соответствует datasetId.
description	query		string	Описание, присваиваемого набору данных.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает учетную запись, предназначенную для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.

Ответы

Имя	Тип	Описание
200 OK	LongRunningOperationResult	Операция выполняется или завершена. Если операция прошла успешно, используйте заголовок Resource-Location, чтобы получить путь к результату. Headers Resource-Location: string
202 Accepted		Запрос принят: запрос принят для обработки. Чтобы получить состояние, используйте URL-адрес в заголовке Operation-Location. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

Имя

Тип

Описание

200 OK

LongRunningOperationResult

Операция выполняется или завершена. Если операция прошла успешно, используйте заголовок Resource-Location, чтобы получить путь к результату.

Headers

Resource-Location: string

202 Accepted

Запрос принят: запрос принят для обработки. Чтобы получить состояние, используйте URL-адрес в заголовке Operation-Location.

Headers

Operation-Location: string

Other Status Codes

ErrorResponse

Произошла непредвиденная ошибка.

Безопасность

AADToken

Это Microsoft Entra потоков OAuth 2.0. В сочетании с управлением доступом на основе ролей 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 с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.

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 Maps в портал Azure или с помощью PowerShell, CLI, пакетов AZURE SDK или REST API.

С помощью этого ключа любое приложение может получить доступ ко всем REST API. Иными словами, этот ключ можно использовать в качестве ключа master в учетной записи, в которую они выдаются.

Для общедоступных приложений мы рекомендуем использовать подход конфиденциальных клиентских приложений для доступа к Azure Maps REST API, чтобы ключ можно было безопасно хранить.

Type: apiKey
In: query

SAS Token

Этот маркер подписанного URL-адреса создается из операции List SAS в ресурсе Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей 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	Модель ответа для API операций Long-Running.
LroStatus	Состояние запроса.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект error.

LongRunningOperationResult

Модель ответа для API операций Long-Running.

Имя	Тип	Описание
created	string	Созданная метка времени.
error	ErrorDetail	Сведения об ошибке.
operationId	string	Идентификатор для этой длительной операции.
status	LroStatus	Состояние запроса.
warning	ErrorDetail	Сведения об ошибке.

LroStatus

Состояние запроса.

Имя	Тип	Описание
Failed	string	Запрос имеет один или несколько сбоев.
NotStarted	string	Запрос еще не начал обработку.
Running	string	Запрос начал обработку.
Succeeded	string	Запрос успешно завершен.

Dataset - Create

Отправка запроса на создание

Параметры URI

Заголовок запроса

Ответы

Безопасность

AADToken

Примечания

Scopes

subscription-key

SAS Token

Примеры

Create dataset from a converted CAD file provided by conversionId

Sample Request

Sample Response

Определения

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

Дополнительные ресурсы