Feature State - List States

Ссылка

Служба:: Maps Creator

Версия API:: 2.0

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

Примечание

Прекращение поддержки службы состояния компонентов Azure Maps Creator

Служба состояния компонентов Azure Maps Creator теперь является устаревшей и будет прекращена 31.03.25. Чтобы избежать перебоев в работе служб, прекратите использование служб состояния компонентов до 31.03.25. Сведения о стиле функций в режиме реального времени в Creator см. в статье Улучшение схемы помещений с помощью стиля функций карт в режиме реального времени.

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

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

GET https://{geography}.atlas.microsoft.com/featureStateSets/{statesetId}/featureStates/{featureId}?api-version=2.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
featureId	path	True	string	Идентификатор компонента в заданном наборе состояний. Если для featureId в наборе состояний ранее не было задано состояние, будет возвращен ответ "Неправильный запрос".
geography	path	True	string	Этот параметр указывает, где находится ресурс Azure Maps Creator. Допустимые значения: us и eu.
statesetId	path	True	string	Созданный идентификатор набора состояний.
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	FeatureStatesStructure	Получение запроса успешно завершено.
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-адреса авторизации и конфигурации 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	https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, который подготавливается при Create учетной записи 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

Примеры

Get the current states of a feature

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

HTTP

GET https://us.atlas.microsoft.com/featureStateSets/b24bdb73-1305-3212-1909-a428d937b64/featureStates/SPC4709?api-version=2.0

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

Код состояния:: 200

{
  "states": [
    {
      "keyName": "s1",
      "value": "true",
      "eventTimestamp": "2019-08-16 13:01"
    }
  ]
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
FeatureState	Модель состояния с одним признаком.
FeatureStatesStructure	Модель состояний признаков для компонента.

ErrorAdditionalInfo

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

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

Имя	Тип	Описание
error	ErrorDetail	Объект error.

FeatureState

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

Имя	Тип	Описание
eventTimestamp	string	Допустимая метка времени, когда было записано состояние функции.
keyName	string	Имя ключа состояния компонента. Максимально допустимая длина — 1000.
value	string	Значение для состояния функции. Тип должен соответствовать определению стиля, присоединенному к таблице признаков. Максимальная длина строкового типа — 1024.

FeatureStatesStructure

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

Имя	Тип	Описание
states	FeatureState[]	Массив состояний признаков.

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