Data - Delete Preview

Ссылка

Service:: Maps

API Version:: 1.0

Запрос на удаление позволяет вызывающей стороны удалить данные, отправленные ранее с помощью функции "Отправка данных".
Применимо к: Ценовая категория S1.

Этот API позволяет вызывающей стороны удалять ранее отправленное содержимое данных.

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

Примечание

Прекращение поддержки службы данных Azure Maps

Служба данных Azure Maps (версии 1 и 2) теперь является устаревшей и будет прекращена 16.09.24. Чтобы избежать перебоев в работе службы, все вызовы к службе данных должны быть обновлены для использования службы реестра данных Azure Maps до 16.09.24. Дополнительные сведения см. в статье Создание реестра данных.

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

Чтобы удалить содержимое, отправьте DELETE запрос, в котором путь будет содержать udid данные для удаления.

Например, чтобы удалить коллекцию геозон, отправленных ранее с помощью API отправки, задайте udid параметру в пути udid данные, полученные ранее в ответе API отправки.

Ответ на удаление данных

API удаления данных возвращает HTTP-ответ 204 No Content с пустым текстом, если ресурс данных был успешно удален.

Если ресурс данных с переданным элементом не найден, будет возвращен ответ об ошибке udid HTTP400 Bad Request.

DELETE https://{geography}.atlas.microsoft.com/mapData/{udid}?api-version=1.0

With optional parameters:

DELETE https://{geography}.atlas.microsoft.com/mapData/{udid}?subscription-key={subscription-key}&api-version=1.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
geography	path	True	string	Этот параметр указывает, где находится ресурс Azure Maps Creator. Допустимые значения: us и eu.
udid	path	True	string	Уникальный идентификатор данных для содержимого. Объект `udid` должен быть получен из успешного вызова API отправки данных .
api-version	query	True	string	Номер версии API Azure Maps Текущая версия — 1.0.
subscription-key	query		string	Один из ключей Azure Maps, предоставляемых из учетной записи Azure Maps. Дополнительные сведения об управлении проверкой подлинности см. в этой статье .

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

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

Ответы

Имя	Тип	Описание
204 No Content	object	Запрос на удаление данных выполнен успешно. Содержимое для `udid` было удалено на сервере.
400 Bad Request	ODataErrorResponse	Недопустимый запрос: один или несколько параметров были указаны неправильно или являются взаимоисключающими.
401 Unauthorized	ODataErrorResponse	Доступ запрещен из-за недопустимого ключа подписки или недопустимого маркера носителя Microsoft Entra ID. Обязательно укажите действительный ключ для активной подписки Azure и ресурса Maps. В противном случае проверьте заголовок WWW-Authenticate на наличие кода ошибки и описание предоставленного маркера носителя Microsoft Entra ID. Headers WWW-Authenticate: string
403 Forbidden	ODataErrorResponse	Проблемы с разрешениями, емкостью или проверкой подлинности.
404 Not Found	ODataErrorResponse	Не найдено: не удалось найти запрошенный ресурс, но он может быть снова доступен в будущем.
500 Internal Server Error	ODataErrorResponse	При обработке этого запроса возникла ошибка. Повторите попытку позже.

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

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 можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи map , чтобы ограничить использование маркера SAS и регулярно обновлять маркер SAS.

Type: apiKey
In: header

Примеры

Delete previously uploaded GeoJSON data containing geometries that represent a collection of geofences

Sample Request

HTTP

DELETE https://us.atlas.microsoft.com/mapData/25084fb7-307a-4720-8f91-7952a0b91012?subscription-key=[subscription-key]&api-version=1.0

Sample Response

Status code:: 204

{}

Status code:: 400

{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}

Status code:: 401

{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}

Status code:: 403

{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}

Status code:: 404

{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}

Status code:: 500

{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Определения

Имя	Описание
ODataError	Этот объект возвращается при возникновении ошибки в API Azure Maps.
ODataErrorResponse	Этот объект ответа возвращается при возникновении ошибки в API Azure Maps.

ODataError

Этот объект возвращается при возникновении ошибки в API Azure Maps.

Имя	Тип	Описание
code	string	Код ODataError.
details	ODataError[]	Этот объект возвращается при возникновении ошибки в API Azure Maps.
message	string	Если доступно, это понятное описание ошибки.
target	string	Если доступно, целевой объект, вызывающий ошибку.

ODataErrorResponse

Этот объект ответа возвращается при возникновении ошибки в API Azure Maps.

Имя	Тип	Описание
error	ODataError	Этот объект возвращается при возникновении ошибки в API Azure Maps.