Edit

Share via

Items - Update Variable Library Definition

Service:
VariableLibrary
API Version:
v1

Overrides the definition for the specified variable library.
This API supports long running operations (LRO).

Updating the VariableLibrary's definition, does not affect its sensitivity label.

Permissions

The caller must have read and write permissions for the variable library.

Required Delegated Scopes

VariableLibrary.ReadWrite.All or Item.ReadWrite.All

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/{variableLibraryId}/updateDefinition
With optional parameters: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/VariableLibraries/{variableLibraryId}/updateDefinition?updateMetadata={updateMetadata}

URI Parameters

Name In Required Type Description
variableLibraryId
 path True

string (uuid)

The VariableLibrary ID.
workspaceId
 path True

string (uuid)

The workspace ID.
updateMetadata
 query

boolean

When set to true and the .platform file is provided as part of the definition, the item's metadata is updated using the metadata in the .platform file

Request Body

Name Required Type Description
definition True

VariableLibraryPublicDefinition

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

Responses

Name Type Description
200 OK

Request completed successfully.
202 Accepted

Request accepted. Update definition is in progress.

Headers

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Common error codes:

  • OperationNotSupportedForItem - Operation not supported for requested item.

  • CorruptedPayload - The provided payload is corrupted.

Examples

Update a VariableLibrary public definition example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/VariableLibraries/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "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:
200
Status code:
202 
Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
PayloadType

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

Update VariableLibrary public definition request payload.
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.

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.

PayloadType

Enumeration

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

Value Description
InlineBase64

Inline Base 64.

UpdateVariableLibraryDefinitionRequest

Object

Update VariableLibrary public definition request payload.

Name Type Description
definition

VariableLibraryPublicDefinition

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

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.