Library interface

Package:

@azure/synapse-artifacts

Interface representing a Library.

Methods

append(string, RequestBodyType, LibraryAppendOptionalParams)	Append the content to the library resource created using the create operation. The maximum content size is 4MiB. Content larger than 4MiB must be appended in 4MiB chunks
beginCreate(string, LibraryCreateOptionalParams)	Creates a library with the library name.
beginCreateAndWait(string, LibraryCreateOptionalParams)	Creates a library with the library name.
beginDelete(string, LibraryDeleteOptionalParams)	Delete Library
beginDeleteAndWait(string, LibraryDeleteOptionalParams)	Delete Library
beginFlush(string, LibraryFlushOptionalParams)	Flush Library
beginFlushAndWait(string, LibraryFlushOptionalParams)	Flush Library
get(string, LibraryGetOptionalParams)	Get Library
getOperationResult(string, LibraryGetOperationResultOptionalParams)	Get Operation result for Library
list(LibraryListOptionalParams)	Lists Library.

Method Details

append(string, RequestBodyType, LibraryAppendOptionalParams)

Append the content to the library resource created using the create operation. The maximum content size is 4MiB. Content larger than 4MiB must be appended in 4MiB chunks

function append(libraryName: string, content: RequestBodyType, options?: LibraryAppendOptionalParams): Promise<void>

Parameters

libraryName

string

file name to upload. Minimum length of the filename should be 1 excluding the extension length.

content

RequestBodyType

Library file chunk.

options

LibraryAppendOptionalParams

The options parameters.

Returns

Promise<void>

beginCreate(string, LibraryCreateOptionalParams)

Creates a library with the library name.

function beginCreate(libraryName: string, options?: LibraryCreateOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

libraryName

string

file name to upload. Minimum length of the filename should be 1 excluding the extension length.

options

LibraryCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginCreateAndWait(string, LibraryCreateOptionalParams)

Creates a library with the library name.

function beginCreateAndWait(libraryName: string, options?: LibraryCreateOptionalParams): Promise<void>

Parameters

libraryName

string

file name to upload. Minimum length of the filename should be 1 excluding the extension length.

options

LibraryCreateOptionalParams

The options parameters.

Returns

Promise<void>

beginDelete(string, LibraryDeleteOptionalParams)

Delete Library

function beginDelete(libraryName: string, options?: LibraryDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

libraryName

string

file name to upload. Minimum length of the filename should be 1 excluding the extension length.

options

LibraryDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, LibraryDeleteOptionalParams)

Delete Library

function beginDeleteAndWait(libraryName: string, options?: LibraryDeleteOptionalParams): Promise<void>

Parameters

libraryName

string

file name to upload. Minimum length of the filename should be 1 excluding the extension length.

options

LibraryDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginFlush(string, LibraryFlushOptionalParams)

Flush Library

function beginFlush(libraryName: string, options?: LibraryFlushOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

libraryName

string

file name to upload. Minimum length of the filename should be 1 excluding the extension length.

options

LibraryFlushOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginFlushAndWait(string, LibraryFlushOptionalParams)

Flush Library

function beginFlushAndWait(libraryName: string, options?: LibraryFlushOptionalParams): Promise<void>

Parameters

libraryName

string

file name to upload. Minimum length of the filename should be 1 excluding the extension length.

options

LibraryFlushOptionalParams

The options parameters.

Returns

Promise<void>

get(string, LibraryGetOptionalParams)

Get Library

function get(libraryName: string, options?: LibraryGetOptionalParams): Promise<LibraryResource>

Parameters

libraryName

string

file name to upload. Minimum length of the filename should be 1 excluding the extension length.

options

LibraryGetOptionalParams

The options parameters.

Returns

Promise<LibraryResource>

getOperationResult(string, LibraryGetOperationResultOptionalParams)

Get Operation result for Library

function getOperationResult(operationId: string, options?: LibraryGetOperationResultOptionalParams): Promise<LibraryResource>

Parameters

operationId

string

operation id for which status is requested

options

LibraryGetOperationResultOptionalParams

The options parameters.

Returns

Promise<LibraryResource>

list(LibraryListOptionalParams)

Lists Library.

function list(options?: LibraryListOptionalParams): PagedAsyncIterableIterator<LibraryResource, LibraryResource[], PageSettings>

Parameters

options

LibraryListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LibraryResource, LibraryResource[], PageSettings>