Partilhar via

Definição de biblioteca variável

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

Peças 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 Conjunto de valores (JSON) ❌ Definir o modelo padrão a ser usado ao renderizar o item

Variáveis

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

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

Variável

Descreve uma variável.

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

Tipos de variáveis suportados

Lista de tipos de variáveis suportados.

Nome Tipo Exemplo
booleano BooleanVariable verdadeiro, falso
Data e Hora DateTimeVariable "2025-01-20T15:30:00Z"
Número NúmeroVariável 1.1
Número inteiro IntegerVariable 1
Cordão StringVariable "Alguma corda"

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

Conjunto de Valores

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

Nome Tipo Descrição
nome Cordão Nome do conjunto de valores.
descrição Cordão Descrição do conjunto de valores.
variávelSubstituições VariableOverride Lista de variáveis substituídas.

VariableOverride

Descreve uma substituição de valor.

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

valueSets/valueSet.json exemplo 

{
  "$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 conjuntos 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 conjuntos de valores inválidos.
  • Ao atualizar um item de biblioteca variável com uma lista valueSetsOrder parcial ou vazia, os nomes de conjuntos 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