Library interface

Pacote:

@azure/synapse-artifacts

Interface que representa uma biblioteca.

Métodos

append(string, RequestBodyType, LibraryAppendOptionalParams)	Acrescente o conteúdo ao recurso de biblioteca criado usando a operação de criação. O tamanho máximo do conteúdo é 4MiB. Conteúdo maior que 4MiB deve ser acrescentado em partes de 4MiB
beginCreate(string, LibraryCreateOptionalParams)	Cria uma biblioteca com o nome da biblioteca.
beginCreateAndWait(string, LibraryCreateOptionalParams)	Cria uma biblioteca com o nome da biblioteca.
beginDelete(string, LibraryDeleteOptionalParams)	Excluir Biblioteca
beginDeleteAndWait(string, LibraryDeleteOptionalParams)	Excluir Biblioteca
beginFlush(string, LibraryFlushOptionalParams)	Biblioteca de Liberação
beginFlushAndWait(string, LibraryFlushOptionalParams)	Biblioteca de Liberação
get(string, LibraryGetOptionalParams)	Obter Biblioteca
getOperationResult(string, LibraryGetOperationResultOptionalParams)	Obter o resultado da operação para a biblioteca
list(LibraryListOptionalParams)	Biblioteca de Listas.

Detalhes do método

append(string, RequestBodyType, LibraryAppendOptionalParams)

Acrescente o conteúdo ao recurso de biblioteca criado usando a operação de criação. O tamanho máximo do conteúdo é 4MiB. Conteúdo maior que 4MiB deve ser acrescentado em partes de 4MiB

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

Parâmetros

libraryName

string

nome do arquivo a ser carregado. O comprimento mínimo do nome do arquivo deve ser 1, excluindo o comprimento da extensão.

content

RequestBodyType

Parte do arquivo da biblioteca.

options

LibraryAppendOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

beginCreate(string, LibraryCreateOptionalParams)

Cria uma biblioteca com o nome da biblioteca.

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

Parâmetros

libraryName

string

nome do arquivo a ser carregado. O comprimento mínimo do nome do arquivo deve ser 1, excluindo o comprimento da extensão.

options

LibraryCreateOptionalParams

Os parâmetros de opções.

Retornos

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

beginCreateAndWait(string, LibraryCreateOptionalParams)

Cria uma biblioteca com o nome da biblioteca.

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

Parâmetros

libraryName

string

nome do arquivo a ser carregado. O comprimento mínimo do nome do arquivo deve ser 1, excluindo o comprimento da extensão.

options

LibraryCreateOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

beginDelete(string, LibraryDeleteOptionalParams)

Excluir Biblioteca

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

Parâmetros

libraryName

string

nome do arquivo a ser carregado. O comprimento mínimo do nome do arquivo deve ser 1, excluindo o comprimento da extensão.

options

LibraryDeleteOptionalParams

Os parâmetros de opções.

Retornos

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

beginDeleteAndWait(string, LibraryDeleteOptionalParams)

Excluir Biblioteca

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

Parâmetros

libraryName

string

nome do arquivo a ser carregado. O comprimento mínimo do nome do arquivo deve ser 1, excluindo o comprimento da extensão.

options

LibraryDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

beginFlush(string, LibraryFlushOptionalParams)

Biblioteca de Liberação

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

Parâmetros

libraryName

string

nome do arquivo a ser carregado. O comprimento mínimo do nome do arquivo deve ser 1, excluindo o comprimento da extensão.

options

LibraryFlushOptionalParams

Os parâmetros de opções.

Retornos

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

beginFlushAndWait(string, LibraryFlushOptionalParams)

Biblioteca de Liberação

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

Parâmetros

libraryName

string

nome do arquivo a ser carregado. O comprimento mínimo do nome do arquivo deve ser 1, excluindo o comprimento da extensão.

options

LibraryFlushOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

get(string, LibraryGetOptionalParams)

Obter Biblioteca

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

Parâmetros

libraryName

string

nome do arquivo a ser carregado. O comprimento mínimo do nome do arquivo deve ser 1, excluindo o comprimento da extensão.

options

LibraryGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<LibraryResource>

getOperationResult(string, LibraryGetOperationResultOptionalParams)

Obter o resultado da operação para a biblioteca

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

Parâmetros

operationId

string

ID da operação para a qual o status é solicitado

options

LibraryGetOperationResultOptionalParams

Os parâmetros de opções.

Retornos

Promise<LibraryResource>

list(LibraryListOptionalParams)

Biblioteca de Listas.

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

Parâmetros

options

LibraryListOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<LibraryResource, LibraryResource[], PageSettings>