libraries

Creates, updates, deletes, gets or lists a libraries resource.

Overview

Name	libraries
Type	Resource
Id	azure.synapse.libraries

Fields

The following fields are returned by SELECT queries:

get

OK.

Name	Datatype	Description
properties	object	Library/package properties. (title: Information about a library/package created at the workspace level.)

list_by_workspace

OK.

Name	Datatype	Description
properties	object	Library/package properties. (title: Information about a library/package created at the workspace level.)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, libraryName, workspaceName		Get library by name in a workspace.
list_by_workspace	select	subscriptionId, resourceGroupName, workspaceName		List libraries in a workspace.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
libraryName	string	Library name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Get library by name in a workspace.

SELECT
properties
FROM azure.synapse.libraries
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND libraryName = '{{ libraryName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

list_by_workspace

List libraries in a workspace.

SELECT
properties
FROM azure.synapse.libraries
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;