Feature State - Create Stateset

Ссылка

Service:: Maps Creator

API Version:: 2.0

Используйте для создания нового набора состояний.

Create Stateset API — это HTTP-запросPOST, используемый для создания нового набора состояний, определяющий значения и соответствующие стили для его свойств в тексте запроса. Дополнительные сведения см. в статье Создание набора состояний функции.

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

Эта служба состояния компонентов сведена к набору состояний. Как и набор плиток, набор состояний инкапсулирует механизм хранения состояний признаков для набора данных.

После создания набора состояний пользователи могут использовать его statesetId для публикации обновлений состояния компонентов и получения текущих состояний компонентов. Компонент может иметь только одно состояние в определенный момент времени.

Состояние компонента определяется именем ключа, значением и меткой времени. При публикации обновления состояния компонентов в Azure Maps значение состояния обновляется только в том случае, если метка времени указанного состояния позже сохраненной метки времени.

Azure Maps MapControl предоставляет способ использования этих состояний функций для оформления функций. Дополнительные сведения см. на плитке "Получить состояние карты" в службах отрисовки.

POST https://{geography}.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId={datasetId}

With optional parameters:

POST https://{geography}.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId={datasetId}&description={description}

Параметры URI

Имя	В	Обязательно	Тип	Описание
geography	path	True	string	Этот параметр указывает, где находится ресурс Azure Maps Creator. Допустимые значения: us и eu.
api-version	query	True	string	Номер версии API Azure Maps
datasetId	query	True	string	DatasetId должен быть получен из успешного вызова API создания набора данных .
description	query		string	Описание набора состояний. Максимальная допустимая длина — 1000.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.

Текст запроса

Имя	Тип	Описание
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Массив правил стиля набора состояний. Правило стиля может быть числовым, строковым или логическим правилом стиля типа. См. здесь определения NumberRule, StringRule и BooleanRule.

Ответы

Имя	Тип	Описание
200 OK	StatesetCreatedResult	Создан набор состояний.
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 позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

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

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 или с помощью 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 можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

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

Type: apiKey
In: header

Примеры

Create a new stateset with a datasetId

Sample Request

HTTP

POST https://us.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId=5d34fbe8-87b7-f7c0-3144-c50e003a3c75&description=Stateset for Azure Maps POC.

{
  "styles": [
    {
      "keyName": "s1",
      "type": "boolean",
      "rules": [
        {
          "true": "#FF0000",
          "false": "#00FF00"
        }
      ]
    },
    {
      "keyName": "s2",
      "type": "number",
      "rules": [
        {
          "range": {
            "exclusiveMaximum": "50"
          },
          "color": "#343deb"
        },
        {
          "range": {
            "minimum": "50",
            "exclusiveMaximum": "70"
          },
          "color": "#34ebb1"
        },
        {
          "range": {
            "minimum": "70",
            "exclusiveMaximum": "90"
          },
          "color": "#eba834"
        },
        {
          "range": {
            "minimum": "90"
          },
          "color": "#eb3434"
        }
      ]
    },
    {
      "keyName": "s3",
      "type": "string",
      "rules": [
        {
          "stateValue1": "#FF0000",
          "stateValue2": "#FF00AA",
          "stateValueN": "#00FF00"
        }
      ]
    }
  ]
}

Sample Response

Status code:: 200

{
  "statesetId": "b24bdb73-1305-3212-1909-a428d937b64f"
}

Определения

Имя	Описание
BooleanRule	Логическое правило. Цвет выбирается на основе значения логики ключа.
BooleanStyleRule	Объект правила стиля логического типа.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
NumberRule	Числовое правило. Цвет выбирается из первого диапазона, в который он попадает.
NumberStyleRule	Объект правила стиля числового типа.
Range	Диапазон числовых значений для этого правила стиля. Если значение находится в диапазоне, все условия должны иметь значение true.
StatesetCreatedResult	Модель ответа для успешного СОЗДАНИЯ НАБОРА состояний API.
StringStyleRule	Объект правила стиля строкового типа.
StyleRules	Модель стилей.

BooleanRule

Логическое правило. Цвет выбирается на основе значения логики ключа.

Имя	Тип	Описание
false	string	Цвет, если значение равно false. Color — это строка JSON в различных разрешенных форматах, шестнадцатеричные значения в формате HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)") и HSLA("hsla(100, 50%, 1)"). Также разрешены предопределенные имена цветов HTML, такие как желтый и синий.
true	string	Цвет, если значение равно true. Color — это строка JSON в различных разрешенных форматах, шестнадцатеричные значения в формате HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)") и HSLA("hsla(100, 50%, 1)"). Также разрешены предопределенные имена цветов HTML, такие как желтый и синий.

BooleanStyleRule

Объект правила стиля логического типа.

Имя	Тип	Описание
keyName	string	Имя ключа стиля набора состояний. Имена ключей — это случайные строки, но они должны быть уникальными внутри массива стилей.
rules	BooleanRule[]	Правила логического стиля.
type	string: boolean	Тип стиля набора состояний.

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

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

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

NumberRule

Числовое правило. Цвет выбирается из первого диапазона, в который он попадает.

Имя	Тип	Описание
color	string	Цвет, когда значение находится в диапазоне. Color — это строка JSON в различных разрешенных форматах, шестнадцатеричные значения в формате HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)") и HSLA("hsla(100, 50%, 1)"). Также разрешены предопределенные имена цветов HTML, такие как желтый и синий.
range	Range	Диапазон числовых значений для этого правила стиля. Если значение находится в диапазоне, все условия должны иметь значение true.

NumberStyleRule

Объект правила стиля числового типа.

Имя	Тип	Описание
keyName	string	Имя ключа стиля набора состояний. Имена ключей — это случайные строки, но они должны быть уникальными внутри массива стилей.
rules	NumberRule[]	Правила числового стиля.
type	string: number	Тип стиля набора состояний.

Range

Диапазон числовых значений для этого правила стиля. Если значение находится в диапазоне, все условия должны иметь значение true.

Имя	Тип	Описание
exclusiveMaximum	string	Все число x, что x < exclusiveMaximum.
exclusiveMinimum	string	Все число x, что x > exclusiveMinimum.
maximum	string	Все число x, которое x ≤ максимальное.
minimum	string	Все число x, которое x ≥ минимальное.

StatesetCreatedResult

Модель ответа для успешного СОЗДАНИЯ НАБОРА состояний API.

Имя	Тип	Описание
statesetId	string	Идентификатор созданного набора состояний.

StringStyleRule

Объект правила стиля строкового типа.

Имя	Тип	Описание
keyName	string	Имя ключа стиля набора состояний. Имена ключей — это случайные строки, но они должны быть уникальными внутри массива стилей.
rules	object[]	Правила стиля строк.
type	string: string	Тип стиля набора состояний.

StyleRules

Модель стилей.

Имя	Тип	Описание
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Массив правил стиля набора состояний. Правило стиля может быть числовым, строковым или логическим правилом стиля типа. См. здесь определения NumberRule, StringRule и BooleanRule.