Render - Get Map State Tile

  • Ссылка
Service:
Maps
API Version:
1.0

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

Извлекает плитки состояния в векторном формате, как правило, интегрируется в модуль схем помещений элемента управления картой или пакета SDK. Элемент управления картой будет вызывать этот API после включения пользователем динамического стиля (см. раздел "Уровни масштабирования" и "Сетка плиток")

GET https://atlas.microsoft.com/map/statetile?api-version=1.0&zoom={zoom}&x={x}&y={y}&statesetId={statesetId}

Параметры URI

Name In Required Type Description
api-version
 query True
  • string

Номер версии API Azure Maps
statesetId
 query True
  • string

Идентификатор набора состояний.
x
 query True
  • integer
int32

Координата X плитки в сетке масштабирования. Значение должно находиться в диапазоне [0, 2zoom –1].

Дополнительные сведения см. в разделе "Уровни масштабирования" и "Сетка плиток ".
y
 query True
  • integer
int32

Координата Y плитки в сетке масштабирования. Значение должно находиться в диапазоне [0, 2zoom –1].

Дополнительные сведения см. в разделе "Уровни масштабирования" и "Сетка плиток ".
zoom
 query True
  • integer
int32

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

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

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

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
  • object

Эта плитка возвращается из успешного вызова плитки состояния карты

Media Types: "application/vnd.mapbox-vector-tile", "application/json"

Headers

  • Content-Type: string
Other Status Codes

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

Media Types: "application/vnd.mapbox-vector-tile", "application/json"

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

AADToken

Это Azure Active Directory потоки OAuth2. При связывании с управлением доступом на основе ролей 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

Примеры

Successful State Tile Request

Sample Request

GET https://atlas.microsoft.com/map/statetile?api-version=1.0&zoom=6&x=10&y=22&statesetId=[statesetId]

Sample Response

Status code:
200 
Content-Type: application/vnd.mapbox-vector-tile
Response Body
"{file}"

Определения

ErrorAdditionalInfo

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

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

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

ErrorAdditionalInfo

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

Name Type Description
info
  • object

Дополнительные сведения.
type
  • string

Дополнительный тип сведений.

ErrorDetail

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

Name Type Description
additionalInfo

Дополнительные сведения об ошибке.
code
  • string

Код ошибки.
details

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

Сообщение об ошибке.
target
  • string

Целевой объект ошибки.

ErrorResponse

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

Name Type Description
error

Объект ошибки.