Library interface

Пакет:

@azure/synapse-artifacts

Интерфейс, представляющий библиотеку.

Методы

append(string, RequestBodyType, LibraryAppendOptionalParams)	Добавьте содержимое в ресурс библиотеки, созданный с помощью операции создания. Максимальный размер содержимого — 4MiB. Содержимое размером более 4MiB должно быть добавлено в блоки 4MiB
beginCreate(string, LibraryCreateOptionalParams)	Создает библиотеку с именем библиотеки.
beginCreateAndWait(string, LibraryCreateOptionalParams)	Создает библиотеку с именем библиотеки.
beginDelete(string, LibraryDeleteOptionalParams)	Удаление библиотеки
beginDeleteAndWait(string, LibraryDeleteOptionalParams)	Удаление библиотеки
beginFlush(string, LibraryFlushOptionalParams)	Библиотека Flush
beginFlushAndWait(string, LibraryFlushOptionalParams)	Библиотека Flush
get(string, LibraryGetOptionalParams)	Получение библиотеки
getOperationResult(string, LibraryGetOperationResultOptionalParams)	Получение результата операции для библиотеки
list(LibraryListOptionalParams)	Список библиотеки.

Сведения о методе

append(string, RequestBodyType, LibraryAppendOptionalParams)

Добавьте содержимое в ресурс библиотеки, созданный с помощью операции создания. Максимальный размер содержимого — 4MiB. Содержимое размером более 4MiB должно быть добавлено в блоки 4MiB

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

Параметры

libraryName

string

имя файла для отправки. Минимальная длина имени файла должна составлять 1, за исключением длины расширения.

content

RequestBodyType

Блок файла библиотеки.

options

LibraryAppendOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

beginCreate(string, LibraryCreateOptionalParams)

Создает библиотеку с именем библиотеки.

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

Параметры

libraryName

string

имя файла для отправки. Минимальная длина имени файла должна составлять 1, за исключением длины расширения.

options

LibraryCreateOptionalParams

Параметры параметров.

Возвращаемое значение

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

beginCreateAndWait(string, LibraryCreateOptionalParams)

Создает библиотеку с именем библиотеки.

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

Параметры

libraryName

string

имя файла для отправки. Минимальная длина имени файла должна составлять 1, за исключением длины расширения.

options

LibraryCreateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

beginDelete(string, LibraryDeleteOptionalParams)

Удаление библиотеки

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

Параметры

libraryName

string

имя файла для отправки. Минимальная длина имени файла должна составлять 1, за исключением длины расширения.

options

LibraryDeleteOptionalParams

Параметры параметров.

Возвращаемое значение

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

beginDeleteAndWait(string, LibraryDeleteOptionalParams)

Удаление библиотеки

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

Параметры

libraryName

string

имя файла для отправки. Минимальная длина имени файла должна составлять 1, за исключением длины расширения.

options

LibraryDeleteOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

beginFlush(string, LibraryFlushOptionalParams)

Библиотека Flush

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

Параметры

libraryName

string

имя файла для отправки. Минимальная длина имени файла должна составлять 1, за исключением длины расширения.

options

LibraryFlushOptionalParams

Параметры параметров.

Возвращаемое значение

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

beginFlushAndWait(string, LibraryFlushOptionalParams)

Библиотека Flush

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

Параметры

libraryName

string

имя файла для отправки. Минимальная длина имени файла должна составлять 1, за исключением длины расширения.

options

LibraryFlushOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

get(string, LibraryGetOptionalParams)

Получение библиотеки

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

Параметры

libraryName

string

имя файла для отправки. Минимальная длина имени файла должна составлять 1, за исключением длины расширения.

options

LibraryGetOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<LibraryResource>

getOperationResult(string, LibraryGetOperationResultOptionalParams)

Получение результата операции для библиотеки

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

Параметры

operationId

string

идентификатор операции, для которого запрашивается состояние

options

LibraryGetOperationResultOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<LibraryResource>

list(LibraryListOptionalParams)

Список библиотеки.

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

Параметры

options

LibraryListOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<LibraryResource, LibraryResource[], PageSettings>