変数ライブラリの定義

この記事では、変数ライブラリ項目の定義構造の詳細について説明します。

定義パーツ

次の表に、変数ライブラリ定義パーツの一覧を示します。

定義パーツのパス 型 必須 説明
variables.json 変数 (JSON) ✅ 項目内の変数について説明します
settings.json VariableLibrarySettings (JSON) ✅ ユーザーが制御する設定を定義する
.platform PlatformDetails (JSON) ❌ アイテムの一般的な詳細について説明します
valueSets\valueSetName.json ValueSet (JSON) ❌ アイテムのレンダリング時に使用する既定のテンプレートを定義する

変数

変数ライブラリ項目の変数について説明します。

名前 タイプ 説明
変数 Variable[] 変数コレクション。

変数

変数について説明します。

名前 タイプ 必須 説明
名前 糸 ✅ 変数の名前。
型 糸 ✅ 変数の型。
価値 JSON ✅ 変数の既定値。
手記 糸 ❌ 変数を説明するメモ。

サポートされている変数型

サポートされている変数型の一覧。

名前 タイプ 例
ブール値 BooleanVariable 真、偽
日付と時間 DateTimeVariable "2025-01-20T15:30:00Z"
番号 NumberVariable 1.1
整数 IntegerVariable 1
糸 StringVariable "Some string"
ItemReference ItemReferenceVariable
{
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbb",
  "itemId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
}

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