Data V2 - Download

Ссылка

Service:: Maps

API Version:: 2.0

Область применения: см. ценовые категории.

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

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

Важно!

Используя эту функцию, вы соглашаетесь с предварительными юридическими условиями. Дополнительные сведения см. в дополнительных условиях предварительной версии .

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

Чтобы скачать содержимое, используйте GET запрос, в котором путь будет содержать udid данные для скачивания. При необходимости можно также передать Accept заголовок, чтобы указать предпочтение Content-Type ответа на данные.
Например, чтобы скачать коллекцию геозон, отправленных ранее с помощью API отправки, задайте udid параметр в пути к udid данным, полученным ранее в ответе API отправки, и задайте Accept заголовок одним из следующих типов мультимедиа:

application/json
application/vnd.geo+json
application/octet-stream

Скачивание ответа на данные

API загрузки вернет HTTP-ответ 200 OK , если найден ресурс данных с переданным, udid где текст ответа будет содержать содержимое ресурса данных.
Ответ об ошибке HTTP 400 Bad Request возвращается, если ресурс данных с переданным значением udid не найден.

Ниже приведен пример текста ответа для простой геозоны, представленной GeoJSON ранее с помощью API отправки:

{
    "type": "FeatureCollection",
    "features": [{
        "type": "Feature",
        "geometry": {
            "type": "Point",
            "coordinates": [-122.126986, 47.639754]
        },
        "properties": {
            "geometryId": "001",
            "radius": 500
        }
    }]
}

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

Параметры URI

Name	In	Required	Type	Description
geography	path	True	string	Этот параметр указывает, где находится ресурс Azure Maps Creator. Допустимые значения: мы и eu.
udid	path	True	string	Уникальный идентификатор данных для содержимого. Он `udid` должен быть получен из успешного вызова API отправки данных .
api-version	query	True	string	Номер версии API Azure Maps

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

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

Ответы

Name Type Description

200 OK

Name	Type	Description
200 OK	file	Запрос на скачивание данных успешно завершен. Текст ответа будет содержать содержимое переданного.`udid` Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream" Headers Content-Type: string
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка. Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream"

file

Запрос на скачивание данных успешно завершен. Текст ответа будет содержать содержимое переданного.udid

Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream"

Headers

Content-Type: string

Other Status Codes

ErrorResponse

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

Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream"

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

AADToken

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

В настоящее время Azure Active Directory версии 1.0 или 2.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 Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK Azure или REST API.

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

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

Примеры

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

Sample Request

HTTP

GET https://us.atlas.microsoft.com/mapData/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2.0

Sample Response

Status code:: 200

"{file}"

Определения

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

ErrorAdditionalInfo

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

Name	Type	Description
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

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

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

ErrorResponse

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

Name	Type	Description
error	ErrorDetail	Объект ошибки.