Library interface

Pakiet:

@azure/synapse-artifacts

Interfejs reprezentujący bibliotekę.

Metody

append(string, RequestBodyType, LibraryAppendOptionalParams)	Dołącz zawartość do zasobu biblioteki utworzonego przy użyciu operacji tworzenia. Maksymalny rozmiar zawartości to 4MiB. Zawartość większa niż 4MiB musi być dołączona w fragmentach 4MiB
beginCreate(string, LibraryCreateOptionalParams)	Tworzy bibliotekę o nazwie biblioteki.
beginCreateAndWait(string, LibraryCreateOptionalParams)	Tworzy bibliotekę o nazwie biblioteki.
beginDelete(string, LibraryDeleteOptionalParams)	Usuń bibliotekę
beginDeleteAndWait(string, LibraryDeleteOptionalParams)	Usuń bibliotekę
beginFlush(string, LibraryFlushOptionalParams)	Opróżnianie biblioteki
beginFlushAndWait(string, LibraryFlushOptionalParams)	Opróżnianie biblioteki
get(string, LibraryGetOptionalParams)	Pobieranie biblioteki
getOperationResult(string, LibraryGetOperationResultOptionalParams)	Uzyskiwanie wyniku operacji dla biblioteki
list(LibraryListOptionalParams)	Wyświetla listę biblioteki.

Szczegóły metody

append(string, RequestBodyType, LibraryAppendOptionalParams)

Dołącz zawartość do zasobu biblioteki utworzonego przy użyciu operacji tworzenia. Maksymalny rozmiar zawartości to 4MiB. Zawartość większa niż 4MiB musi być dołączona w fragmentach 4MiB

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

Parametry

libraryName

string

nazwa pliku do przekazania. Minimalna długość nazwy pliku powinna wynosić 1 z wyłączeniem długości rozszerzenia.

content

RequestBodyType

Fragment pliku biblioteki.

options

LibraryAppendOptionalParams

Parametry opcji.

Zwraca

Promise<void>

beginCreate(string, LibraryCreateOptionalParams)

Tworzy bibliotekę o nazwie biblioteki.

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

Parametry

libraryName

string

nazwa pliku do przekazania. Minimalna długość nazwy pliku powinna wynosić 1 z wyłączeniem długości rozszerzenia.

options

LibraryCreateOptionalParams

Parametry opcji.

Zwraca

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

beginCreateAndWait(string, LibraryCreateOptionalParams)

Tworzy bibliotekę o nazwie biblioteki.

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

Parametry

libraryName

string

nazwa pliku do przekazania. Minimalna długość nazwy pliku powinna wynosić 1 z wyłączeniem długości rozszerzenia.

options

LibraryCreateOptionalParams

Parametry opcji.

Zwraca

Promise<void>

beginDelete(string, LibraryDeleteOptionalParams)

Usuń bibliotekę

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

Parametry

libraryName

string

nazwa pliku do przekazania. Minimalna długość nazwy pliku powinna wynosić 1 z wyłączeniem długości rozszerzenia.

options

LibraryDeleteOptionalParams

Parametry opcji.

Zwraca

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

beginDeleteAndWait(string, LibraryDeleteOptionalParams)

Usuń bibliotekę

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

Parametry

libraryName

string

nazwa pliku do przekazania. Minimalna długość nazwy pliku powinna wynosić 1 z wyłączeniem długości rozszerzenia.

options

LibraryDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

beginFlush(string, LibraryFlushOptionalParams)

Opróżnianie biblioteki

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

Parametry

libraryName

string

nazwa pliku do przekazania. Minimalna długość nazwy pliku powinna wynosić 1 z wyłączeniem długości rozszerzenia.

options

LibraryFlushOptionalParams

Parametry opcji.

Zwraca

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

beginFlushAndWait(string, LibraryFlushOptionalParams)

Opróżnianie biblioteki

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

Parametry

libraryName

string

nazwa pliku do przekazania. Minimalna długość nazwy pliku powinna wynosić 1 z wyłączeniem długości rozszerzenia.

options

LibraryFlushOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, LibraryGetOptionalParams)

Pobieranie biblioteki

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

Parametry

libraryName

string

nazwa pliku do przekazania. Minimalna długość nazwy pliku powinna wynosić 1 z wyłączeniem długości rozszerzenia.

options

LibraryGetOptionalParams

Parametry opcji.

Zwraca

Promise<LibraryResource>

getOperationResult(string, LibraryGetOperationResultOptionalParams)

Uzyskiwanie wyniku operacji dla biblioteki

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

Parametry

operationId

string

identyfikator operacji, dla którego zażądano stanu

options

LibraryGetOperationResultOptionalParams

Parametry opcji.

Zwraca

Promise<LibraryResource>

list(LibraryListOptionalParams)

Wyświetla listę biblioteki.

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

Parametry

options

LibraryListOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<LibraryResource, LibraryResource[], PageSettings>