Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
You can use the Microsoft Fabric REST APIs to fully automate the Variable library management.
If you're using the APIs as part of your lifecycle management, permissions for item reference are checked during Git Update and deployment pipeline deployment.
Prerequisites
To use the APIs, you need:
- The same prerequisites as for the Variable library item.
- A Microsoft Entra token for Fabric service. Use the token in the authorization header of the API call. For information about how to get a token, see Fabric API quickstart.
Variable library APIs
The Variable library REST APIs allow you to perform the following functions:
- Create Variable Library: Create a Variable library in the specified workspace.
- Get Variable Library: Retrieve properties of a Variable library. You can also retrieve the active value set using the VariableLibraryProperties parameter.
- Update Variable Library: Update a Variable library's properties. You can also update the active value set using the VariableLibraryProperties parameter.
- Delete Variable Library: Delete the specified Variable library.
- List Variable Libraries: List Variable libraries in the specified workspace.
- Get Variable Library Definition: Retrieve the public definition of a Variable library.
- Update Variable Library Definition: Override the definition of a Variable library.
The Variable library item REST APIs support service principles.
Examples
For some examples of how to use the APIs, see the REST API documentation for each API. For a breakdown of the definition structure of the Variable library, see the Variable library definition.
Considerations and limitations
Size limitations
- There can be up to 1,000 variables and up to 1,000 value-sets, as long as the total number of cells in the alternative value-sets is under 10,000 cells, and the item’s size not bigger than 1 MB. This is validated when the user saves changes.
- The note field can have up to 2,048 characters.
- The value-set description field can have up to 2,048 characters.
Alternative value set limitations
- Alternative value sets in the Variable library appear in the order they were added. Currently, you can't reorder them in the UI. To change the order, edit the JSON file directly.
- The name of each value set must be unique within the Variable library.
- Variable names must be unique within a Variable library. You can have two variables with the same name in a workspace if they are in different items.
- There's always one and only one active value set in a Variable library at a time. You can't delete the active value set. To delete it, first set another value set to be active. You can set a different active value set for each stage of a deployment pipeline.