變數連結庫定義

本文提供變數連結庫專案定義結構明細。

定義元件

下表列出變數連結庫定義元件。

定義元件路徑	類型	為必填項目	說明
variables.json	變數 （JSON）	✅	描述專案中的變數
settings.json	VariableLibrarySettings （JSON）	✅	定義使用者控制設定
.platform	PlatformDetails （JSON）	❌	描述項目的常見詳細數據
valueSets\valueSetName.json	ValueSet （JSON）	❌	定義轉譯專案時要使用的預設範本

變數

描述變數連結庫專案中的變數。

名稱	類型	說明
變數	Variable[]	variables 集合。

變數

描述變數。

名稱	類型	為必填項目	說明
名稱	繩子	✅	變數的名稱。
類型	繩子	✅	變數類型。
價值	JSON（JavaScript物件標記法）	✅	變數的預設值。
注意	繩子	❌	描述變數的附註。

支援的變數類型

支援的變數類型清單。

名稱	類型	範例
布爾邏輯	BooleanVariable	真、假
日期時間	DateTimeVariable	“2025-01-20T15：30：00Z”
數目	NumberVariable	1.1
整數	IntegerVariable	1
繩子	StringVariable	“Some string”
ItemReference	ItemReferenceVariable	{   “workspaceId”： “aaaaaaaaaa-0000-1111-2222-bbbbbbbb”，   “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 清單不能包含無效的值集名稱。
• 以部分或空白值SetsOrder 清單更新變數連結庫專案時，遺漏的值集名稱會依字母順序新增至清單結尾。

定義範例

{
"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"
    }
]
}