ข้อกําหนดไลบรารีตัวแปร

บทความนี้มีการแบ่งย่อยของโครงสร้างข้อกําหนดสําหรับรายการไลบรารีตัวแปร

ส่วนคําจํากัดความ

ตารางนี้แสดงรายการส่วนข้อกําหนดไลบรารีตัวแปร

เส้นทางของส่วนข้อกําหนด ชนิด ต้องระบุ คำอธิบาย
variables.json ตัวแปร (JSON) ✅ อธิบายตัวแปรต่าง ๆ ในหน่วยข้อมูล
settings.json VariableLibrarySettings (JSON) ✅ กําหนดการตั้งค่าที่ควบคุมโดยผู้ใช้
.platform PlatformDetails (JSON) ❌ อธิบายรายละเอียดทั่วไปของรายการ
valueSets\valueSetName.json ValueSet (JSON) ❌ กําหนดเทมเพลตเริ่มต้นที่จะใช้เมื่อแสดงรายการ

ตัว แปร

อธิบายตัวแปรในรายการไลบรารีตัวแปร

Name ประเภท คำอธิบาย
ตัว แปร Variable[] คอลเลกชันตัวแปร

ตัวแปร

อธิบายตัวแปร

Name ประเภท ต้องระบุ คำอธิบาย
ชื่อ เชือก ✅ ชื่อของตัวแปร
ชนิด เชือก ✅ ชนิดตัวแปร
ค่า JSON ✅ ค่าเริ่มต้นของตัวแปร
โน้ต เชือก ❌ หมายเหตุที่อธิบายตัวแปร

ชนิดตัวแปรที่สนับสนุน

รายการของชนิดตัวแปรที่สนับสนุน

Name ประเภท ตัวอย่าง
แบบบูลีน บูลีนวาเรียล จริง, เท็จ
วันที่เวลา DateTimeVariable "2025-01-20T15:30:00Z"
หมายเลข NumberVariable 1.1
จำนวนเต็ม IntegerVariable 1
เชือก StringVariable "บางสตริง"
ItemReference ItemReferenceVariable
{
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbb",
  "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

อธิบายชุดค่า ชื่อไฟล์ต้องคล้ายกับชื่อชุดค่า

Name ประเภท คำอธิบาย
ชื่อ เชือก ชื่อของชุดค่า
คำอธิบาย เชือก คําอธิบายเกี่ยวกับชุดค่า
variableOverrides VariableOverride รายการของตัวแปรที่แทนที่

VariableOverride

อธิบายการแทนที่ค่า

Name ประเภท คำอธิบาย
ชื่อ เชือก ชื่อของตัวแปรที่แทนที่
ค่า เชือก ค่าตัวแปรใหม่

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

อธิบายการตั้งค่าไลบรารีตัวแปรที่ผู้ใช้กําหนด

Name ประเภท คำอธิบาย
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"
    }
]
}