WFS - Get Landing Page
Используется для получения ссылок на определение API, инструкции соответствия и метаданные о коллекции компонентов.
Примечание.
Выход на пенсию создателя Azure Maps
Служба azure Maps Creator в помещении теперь устарела и будет прекращена 9.30.25. Дополнительные сведения см. в разделе "Завершение жизни" создателя Azure Maps.
API Get Landing Page
— это запрос HTTP GET
, который предоставляет ссылки на определение API, инструкции соответствия и метаданные о коллекциях компонентов в указанном наборе данных.
API WFS следует стандарту API открытого геопространственного консорциума для функций для запроса наборов данных.
Набор данных состоит из нескольких коллекций компонентов. Коллекция признаков — это коллекция признаков аналогичного типа, основанная на общей схеме.
Отправка запроса целевой страницы
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/?api-version=2.0
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
dataset
|
path | True |
string |
Идентификатор набора данных для запроса. |
geography
|
path | True |
string |
Этот параметр указывает расположение ресурса Создателя Azure Maps. Допустимые значения являются нами и eu. |
api-version
|
query | True |
string |
Номер версии API Azure Maps. |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
x-ms-client-id |
string |
Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности идентификатора Microsoft Entra. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Сведения о том, как использовать безопасность идентификатора Microsoft Entra в Azure Maps, см. в следующих статьях |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Хорошо |
|
Other Status Codes |
Произошла непредвиденная ошибка. |
Безопасность
AADToken
Это потоки Microsoft Entra OAuth 2.0. При паре с доступом на основе ролей Azure его можно использовать для управления доступом к REST API Azure Maps. Управление доступом на основе ролей Azure используется для назначения доступа к одной или нескольким учетным записям ресурсов Azure Maps или вложенным ресурсам. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для REST API Azure Maps.
Для реализации сценариев рекомендуется просматривать концепции проверки подлинности . В целом, это определение безопасности предоставляет решение для моделирования приложений через объекты, способные управлять доступом в определенных API и областях.
Примечания.
- Для этого определения безопасности требуется использовать заголовок
x-ms-client-id
, чтобы указать, к какой ресурсу Azure Maps приложение запрашивает доступ. Это можно получить изAPI управления картами.
Authorization URL
зависит от экземпляра общедоступного облака Azure. В национальных облаках есть уникальные URL-адреса авторизации и конфигурации идентификатора Microsoft Entra.
* Управление доступом на основе ролей 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 | https://atlas.microsoft.com/.default |
subscription-key
Это общий ключ, подготовленный при создания учетной записи Azure Maps на портале Azure или с помощью PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого ключа любой приложение может получить доступ ко всем REST API. Другими словами, этот ключ можно использовать в качестве главного ключа в учетной записи, в которую они выданы.
Для общедоступных приложений мы рекомендуем использовать конфиденциальные клиентские приложения, подход для доступа к REST API Azure Maps, чтобы ваш ключ можно было безопасно хранить.
Тип:
apiKey
В:
query
SAS Token
Это маркер подписанного URL-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого маркера любой приложению разрешен доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Другими словами, маркер SAS можно использовать для разрешения приложений управлять доступом более защищенным способом, чем общий ключ.
Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты карты, чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.
Тип:
apiKey
В:
header
Примеры
GetLandingPage
Образец запроса
GET https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/?api-version=2.0
Пример ответа
{
"ontology": "Facility-2.0",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4",
"rel": "self",
"title": "Azure Maps WFS"
},
{
"href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/api",
"rel": "service",
"title": "The API definition"
},
{
"href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/conformance",
"rel": "conformance",
"title": "WFS 3.0 conformance classes implemented by this server"
},
{
"href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/version",
"rel": "data",
"title": "The version information"
},
{
"href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections",
"rel": "data",
"title": "Metadata about the feature collections"
}
]
}
Определения
Имя | Описание |
---|---|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Ответ на ошибку |
Landing |
|
WFSEndpoint |
Ссылки на другие конечные точки WFS |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Ответ на ошибку
Имя | Тип | Описание |
---|---|---|
error |
Объект ошибки. |
LandingPageResult
Имя | Тип | Описание |
---|---|---|
links |
Ссылки на другие конечные точки WFS. |
|
ontology |
string |
Версия ontology этого набора данных. |
WFSEndpointLink
Ссылки на другие конечные точки WFS
Имя | Тип | Описание |
---|---|---|
href |
string |
Целевой объект ссылки. |
hreflang |
string |
Указание, указывающее, какой язык результата расшифровки ссылки должен быть. |
rel |
string |
Тип отношения. |
title |
string |
Используется для метки назначения ссылки, чтобы ее можно было использовать в качестве удобочитаемого идентификатора (например, записи меню) на языке, указанном полем заголовка Content-Language (при наличии). |
type |
string |
Указание, указывающее тип носителя результата расшифровки ссылки. |