Tileset - Get
Используйте для получения сведений о наборе плиток.
Отправка запроса на получение
Get
API — это HTTP-запросGET
, используемый для получения сведений о наборе плиток.
GET https://{geography}.atlas.microsoft.com/tilesets/{tilesetId}?api-version=2023-03-01-preview
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
geography
|
path | True |
string |
Этот параметр указывает, где находится ресурс Azure Maps Creator. Допустимые значения: us и eu. |
tileset
|
path | True |
string |
Идентификатор набора плиток |
api-version
|
query | True |
string |
Номер версии API Azure Maps |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
x-ms-client-id |
string |
Указывает учетную запись, предназначенную для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Запрос на получение списка плиток успешно завершен. Текст ответа содержит список всех наборов плиток. |
|
Other Status Codes |
Произошла непредвиденная ошибка. |
Безопасность
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
Имя | Описание |
---|---|
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
Примеры
Gets the details for a single tileset
Sample Request
GET https://us.atlas.microsoft.com/tilesets/{tilesetId}?api-version=2023-03-01-preview
Sample Response
{
"tilesetId": "{tilesetId}",
"datasetId": "{datasetId}",
"description": "My first tileset",
"minZoom": 16,
"maxZoom": 18,
"bbox": [
-122.13595,
47.636524,
-122.1329,
47.637525
]
}
Определения
Имя | Описание |
---|---|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Сообщение об ошибке |
Feature |
Конфигурация компонентов для конфигурации набора плиток. |
Layer |
Объект слоя для конфигурации набора плиток. |
Tileset |
Подробные сведения о данных. |
Tileset |
Поля верхнего уровня конфигурации набора плиток. Конфигурация набора плиток — это объект JSON, который должен содержать следующие поля верхнего уровня: |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Тип дополнительных сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Сообщение об ошибке
Имя | Тип | Описание |
---|---|---|
error |
Объект error. |
Feature
Конфигурация компонентов для конфигурации набора плиток.
Имя | Тип | Описание |
---|---|---|
featureClasses |
string[] |
Список классов признаков, которые будут использоваться для построения слоя. Допустимые классы признаков можно найти в определении онтологии. Например, онтология объекта |
filter |
object |
Удаляет компоненты, которые не соответствуют шаблону. См. выражение фильтра MapLibre |
LayerObject
Объект слоя для конфигурации набора плиток.
Имя | Тип | Описание |
---|---|---|
features |
Указывает классы и фильтры признаков. |
|
maxZoom |
integer |
Самый высокий уровень масштабирования для слоя, который требуется создать. |
minZoom |
integer |
Самый низкий уровень масштабирования для слоя, который требуется создать. |
Tileset
Подробные сведения о данных.
Имя | Тип | Описание |
---|---|---|
bbox |
number[] |
Ограничивающий прямоугольник, внутри которого лежат все признаки набора плиток. Используемая проекция — EPSG:3857. Формат: minLon, minLat, maxLon, maxLat. |
datasetId |
string |
Уникальный идентификатор набора данных, используемый для создания набора плиток. |
defaultMapConfigurationId |
string |
Идентификатор конфигурации карты по умолчанию для набора плиток |
description |
string |
Описание вызывающего объекта, предоставленное при создании набора плиток. Максимальная длина 1024 символов. |
maxZoom |
integer |
Плитка верхнего уровня масштаба плитки, созданная для набора плиток. |
minZoom |
integer |
Плитка наименьшего уровня масштабирования, созданная для набора плиток. |
ontology |
string |
Онтологическая версия этого набора данных. |
tilesetConfiguration |
Конфигурация набора плиток, используемая для создания набора плиток. |
|
tilesetId |
string |
Уникальный идентификатор набора плиток для набора плиток. |
TilesetConfiguration
Поля верхнего уровня конфигурации набора плиток. Конфигурация набора плиток — это объект JSON, который должен содержать следующие поля верхнего уровня:
Имя | Тип | Описание |
---|---|---|
layers |
<string,
Layer |
Имена слоев и их параметры конфигурации. Объект уровней конфигурации содержит пары "ключ-значение", связывающие имена слоев плиток с их конфигурацией. Для каждой пары "ключ-значение" ключ — это имя слоя, а значение — объект LayerObject, содержащий конфигурацию и параметры для слоя. Каждый слой должен иметь имя. Это уникальный идентификатор слоя данных в окончательном наборе плиток. В любом наборе плиток имя каждого слоя должно быть уникальным. Имя слоя должно быть строкой, состоящей только из символов подчеркивания (_) и буквенно-цифровых символов. Соответствующий объект LayerObject для каждого имени слоя описывает, как должен быть создан слой векторной плитки. Он указывает, какие классы признаков следует извлекать данные признаков, точность данных с помощью уровней масштабирования, а также способ преобразования признаков и их визуализации в плитки. |
version |
integer |
Версия ссылки на конфигурацию службы Azure Maps Tiling, которую использует конфигурация набора плиток. В настоящее время разрешена только версия 1. Использование любой другой версии текущей или предыдущей версии приведет к ошибке. |