library

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

Overview

Name	library
Type	Resource
Id	azure.synapse_artifacts.library

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
containerName	string	Container name of the library/package.
creatorId	string	Creator Id of the library/package.
etag	string	Resource Etag.
path	string	Location of library/package in storage account.
provisioningStatus	string	Provisioning status of the library/package.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uploadedTimestamp	string	The last update time of the library/package.

get_operation_result

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
containerName	string	Container name of the library/package.
creatorId	string	Creator Id of the library/package.
etag	string	Resource Etag.
path	string	Location of library/package in storage account.
provisioningStatus	string	Provisioning status of the library/package.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uploadedTimestamp	string	The last update time of the library/package.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
containerName	string	Container name of the library/package.
creatorId	string	Creator Id of the library/package.
etag	string	Resource Etag.
path	string	Location of library/package in storage account.
provisioningStatus	string	Provisioning status of the library/package.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uploadedTimestamp	string	The last update time of the library/package.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	library_name, endpoint		Get Library.
get_operation_result	select	operation_id, endpoint		Get Operation result for Library.
list	select	endpoint		Lists Library.
create	insert	library_name, endpoint		Creates a library with the library name.
delete	delete	library_name, endpoint		Delete Library.
flush	exec	library_name, endpoint		Flush Library.

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
endpoint	string	The service endpoint host (no scheme). (default: )
library_name	string	file name to upload. Minimum length of the filename should be 1 excluding the extension length. Required.
operation_id	string	operation id for which status is requested. Required.

SELECT examples

get

Get Library.

SELECT
id,
name,
containerName,
creatorId,
etag,
path,
provisioningStatus,
type,
uploadedTimestamp
FROM azure.synapse_artifacts.library
WHERE library_name = '{{ library_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get_operation_result

Get Operation result for Library.

SELECT
id,
name,
containerName,
creatorId,
etag,
path,
provisioningStatus,
type,
uploadedTimestamp
FROM azure.synapse_artifacts.library
WHERE operation_id = '{{ operation_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

Lists Library.

SELECT
id,
name,
containerName,
creatorId,
etag,
path,
provisioningStatus,
type,
uploadedTimestamp
FROM azure.synapse_artifacts.library
WHERE endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create

Creates a library with the library name.

INSERT INTO azure.synapse_artifacts.library (
library_name,
endpoint
)
SELECT 
'{{ library_name }}',
'{{ endpoint }}'
RETURNING
id,
name,
artifactId,
changed,
created,
operationId,
recordId,
state,
type
;

Manifest

# Description fields are for documentation purposes
- name: library
props:
  - name: library_name
    value: "{{ library_name }}"
    description: Required parameter for the library resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the library resource.

DELETE examples

delete

Delete Library.

DELETE FROM azure.synapse_artifacts.library
WHERE library_name = '{{ library_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

flush

Flush Library.

EXEC azure.synapse_artifacts.library.flush 
@library_name='{{ library_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;