Library interface

Paquete:

@azure/synapse-artifacts

Interfaz que representa una biblioteca.

Métodos

append(string, RequestBodyType, LibraryAppendOptionalParams)	Anexe el contenido al recurso de biblioteca creado mediante la operación de creación. El tamaño máximo de contenido es 4MiB. El contenido mayor que 4MiB debe anexarse en fragmentos de 4MiB
beginCreate(string, LibraryCreateOptionalParams)	Crea una biblioteca con el nombre de la biblioteca.
beginCreateAndWait(string, LibraryCreateOptionalParams)	Crea una biblioteca con el nombre de la biblioteca.
beginDelete(string, LibraryDeleteOptionalParams)	Eliminar biblioteca
beginDeleteAndWait(string, LibraryDeleteOptionalParams)	Eliminar biblioteca
beginFlush(string, LibraryFlushOptionalParams)	Biblioteca de vaciado
beginFlushAndWait(string, LibraryFlushOptionalParams)	Biblioteca de vaciado
get(string, LibraryGetOptionalParams)	Obtener biblioteca
getOperationResult(string, LibraryGetOperationResultOptionalParams)	Obtener el resultado de la operación para la biblioteca
list(LibraryListOptionalParams)	Biblioteca de listas.

Detalles del método

append(string, RequestBodyType, LibraryAppendOptionalParams)

Anexe el contenido al recurso de biblioteca creado mediante la operación de creación. El tamaño máximo de contenido es 4MiB. El contenido mayor que 4MiB debe anexarse en fragmentos de 4MiB

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

Parámetros

libraryName

string

nombre de archivo que se va a cargar. La longitud mínima del nombre de archivo debe ser 1, excepto la longitud de la extensión.

content

RequestBodyType

Fragmento de archivo de biblioteca.

options

LibraryAppendOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

beginCreate(string, LibraryCreateOptionalParams)

Crea una biblioteca con el nombre de la biblioteca.

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

Parámetros

libraryName

string

nombre de archivo que se va a cargar. La longitud mínima del nombre de archivo debe ser 1, excepto la longitud de la extensión.

options

LibraryCreateOptionalParams

Parámetros de opciones.

Devoluciones

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

beginCreateAndWait(string, LibraryCreateOptionalParams)

Crea una biblioteca con el nombre de la biblioteca.

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

Parámetros

libraryName

string

nombre de archivo que se va a cargar. La longitud mínima del nombre de archivo debe ser 1, excepto la longitud de la extensión.

options

LibraryCreateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

beginDelete(string, LibraryDeleteOptionalParams)

Eliminar biblioteca

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

Parámetros

libraryName

string

nombre de archivo que se va a cargar. La longitud mínima del nombre de archivo debe ser 1, excepto la longitud de la extensión.

options

LibraryDeleteOptionalParams

Parámetros de opciones.

Devoluciones

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

beginDeleteAndWait(string, LibraryDeleteOptionalParams)

Eliminar biblioteca

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

Parámetros

libraryName

string

nombre de archivo que se va a cargar. La longitud mínima del nombre de archivo debe ser 1, excepto la longitud de la extensión.

options

LibraryDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

beginFlush(string, LibraryFlushOptionalParams)

Biblioteca de vaciado

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

Parámetros

libraryName

string

nombre de archivo que se va a cargar. La longitud mínima del nombre de archivo debe ser 1, excepto la longitud de la extensión.

options

LibraryFlushOptionalParams

Parámetros de opciones.

Devoluciones

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

beginFlushAndWait(string, LibraryFlushOptionalParams)

Biblioteca de vaciado

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

Parámetros

libraryName

string

nombre de archivo que se va a cargar. La longitud mínima del nombre de archivo debe ser 1, excepto la longitud de la extensión.

options

LibraryFlushOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

get(string, LibraryGetOptionalParams)

Obtener biblioteca

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

Parámetros

libraryName

string

nombre de archivo que se va a cargar. La longitud mínima del nombre de archivo debe ser 1, excepto la longitud de la extensión.

options

LibraryGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<LibraryResource>

getOperationResult(string, LibraryGetOperationResultOptionalParams)

Obtener el resultado de la operación para la biblioteca

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

Parámetros

operationId

string

ID de operación para el que se solicita el estado

options

LibraryGetOperationResultOptionalParams

Parámetros de opciones.

Devoluciones

Promise<LibraryResource>

list(LibraryListOptionalParams)

Biblioteca de listas.

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

Parámetros

options

LibraryListOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<LibraryResource, LibraryResource[], PageSettings>