Items - Create Variable Library

Service:: VariableLibrary

API Version:: v1

Creates a variable library in the specified workspace.
This API supports long running operations (LRO).

To create VariableLibrary with a public definition, refer to VariableLibrary article.

Permissions

The caller must have a contributor workspace role.

Required Delegated Scopes

VariableLibrary.ReadWrite.All or Item.ReadWrite.All

Limitations

To create a VariableLibrary the workspace must be on a supported Fabric capacity. For more information see: Microsoft Fabric license types.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/VariableLibraries

URI Parameters

Name	In	Required	Type	Description
workspaceId	path	True	string (uuid)	The workspace ID.

Request Body

Name	Required	Type	Description
displayName	True	string	The VariableLibrary display name. The display name must follow naming rules according to item type.
definition		VariableLibraryPublicDefinition	The VariableLibrary public definition.
description		string	The VariableLibrary description. Maximum length is 256 characters.
folderId		string (uuid)	The folder ID. If not specified or null, the VariableLibrary is created with the workspace as its folder.

Responses

Name	Type	Description
201 Created	VariableLibrary	Successfully created
202 Accepted		Request accepted, VariableLibrary provisioning in progress. Headers Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: InvalidItemType - Item type is invalid ItemDisplayNameAlreadyInUse - Item display name is already used. CorruptedPayload - The provided payload is corrupted.

Name

Type

Description

201 Created

VariableLibrary

Successfully created

202 Accepted

Request accepted, VariableLibrary provisioning in progress.

Headers

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Common error codes:

InvalidItemType - Item type is invalid
ItemDisplayNameAlreadyInUse - Item display name is already used.
CorruptedPayload - The provided payload is corrupted.

Examples

Create a VariableLibrary example

Create a VariableLibrary with public definition example

Create a VariableLibrary example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/VariableLibraries

{
  "displayName": "VariableLibrary 1",
  "description": "A VariableLibrary description."
}

Sample response

Status code:: 201

{
  "displayName": "VariableLibrary 1",
  "description": "A VariableLibrary description.",
  "type": "VariableLibrary",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a VariableLibrary with public definition example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/VariableLibraries

{
  "displayName": "VariableLibrary 1",
  "description": "A VariableLibrary description.",
  "definition": {
    "format": "VariableLibraryV1",
    "parts": [
      {
        "path": "variables.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "valueSets/valueSet1.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "settings.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Sample response

Status code:: 201

{
  "displayName": "VariableLibrary 1",
  "description": "A VariableLibrary description.",
  "type": "VariableLibrary",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definitions

Name	Description
CreateVariableLibraryRequest	Create VariableLibrary request payload.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ItemTag	Represents a tag applied on an item.
ItemType	The type of the item. Additional item types may be added over time.
PayloadType	The type of the definition part payload. Additional payload types may be added over time.
VariableLibrary	A VariableLibrary object.
VariableLibraryProperties	The VariableLibrary properties.
VariableLibraryPublicDefinition	VariableLibrary public definition object. Refer to this article for more details on how to craft a VariableLibrary public definition.
VariableLibraryPublicDefinitionPart	VariableLibrary definition part object.

CreateVariableLibraryRequest

Object

Create VariableLibrary request payload.

Name	Type	Description
definition	VariableLibraryPublicDefinition	The VariableLibrary public definition.
description	string	The VariableLibrary description. Maximum length is 256 characters.
displayName	string	The VariableLibrary display name. The display name must follow naming rules according to item type.
folderId	string (uuid)	The folder ID. If not specified or null, the VariableLibrary is created with the workspace as its folder.

ErrorRelatedResource

Object

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

ItemTag

Object

Represents a tag applied on an item.

Name	Type	Description
displayName	string	The name of the tag.
id	string (uuid)	The tag ID.

ItemType

Enumeration

The type of the item. Additional item types may be added over time.

Value	Description
ApacheAirflowJob	An ApacheAirflowJob.
CopyJob	A Copy job.
Dashboard	PowerBI dashboard.
DataPipeline	A data pipeline.
Dataflow	A Dataflow.
Datamart	PowerBI datamart.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	A Digital Twin Builder Flow.
Environment	An environment.
Eventhouse	An eventhouse.
Eventstream	An eventstream.
GraphQLApi	An API for GraphQL item.
KQLDashboard	A KQL dashboard.
KQLDatabase	A KQL database.
KQLQueryset	A KQL queryset.
Lakehouse	A lakehouse.
MLExperiment	A machine learning experiment.
MLModel	A machine learning model.
MirroredAzureDatabricksCatalog	A mirrored azure databricks catalog.
MirroredDatabase	A mirrored database.
MirroredWarehouse	A mirrored warehouse.
MountedDataFactory	A MountedDataFactory.
Notebook	A notebook.
PaginatedReport	PowerBI paginated report.
Reflex	A Reflex.
Report	PowerBI report.
SQLDatabase	A SQLDatabase.
SQLEndpoint	An SQL endpoint.
SemanticModel	PowerBI semantic model.
SparkJobDefinition	A spark job definition.
VariableLibrary	A VariableLibrary.
Warehouse	A warehouse.
WarehouseSnapshot	A Warehouse snapshot.

PayloadType

Enumeration

The type of the definition part payload. Additional payload types may be added over time.

Value	Description
InlineBase64	Inline Base 64.

VariableLibrary

Object

A VariableLibrary object.

Name	Type	Description
description	string	The item description.
displayName	string	The item display name.
folderId	string (uuid)	The folder ID.
id	string (uuid)	The item ID.
properties	VariableLibraryProperties	The VariableLibrary properties.
tags	ItemTag[]	List of applied tags.
type	ItemType	The item type.
workspaceId	string (uuid)	The workspace ID.

VariableLibraryProperties

Object

The VariableLibrary properties.

Name	Type	Description
activeValueSetName	string	The VariableLibrary current active value set.

VariableLibraryPublicDefinition

Object

VariableLibrary public definition object. Refer to this article for more details on how to craft a VariableLibrary public definition.

Name	Type	Description
format	string	The format of the item definition. Supported format: `VariableLibraryV1`.
parts	VariableLibraryPublicDefinitionPart[]	A list of definition parts.

VariableLibraryPublicDefinitionPart

Object

VariableLibrary definition part object.

Name	Type	Description
path	string	The VariableLibrary public definition part path.
payload	string	The VariableLibrary public definition part payload.
payloadType	PayloadType	The payload type.

Share via

Items - Create Variable Library

Permissions

Required Delegated Scopes

Limitations

Microsoft Entra supported identities

Interface

URI Parameters

Request Body

Responses

Examples

Create a VariableLibrary example

Sample request

Sample response

Create a VariableLibrary with public definition example

Sample request

Sample response

Definitions

CreateVariableLibraryRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

VariableLibrary

VariableLibraryProperties

VariableLibraryPublicDefinition

VariableLibraryPublicDefinitionPart