Library interface

Paquet:

@azure/synapse-artifacts

Interface représentant une bibliothèque.

Méthodes

append(string, RequestBodyType, LibraryAppendOptionalParams)	Ajoutez le contenu à la ressource de bibliothèque créée à l’aide de l’opération de création. La taille maximale du contenu est 4MiB. Le contenu supérieur à 4MiB doit être ajouté dans des blocs 4MiB
beginCreate(string, LibraryCreateOptionalParams)	Crée une bibliothèque avec le nom de la bibliothèque.
beginCreateAndWait(string, LibraryCreateOptionalParams)	Crée une bibliothèque avec le nom de la bibliothèque.
beginDelete(string, LibraryDeleteOptionalParams)	Supprimer la bibliothèque
beginDeleteAndWait(string, LibraryDeleteOptionalParams)	Supprimer la bibliothèque
beginFlush(string, LibraryFlushOptionalParams)	Vider la bibliothèque
beginFlushAndWait(string, LibraryFlushOptionalParams)	Vider la bibliothèque
get(string, LibraryGetOptionalParams)	Obtenir la bibliothèque
getOperationResult(string, LibraryGetOperationResultOptionalParams)	Obtenir le résultat de l’opération pour la bibliothèque
list(LibraryListOptionalParams)	Bibliothèque de listes.

Détails de la méthode

append(string, RequestBodyType, LibraryAppendOptionalParams)

Ajoutez le contenu à la ressource de bibliothèque créée à l’aide de l’opération de création. La taille maximale du contenu est 4MiB. Le contenu supérieur à 4MiB doit être ajouté dans des blocs 4MiB

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

Paramètres

libraryName

string

nom de fichier à charger. La longueur minimale du nom de fichier doit être égale à 1, à l’exclusion de la longueur de l’extension.

content

RequestBodyType

Bloc de fichier de bibliothèque.

options

LibraryAppendOptionalParams

Paramètres d’options.

Retours

Promise<void>

beginCreate(string, LibraryCreateOptionalParams)

Crée une bibliothèque avec le nom de la bibliothèque.

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

Paramètres

libraryName

string

nom de fichier à charger. La longueur minimale du nom de fichier doit être égale à 1, à l’exclusion de la longueur de l’extension.

options

LibraryCreateOptionalParams

Paramètres d’options.

Retours

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

beginCreateAndWait(string, LibraryCreateOptionalParams)

Crée une bibliothèque avec le nom de la bibliothèque.

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

Paramètres

libraryName

string

nom de fichier à charger. La longueur minimale du nom de fichier doit être égale à 1, à l’exclusion de la longueur de l’extension.

options

LibraryCreateOptionalParams

Paramètres d’options.

Retours

Promise<void>

beginDelete(string, LibraryDeleteOptionalParams)

Supprimer la bibliothèque

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

Paramètres

libraryName

string

nom de fichier à charger. La longueur minimale du nom de fichier doit être égale à 1, à l’exclusion de la longueur de l’extension.

options

LibraryDeleteOptionalParams

Paramètres d’options.

Retours

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

beginDeleteAndWait(string, LibraryDeleteOptionalParams)

Supprimer la bibliothèque

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

Paramètres

libraryName

string

nom de fichier à charger. La longueur minimale du nom de fichier doit être égale à 1, à l’exclusion de la longueur de l’extension.

options

LibraryDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

beginFlush(string, LibraryFlushOptionalParams)

Vider la bibliothèque

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

Paramètres

libraryName

string

nom de fichier à charger. La longueur minimale du nom de fichier doit être égale à 1, à l’exclusion de la longueur de l’extension.

options

LibraryFlushOptionalParams

Paramètres d’options.

Retours

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

beginFlushAndWait(string, LibraryFlushOptionalParams)

Vider la bibliothèque

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

Paramètres

libraryName

string

nom de fichier à charger. La longueur minimale du nom de fichier doit être égale à 1, à l’exclusion de la longueur de l’extension.

options

LibraryFlushOptionalParams

Paramètres d’options.

Retours

Promise<void>

get(string, LibraryGetOptionalParams)

Obtenir la bibliothèque

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

Paramètres

libraryName

string

nom de fichier à charger. La longueur minimale du nom de fichier doit être égale à 1, à l’exclusion de la longueur de l’extension.

options

LibraryGetOptionalParams

Paramètres d’options.

Retours

Promise<LibraryResource>

getOperationResult(string, LibraryGetOperationResultOptionalParams)

Obtenir le résultat de l’opération pour la bibliothèque

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

Paramètres

operationId

string

ID d’opération pour lequel l’état est demandé

options

LibraryGetOperationResultOptionalParams

Paramètres d’options.

Retours

Promise<LibraryResource>

list(LibraryListOptionalParams)

Bibliothèque de listes.

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

Paramètres

options

LibraryListOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<LibraryResource, LibraryResource[], PageSettings>