Определение библиотеки переменных

В этой статье приводится разбивка структуры определения для элементов библиотеки переменных.

Части определения

В этой таблице перечислены части определения библиотеки переменных.

Путь к части определения тип Обязательно Описание
variables.json Переменные (JSON) ✅ Описание переменных в элементе
settings.json VariableLibrarySettings (JSON) ✅ Определение управляемых пользователем параметров
.platform PlatformDetails (JSON) ❌ Описание общих сведений об элементе
valueSets\valueSetName.json ValueSet (JSON) ❌ Определение шаблона по умолчанию для использования при отрисовке элемента

Переменные

Описывает переменные в элементе библиотеки переменных.

Имя Тип Описание
Переменные Переменная[] Коллекция переменных.

Переменная

Описывает переменную.

Имя Тип Обязательно Описание
имя Струна ✅ Имя переменной.
тип Струна ✅ Тип переменной.
ценность JSON (JavaScript Object Notation) ✅ Значение переменной по умолчанию.
заметка Струна ❌ Примечание, описывающее переменную.

Поддерживаемые типы переменных

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

Имя Тип Пример
булевый BooleanVariable истина, ложь
дата и время DateTimeVariable "2025-01-20T15:30:00Z"
Номер NumberVariable 1.1
Целое число ЦелочисленноеVariable 1
Струна StringVariable "Некоторая строка"
ItemReference ItemReferenceVariable
{
  "workspaceId": "aaaa-0000-1111-2222-bbbb",
  "itemId": "bbbbbbbb-1111-2222-3333-cccccccccc"
}

пример Variables.json 

{
  "$schema": "https://developer.microsoft.com/json-schemas/fabric/item/variableLibrary/definition/variables/1.0.0/schema.json",
  "variables": [
    {
      "name": "variable1",
      "note": "Some optional note",
      "type": "String",
      "value": "Some string value"
    },
    {
      "name": "variableWithoutNote",
      "type": "boolean",
      "value": true
    }
  ]
}

ValueSet

Описывает набор значений. Имя файла должно совпадать с именем набора значений.

Имя Тип Описание
имя Струна Имя набора значений.
описание Струна Описание набора значений.
variableOverrides VariableOverride Список переопределенных переменных.

VariableOverride

Описывает переопределение значения.

Имя Тип Описание
имя Струна Имя переопределенной переменной.
ценность Струна Новое значение переменной.

Пример valueSets/valueSet.json 

{
  "$schema": "https://developer.microsoft.com/json-schemas/fabric/item/variableLibrary/definition/valueSet/1.0.0/schema.json",
  "name": "valueSetName",
  "variableOverrides": [
    {
      "name": "variable1",
      "value": "Some new value"
    }
  ]
}

VariableLibrarySettings

Описание параметров определяемой пользователем библиотеки переменных.

Имя Тип Описание
valueSetsOrder String[] Необязательный список имен наборов значений для упорядочивания.

пример settings.json 

{
  "$schema": "https://developer.microsoft.com/json-schemas/fabric/item/variableLibrary/definition/settings/1.0.0/schema.json",
  "valueSetsOrder": [
    "valueSet1",
    "valueSet0",
    "someOtherValueSet"
  ]
}

Рекомендации и ограничения

  • Список ValueSetsOrder может быть пустым или частичным.
  • Список ValueSetsOrder не может содержать недопустимые имена наборов значений.
  • При обновлении элемента библиотеки переменных с частичным или пустым списком valueSetsOrder отсутствующие имена наборов значений добавляются в конец списка в алфавитном порядке.

Пример определения

{
"parts": [
    {
        "path": "variables.json",
        "payload": "<base64 encoded string>",
        "payloadType": "InlineBase64"
    },
    {
        "path": "valueSet/valueSet1.json",
        "payload": "<base64 encoded string>",
        "payloadType": "InlineBase64"
    },
    {
        "path": "valueSet/valueSet2.json",
        "payload": "<base64 encoded string>",
        "payloadType": "InlineBase64"
    },
    {
        "path": "settings.json",
        "payload": "<base64 encoded string>",
        "payloadType": "InlineBase64"
    },
    {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
    }
]
}
  • Last updated on