Render - Get Map State Tile
Используйте для получения плиток состояния в векторном формате, который затем можно использовать для отображения сведений о состоянии функции в схеме помещений.
Извлекает плитки состояния в векторном формате, как правило, интегрируется в модуль управления картами или пакета SDK для помещений. Элемент управления картой вызовет этот API после включения динамической стилизации пользователем. Дополнительные сведения см. в уровнях масштабирования исетки плиток.
GET {endpoint}/map/statetile?api-version=2024-04-01&zoom={zoom}&x={x}&y={y}&statesetId={statesetId}
Параметры URI
| Имя. | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Hostname сервиса Azure Maps. Используйте |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
|
stateset
|
query | True |
string |
Идентификатор набора состояний. |
|
x
|
query | True |
integer (int32) |
Координата X плитки в сетке масштабирования. Значение должно находиться в диапазоне [0, 2 Дополнительные сведения см. в уровнях масштабирования и сетке плиток. |
|
y
|
query | True |
integer (int32) |
Координата Y плитки в сетке масштабирования. Значение должно находиться в диапазоне [0, 2 Дополнительные сведения см. в уровнях масштабирования и сетке плиток. |
|
zoom
|
query | True |
integer (int32) |
Уровень масштабирования для требуемой плитки. Дополнительные сведения см. в уровнях масштабирования и сетке плиток. |
Заголовок запроса
| Имя. | Обязательно | Тип | Описание |
|---|---|---|---|
| x-ms-client-id |
string |
Указывает аккаунт, предназначенный для использования с моделью безопасности Microsoft Entra ID. Этот уникальный идентификатор для Azure Maps аккаунта можно получить с управляющего плана Azure Maps Account API. Для получения дополнительной информации об использовании Microsoft Entra ID безопасности в Azure Maps см. раздел Управление аутентификацией в Azure Maps. |
Ответы
| Имя. | Тип | Описание |
|---|---|---|
| 200 OK |
string |
Запрос выполнен успешно. Media Types: "application/json", "application/vnd.mapbox-vector-tile" |
| Other Status Codes |
Непредвиденное сообщение об ошибке. Media Types: "application/json", "application/vnd.mapbox-vector-tile" |
Безопасность
AadToken
Это Microsoft Entra OAuth 2.0 потоки. В сочетании с управлением Azure ролевым доступом он может использоваться для управления доступом к Azure Maps REST API. Ролевые контроли доступа Azure используются для обозначения доступа к одной или нескольким учетной записи ресурсов или подресурсам Azure Maps. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для REST API Azure Maps.
Для реализации сценариев рекомендуется просматривать концепции проверки подлинности . В целом, это определение безопасности предоставляет решение для моделирования приложений через объекты, способные управлять доступом в определенных API и областях.
Note
- Для этого определения безопасности требуется использовать заголовок
x-ms-client-id, чтобы указать, к какой ресурсу Azure Maps приложение запрашивает доступ. Это можно получить изAPI управления картами. -
Authorization URLзависит от экземпляра общедоступного облака Azure. Облака Sovereign имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. - Управление доступом на основе ролей Azure настраивается на основе плоскости управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
- Использование веб-пакета SDK для Azure Maps
позволяет настроить приложение на основе конфигурации для нескольких вариантов использования. - Дополнительные сведения о платформе удостоверений Майкрософт см. в обзоре платформы удостоверений Майкрософт.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя. | Описание |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Это общий ключ, подготовленный при создания учетной записи Azure Maps на портале Azure или с помощью PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого ключа любой приложение может получить доступ ко всем REST API. Другими словами, этот ключ можно использовать в качестве главного ключа в учетной записи, в которую они выданы.
Для общедоступных приложений мы рекомендуем использовать конфиденциальные клиентские приложения, подход для доступа к REST API Azure Maps, чтобы ваш ключ можно было безопасно хранить.
Тип:
apiKey
В:
header
SAS Token
Это маркер подписанного URL-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого маркера любой приложению разрешен доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Другими словами, маркер SAS можно использовать для разрешения приложений управлять доступом более защищенным способом, чем общий ключ.
Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты карты, чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.
Тип:
apiKey
В:
header
Примеры
Successful State Tile Request
Образец запроса
GET https://atlas.microsoft.com/map/statetile?api-version=2024-04-01&zoom=6&x=10&y=22&statesetId=[statesetId]
Пример ответа
Content-Type: application/vnd.mapbox-vector-tile
"{file}"
Определения
| Имя. | Описание |
|---|---|
|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
|
Error |
Сведения об ошибке. |
|
Error |
Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа об ошибках OData.). |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
| Имя. | Тип | Описание |
|---|---|---|
| info |
Дополнительные сведения. |
|
| type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
| Имя. | Тип | Описание |
|---|---|---|
| additionalInfo |
Дополнительные сведения об ошибке. |
|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке. |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект ошибки. |
ErrorResponse
Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа об ошибках OData.).
| Имя. | Тип | Описание |
|---|---|---|
| error |
Объект ошибки. |