Library interface

Paket:

@azure/synapse-artifacts

Schnittstelle, die eine Bibliothek darstellt.

Methoden

append(string, RequestBodyType, LibraryAppendOptionalParams)	Fügen Sie den Inhalt an die Bibliotheksressource an, die mit dem Erstellungsvorgang erstellt wurde. Die maximale Inhaltsgröße beträgt 4MiB. Inhalt, der größer als 4MiB ist, muss in 4MiB-Blöcken angefügt werden.
beginCreate(string, LibraryCreateOptionalParams)	Erstellt eine Bibliothek mit dem Bibliotheksnamen.
beginCreateAndWait(string, LibraryCreateOptionalParams)	Erstellt eine Bibliothek mit dem Bibliotheksnamen.
beginDelete(string, LibraryDeleteOptionalParams)	Bibliothek löschen
beginDeleteAndWait(string, LibraryDeleteOptionalParams)	Bibliothek löschen
beginFlush(string, LibraryFlushOptionalParams)	Bibliothek leeren
beginFlushAndWait(string, LibraryFlushOptionalParams)	Bibliothek leeren
get(string, LibraryGetOptionalParams)	Bibliothek abrufen
getOperationResult(string, LibraryGetOperationResultOptionalParams)	Vorgangsergebnis für Bibliothek abrufen
list(LibraryListOptionalParams)	Listenbibliothek.

Details zur Methode

append(string, RequestBodyType, LibraryAppendOptionalParams)

Fügen Sie den Inhalt an die Bibliotheksressource an, die mit dem Erstellungsvorgang erstellt wurde. Die maximale Inhaltsgröße beträgt 4MiB. Inhalt, der größer als 4MiB ist, muss in 4MiB-Blöcken angefügt werden.

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

Parameter

libraryName

string

Dateiname, der hochgeladen werden soll. Die Mindestlänge des Dateinamens sollte 1 mit Ausnahme der Länge der Erweiterung sein.

content

RequestBodyType

Bibliotheksdateiabschnitt.

options

LibraryAppendOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

beginCreate(string, LibraryCreateOptionalParams)

Erstellt eine Bibliothek mit dem Bibliotheksnamen.

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

Parameter

libraryName

string

Dateiname, der hochgeladen werden soll. Die Mindestlänge des Dateinamens sollte 1 mit Ausnahme der Länge der Erweiterung sein.

options

LibraryCreateOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginCreateAndWait(string, LibraryCreateOptionalParams)

Erstellt eine Bibliothek mit dem Bibliotheksnamen.

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

Parameter

libraryName

string

Dateiname, der hochgeladen werden soll. Die Mindestlänge des Dateinamens sollte 1 mit Ausnahme der Länge der Erweiterung sein.

options

LibraryCreateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

beginDelete(string, LibraryDeleteOptionalParams)

Bibliothek löschen

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

Parameter

libraryName

string

Dateiname, der hochgeladen werden soll. Die Mindestlänge des Dateinamens sollte 1 mit Ausnahme der Länge der Erweiterung sein.

options

LibraryDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginDeleteAndWait(string, LibraryDeleteOptionalParams)

Bibliothek löschen

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

Parameter

libraryName

string

Dateiname, der hochgeladen werden soll. Die Mindestlänge des Dateinamens sollte 1 mit Ausnahme der Länge der Erweiterung sein.

options

LibraryDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

beginFlush(string, LibraryFlushOptionalParams)

Bibliothek leeren

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

Parameter

libraryName

string

Dateiname, der hochgeladen werden soll. Die Mindestlänge des Dateinamens sollte 1 mit Ausnahme der Länge der Erweiterung sein.

options

LibraryFlushOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginFlushAndWait(string, LibraryFlushOptionalParams)

Bibliothek leeren

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

Parameter

libraryName

string

Dateiname, der hochgeladen werden soll. Die Mindestlänge des Dateinamens sollte 1 mit Ausnahme der Länge der Erweiterung sein.

options

LibraryFlushOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, LibraryGetOptionalParams)

Bibliothek abrufen

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

Parameter

libraryName

string

Dateiname, der hochgeladen werden soll. Die Mindestlänge des Dateinamens sollte 1 mit Ausnahme der Länge der Erweiterung sein.

options

LibraryGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<LibraryResource>

getOperationResult(string, LibraryGetOperationResultOptionalParams)

Vorgangsergebnis für Bibliothek abrufen

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

Parameter

operationId

string

Vorgangs-ID, für den der Status angefordert wird

options

LibraryGetOperationResultOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<LibraryResource>

list(LibraryListOptionalParams)

Listenbibliothek.

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

Parameter

options

LibraryListOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<LibraryResource, LibraryResource[], PageSettings>