Поделиться через

Alias - List

  • Ссылка
Служба:
Maps Creator
Версия API:
2.0

Используйте для получения списка псевдонимов.

List API — это HTTP-запросGET, который позволяет вызывающей объекту получить список всех существующих псевдонимов.

Запрос на отправку списка

Чтобы получить список всех псевдонимов, вы выполните GET запрос без дополнительных параметров.

Вывод списка ответов на данные

API списка возвращает полный список всех псевдонимов в json формате. Ответ содержит следующие сведения для каждого ресурса псевдонима:

createdTimestamp — метка времени создания псевдонима. Формат yyyy-MM-ddTHH:mm:ss.sssZ aliasId — идентификатор псевдонима. creatorDataItemId — идентификатор элемента данных создателя, на который ссылается этот псевдоним (может иметь значение NULL, если псевдоним не был назначен). lastUpdatedTimestamp — время последнего назначения псевдонима ресурсу. Формат гггг-ММ-ддTHЧ:мм:сс.ссZ

Пример ответа, возвращающего 2 псевдонима ресурсов:

{
  "aliases": [
    {
      "createdTimestamp": "2020-02-13T21:19:11.123Z",
      "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
      "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
      "lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z"
    },
    {
      "createdTimestamp": "2020-02-18T19:53:33.123Z",
      "aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6",
      "creatorDataItemId": null,
      "lastUpdatedTimestamp": "2020-02-18T19:53:33.123Z"
    }
  ]
}

GET https://{geography}.atlas.microsoft.com/aliases?api-version=2.0

Параметры URI

Имя В Обязательно Тип Описание
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

AliasListResult

Запрос псевдонима списка успешно завершен. Текст ответа содержит список всех ранее созданных псевдонимов.
Other Status Codes

ErrorResponse

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

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

AADToken

Это Microsoft Entra потоков OAuth 2.0. В сочетании с управлением доступом на основе ролей 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 позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

  • Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.

Тип: 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, пакетов AZURE SDK или REST API.

С помощью этого ключа любое приложение может получить доступ ко всем REST API. Иными словами, этот ключ можно использовать в качестве ключа master в учетной записи, в которую они выдаются.

Для общедоступных приложений мы рекомендуем использовать подход конфиденциальных клиентских приложений для доступа к Azure Maps REST API, чтобы ключ можно было безопасно хранить.

Тип: apiKey
В: query

SAS Token

Этот маркер подписанного URL-адреса создается из операции List SAS в ресурсе Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов использования конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи сопоставления , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Тип: apiKey
В: header

Примеры

List all the previously created aliases

Образец запроса

GET https://us.atlas.microsoft.com/aliases?api-version=2.0

Пример ответа

Код состояния:
200 
{
  "aliases": [
    {
      "createdTimestamp": "2020-02-13T21:19:11+00:00",
      "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
      "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
      "lastUpdatedTimestamp": "2020-02-13T21:19:22+00:00"
    },
    {
      "createdTimestamp": "2020-02-13T21:19:11+00:00",
      "aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6",
      "creatorDataItemId": null,
      "lastUpdatedTimestamp": "2020-02-13T21:19:11+00:00"
    }
  ]
}

Определения

Имя Описание
Alias

Подробные сведения о псевдониме.
AliasListResult

Модель ответа для API списка. Возвращает список всех ранее созданных псевдонимов.
ErrorAdditionalInfo

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

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

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

Alias

Подробные сведения о псевдониме.

Имя Тип Описание
aliasId

string

Идентификатор псевдонима.
createdTimestamp

string

Созданная метка времени для псевдонима.
creatorDataItemId

string

Идентификатор элемента данных создателя, на который ссылается этот псевдоним (может иметь значение NULL, если псевдоним не был назначен).
lastUpdatedTimestamp

string

Метка времени последнего назначения псевдонима.

AliasListResult

Модель ответа для API списка. Возвращает список всех ранее созданных псевдонимов.

Имя Тип Описание
aliases

Alias[]

Список всех ранее созданных псевдонимов.
nextLink

string

При наличии — расположение следующей страницы данных.

ErrorAdditionalInfo

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

Имя Тип Описание
info

object

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

string

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

ErrorDetail

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

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

string

Код ошибки.
details

ErrorDetail[]

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

string

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

string

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

ErrorResponse

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

Имя Тип Описание
error

ErrorDetail

Объект error.