Automatizar bibliotecas de variáveis usando APIs e Azure DevOps (versão prévia)

Você pode usar as APIs REST do Microsoft Fabric para automatizar totalmente o gerenciamento da biblioteca de variáveis.

Se você estiver usando as APIs como parte do gerenciamento do ciclo de vida, as permissões para referência de item serão verificadas durante a atualização do Git e a implantação do pipeline de implantação.

Pré-requisitos

Para usar as APIs, você precisa:

• Os mesmos pré-requisitos do item de biblioteca variável.
• Um token do Microsoft Entra para o serviço Fabric. Use o token no cabeçalho de autorização da chamada à API. Para obter informações sobre como obter um token, consulte Guia de início rápido da API do Fabric.

APIs variáveis de biblioteca

As APIs REST da biblioteca de variáveis permitem que você execute as seguintes funções:

• Criar biblioteca de variáveis: crie uma biblioteca de variáveis no workspace especificado.
• Obter Biblioteca de Variáveis: recuperar propriedades de uma biblioteca de variáveis. Você também pode recuperar o conjunto de valores ativos usando o parâmetro VariableLibraryProperties .
• Atualizar biblioteca de variáveis: atualizar as propriedades de uma biblioteca de variáveis. Você também pode atualizar o conjunto de valores ativos usando o parâmetro VariableLibraryProperties .
• Excluir Biblioteca de Variáveis: exclua a biblioteca de variáveis especificada.
• Listar bibliotecas de variáveis: listar bibliotecas de variáveis no workspace especificado.
• Obter definição de biblioteca de variáveis: recupere a definição pública de uma biblioteca de variáveis.
• Atualizar definição de biblioteca de variáveis: substitua a definição de uma biblioteca de variáveis.

As APIs REST do item de biblioteca variável dão suporte a princípios de serviço.

Exemplos

Para obter alguns exemplos de como usar as APIs, consulte a documentação da API REST para cada API. Para obter um detalhamento da estrutura de definição da biblioteca variável, consulte a definição da biblioteca de variáveis.

Considerações e limitações

Limitações de tamanho

• Pode haver até 1.000 variáveis e até 1.000 conjuntos de valores, desde que o número total de células nos conjuntos de valores alternativos seja inferior a 10.000 células e o tamanho do item não seja maior que 1 MB. Isso é validado quando o usuário salva as alterações.
• O campo de observação pode ter até 2.048 caracteres.
• O campo de descrição do conjunto de valores pode ter até 2.048 caracteres.

Limitações alternativas do conjunto de valores

• Os conjuntos de valores alternativos na Biblioteca de Variáveis aparecem na ordem em que foram adicionados. Atualmente, você não pode reordená-los na interface do usuário. Para alterar a ordem, edite o arquivo JSON diretamente.
• O nome de cada conjunto de valores deve ser exclusivo na Biblioteca de Variáveis.
• Os nomes de variáveis devem ser exclusivos em uma biblioteca de variáveis. Você pode ter duas variáveis com o mesmo nome em um workspace se elas estiverem em itens diferentes.
• Há sempre um e apenas um valor ativo definido em uma Biblioteca de Variáveisde cada vez. Não é possível excluir o conjunto de valores ativos. Para excluí-lo, primeiro defina outro conjunto de valores como ativo. Você pode definir um conjunto de valores ativos diferente para cada estágio de um pipeline de implantação.