Compartilhar via

Definição de biblioteca de variáveis

Este artigo fornece um detalhamento da estrutura de definição para itens de biblioteca de variáveis.

Partes de definição

Esta tabela lista as partes de definição da biblioteca de variáveis.

Caminho da parte de definição tipo Obrigatório Descrição
variables.json Variáveis (JSON) ✅ Descreve as variáveis no item
settings.json VariableLibrarySettings (JSON) ✅ Definir configurações controladas pelo usuário
.platform PlatformDetails (JSON) ❌ Descreve detalhes comuns do item
valueSets\valueSetName.json ValueSet (JSON) ❌ Definir o modelo padrão a ser usado ao renderizar o item

Variáveis

Descreve as variáveis em um item da Biblioteca de Variáveis.

Nome Tipo Descrição
Variáveis Variável[] A coleção de variáveis.

Variável

Descreve uma variável.

Nome Tipo Obrigatório Descrição
nome fio ✅ O nome da variável.
tipo fio ✅ O tipo de variável.
valor JSON ✅ O valor padrão da variável.
nota fio ❌ Uma nota que descreve a variável.

Tipos de variável com suporte

Lista de tipos de variáveis com suporte.

Nome Tipo Exemplo
booleano BooleanVariable verdadeiro, falso
Data e Hora DateTimeVariable "2025-01-20T15:30:00Z"
Número NumberVariable 1.1
Número Inteiro IntegerVariable 1
fio StringVariable "Alguma cadeia de caracteres"

Variables.json exemplo 

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

Descreve um conjunto de valores. O nome do arquivo deve ser semelhante ao nome do conjunto de valores.

Nome Tipo Descrição
nome fio Nome do conjunto de valores.
descrição fio Descrição do conjunto de valores.
variableOverrides VariableOverride Lista de variáveis substituídas.

VariableOverride

Descreve uma substituição de valor.

Nome Tipo Descrição
nome fio Nome da variável substituída.
valor fio O novo valor da variável.

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

Descreve as configurações da Biblioteca de Variáveis definidas pelo usuário.

Nome Tipo Descrição
valueSetsOrder String[] Lista opcional de nomes de conjunto de valores para ordenação.

settings.json exemplo 

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

Considerações e limitações

  • A lista ValueSetsOrder pode estar vazia ou parcial.
  • A lista ValueSetsOrder não pode incluir nomes de conjunto de valores inválidos.
  • Ao atualizar um item de biblioteca de variáveis com uma lista valueSetsOrder parcial ou vazia, os nomes de conjunto de valores ausentes são adicionados ao final da lista em ordem alfabética.

Exemplo de definição

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