Partager via

Définition de bibliothèque de variables

Cet article fournit une répartition de la structure de définition pour les éléments de bibliothèque de variables.

Parties de définition

Ce tableau répertorie les parties de définition de bibliothèque de variables.

Chemin d’accès du composant Définition type Obligatoire Description
variables.json Variables (JSON) ✅ Décrit les variables dans l’élément
settings.json VariableLibrarySettings (JSON) ✅ Définir les paramètres contrôlés par l’utilisateur
.platform PlatformDetails (JSON) ❌ Décrit les détails courants de l’élément
valueSets\valueSetName.json ValueSet (JSON) ❌ Définir le modèle par défaut à utiliser lors du rendu de l’élément

Variables

Décrit les variables d’un élément de bibliothèque de variables.

Nom Catégorie Description
Variables Variable[] Collection de variables.

Variable

Décrit une variable.

Nom Catégorie Obligatoire Description
nom Chaîne ✅ Nom de la variable.
type Chaîne ✅ Type de variable.
valeur JSON ✅ Valeur par défaut de la variable.
note Chaîne ❌ Remarque décrivant la variable.

Types de variables pris en charge

Liste des types de variables pris en charge.

Nom Catégorie Exemple :
Booléen BooleanVariable true, false
Date et heure DateTimeVariable « 2025-01-20T15:30:00Z »
Numéro NumberVariable 1.1
Nombre entier IntegerVariable 1
Chaîne StringVariable « Some string »

exemple de 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

Décrit un jeu de valeurs. Le nom de fichier doit être similaire au nom du jeu de valeurs.

Nom Catégorie Description
nom Chaîne Nom du jeu de valeurs.
description Chaîne Description du jeu de valeurs.
variableOverrides VariableOverride Liste des variables substituées.

VariableOverride

Décrit une substitution de valeur.

Nom Catégorie Description
nom Chaîne Nom de la variable substituée.
valeur Chaîne Nouvelle valeur de variable.

valueSets/valueSet.json exemple 

{
  "$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

Décrit les paramètres de bibliothèque de variables définis par l’utilisateur.

Nom Catégorie Description
valueSetsOrder String[] Liste facultative des noms des ensembles de valeurs pour l’ordre.

exemple de settings.json 

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

Considérations et limitations

  • La liste ValueSetsOrder peut être vide ou partielle.
  • La liste ValueSetsOrder ne peut pas inclure de noms de jeux de valeurs non valides.
  • Lors de la mise à jour d’un élément de bibliothèque de variables avec une liste valueSetsOrder partielle ou vide, les noms de jeux de valeurs manquants sont ajoutés à la fin de la liste par ordre alphabétique.

Exemple de définition

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