Features - Get Collection
Используйте для получения сведений о коллекции компонентов.
API функций является частью Creator, которая позволяет разрабатывать приложения на основе данных карты частных помещений с помощью API Azure Maps и пакета SDK. Api-интерфейсы GET функций соответствуют api Open Geospatial Consortium — Features — Part 1: Core corrigendum standard для запроса наборов данных. Наборы данных состоят из нескольких коллекций признаков, которые представляют собой группу признаков , определяемых общей схемой.
Отправка запроса на получение сбора
Get Collection
API — это HTTP-запросGET
, который возвращает сведения о конкретной коллекции компонентов в соответствии с определением , предоставленным collectionId
в указанном наборе данных.
GET https://{geography}.atlas.microsoft.com/features/datasets/{datasetId}/collections/{collectionId}?api-version=2023-03-01-preview
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
collection
|
path | True |
string |
Идентификатор (имя) определенной коллекции. |
dataset
|
path | True |
string |
Идентификатор набора данных для запроса. |
geography
|
path | True |
string |
Этот параметр указывает, где находится ресурс Azure Maps Creator. Допустимые значения: us и eu. |
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 с помощью портал 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
Примеры
GetCollection
Sample Request
GET https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2023-03-01-preview
Sample Response
{
"id": "unit",
"title": "Unit",
"ontology": "facility-2.0",
"itemType": "feature",
"description": "The unit feature class defines a physical and non-overlapping area that can be occupied and traversed by a navigating agent. A unit can be a hallway, a room, a courtyard, and so on.",
"links": [
{
"href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition",
"rel": "describedBy",
"title": "Metadata catalogue for unit"
},
{
"href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items",
"rel": "items",
"title": "Unit"
},
{
"href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit",
"rel": "self",
"title": "Information for unit collection"
}
]
}
Определения
Имя | Описание |
---|---|
Collection |
Ответ после успешного запроса на получение коллекции. |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Сообщение об ошибке |
Features |
Ссылки на другие конечные точки компонентов. Дополнительные сведения о связях см. в стандарте API OGC — функции— часть 1 . |
CollectionResult
Ответ после успешного запроса на получение коллекции.
Имя | Тип | Описание |
---|---|---|
description |
string |
Описание компонентов в коллекции. |
id |
string |
Идентификатор коллекции, используемой, например, в URI. |
itemType |
string |
Тип элементов коллекции. |
links |
Ссылки на другие конечные точки компонентов. |
|
ontology |
string |
Онтологическая версия этого набора данных. |
title |
string |
Понятное название коллекции. |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Тип дополнительных сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Сообщение об ошибке
Имя | Тип | Описание |
---|---|---|
error |
Объект error. |
FeaturesEndpointLink
Ссылки на другие конечные точки компонентов. Дополнительные сведения о связях см. в стандарте API OGC — функции— часть 1 .
Имя | Тип | Описание |
---|---|---|
href |
string |
Целевой объект ссылки. |
rel |
string |
Тип отношения. |
title |
string |
Используется для маркировки назначения ссылки таким образом, чтобы ее можно было использовать в качестве удобочитаемого идентификатора (например, пункта меню) на языке, указанном полем заголовка Content-Language (при наличии). |