Conversion - List
Используется для получения списка преобразований данных.
Примечание.
Выход на пенсию создателя Azure Maps
Служба azure Maps Creator в помещении теперь устарела и будет прекращена 9.30.25. Дополнительные сведения см. в разделе "Завершение жизни" создателя Azure Maps.
API List
— это http-запрос GET
, позволяющий вызывающей службе получить список всех успешных преобразований данных, отправленных ранее с помощью API преобразования преобразования.
Отправка запроса списка
Чтобы вывести список всех успешных преобразований, вы получите запрос GET
без дополнительных параметров.
Вывод списка ответов на данные
API списка преобразований возвращает полный список всех сведений о преобразовании в json
формате.
Ниже приведен пример ответа, возвращающий сведения о двух успешных запросах на преобразование:
{
"conversions":
[
{
"conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d",
"udid": "31838736-8b84-11ea-bc55-0242ac130003",
"created": "5/19/2020 9:00:00 AM +00:00",
"description": "User provided description.",
"featureCounts": {
"DIR": 1,
"LVL": 3,
"FCL": 1,
"UNIT": 150,
"CTG": 8,
"AEL": 0,
"OPN": 10
}
},
{
"conversionId": "2acf7d32-8b84-11ea-bc55-0242ac130003",
"udid": "1214bc58-8b84-11ea-bc55-0242ac1300039",
"created": "5/19/2020 9:00:00 AM +00:00",
"description": "User provided description.",
"featureCounts": {
"DIR": 1,
"LVL": 3,
"FCL": 1,
"UNIT": 150,
"CTG": 8,
"AEL": 0,
"OPN": 10
}
}
]
}
GET https://{geography}.atlas.microsoft.com/conversions?api-version=2.0
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
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
Примеры
Returns a list of all the data processed by the Conversion Service for the account
Образец запроса
GET https://us.atlas.microsoft.com/conversions?api-version=2.0
Пример ответа
{
"conversions": [
{
"conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d",
"udid": "31838736-8b84-11ea-bc55-0242ac130003",
"created": "5/19/2020 9:00:00 AM +00:00",
"description": "User provided description.",
"ontology": "facility-2.0",
"featureCounts": {
"directoryInfo": 1,
"level": 3,
"facility": 1,
"unit": 150,
"category": 8,
"areaElement": 0,
"opening": 10
}
},
{
"conversionId": "2acf7d32-8b84-11ea-bc55-0242ac130003",
"udid": "1214bc58-8b84-11ea-bc55-0242ac1300039",
"created": "5/20/2020 11:30:00 AM +00:00",
"description": "User provided description.",
"ontology": "facility-2.0",
"featureCounts": {
"structure": 614,
"directoryInfo": 1,
"level": 2,
"facility": 1,
"unit": 461,
"category": 30,
"verticalPenetration": 8,
"opening": 270
}
}
]
}
Определения
Имя | Описание |
---|---|
Conversion |
Подробные сведения о запросах на преобразование. |
Conversion |
Модель ответа для API списка преобразований. |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Ответ на ошибку |
Conversion
Подробные сведения о запросах на преобразование.
Имя | Тип | Описание |
---|---|---|
conversionId |
string |
Уникальный идентификатор, представляющий артефакт успешно завершенного процесса преобразования. |
created |
string |
Дата и время этого преобразования. |
description |
string |
Пользователь предоставил описание преобразованного содержимого. |
featureCounts |
object |
Сводка счетчиков функций в этом преобразовании. |
ontology |
string |
Версия ontology этого набора данных. |
udid |
string |
Уникальный идентификатор содержимого, предоставленного для создания этого преобразования. |
ConversionListResult
Модель ответа для API списка преобразований.
Имя | Тип | Описание |
---|---|---|
conversions |
Список всех ранее отправленных запросов на преобразование. |
|
nextLink |
string |
Если он присутствует, расположение следующей страницы данных. |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Ответ на ошибку
Имя | Тип | Описание |
---|---|---|
error |
Объект ошибки. |