Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Library

Package version

Interface representing a Library.

Hierarchy

  • Library

Implemented by

Index

Methods

Methods

append

  • append(libraryName: string, content: coreHttp.HttpRequestBody, options?: LibraryAppendOptionalParams): Promise<coreHttp.RestResponse>

  • Append the content to the library resource created using the create operation. The maximum content size is 4MiB. Content larger than 4MiB must be appended in 4MiB chunks

    Parameters

    • libraryName: string

      file name to upload. Minimum length of the filename should be 1 excluding the extension length.

    • content: coreHttp.HttpRequestBody

      Library file chunk.

    • Optional options: LibraryAppendOptionalParams

      The options parameters.

    Returns Promise<coreHttp.RestResponse>

create

  • create(libraryName: string, options?: coreHttp.OperationOptions): Promise<LROPoller<coreHttp.RestResponse>>

  • Creates a library with the library name.

    Parameters

    • libraryName: string

      file name to upload. Minimum length of the filename should be 1 excluding the extension length.

    • Optional options: coreHttp.OperationOptions

      The options parameters.

    Returns Promise<LROPoller<coreHttp.RestResponse>>

delete

  • delete(libraryName: string, options?: coreHttp.OperationOptions): Promise<LROPoller<coreHttp.RestResponse>>

  • Delete Library

    Parameters

    • libraryName: string

      file name to upload. Minimum length of the filename should be 1 excluding the extension length.

    • Optional options: coreHttp.OperationOptions

      The options parameters.

    Returns Promise<LROPoller<coreHttp.RestResponse>>

flush

  • flush(libraryName: string, options?: coreHttp.OperationOptions): Promise<LROPoller<coreHttp.RestResponse>>

  • Flush Library

    Parameters

    • libraryName: string

      file name to upload. Minimum length of the filename should be 1 excluding the extension length.

    • Optional options: coreHttp.OperationOptions

      The options parameters.

    Returns Promise<LROPoller<coreHttp.RestResponse>>

get

  • get(libraryName: string, options?: coreHttp.OperationOptions): Promise<LibraryGetResponse>

  • Get Library

    Parameters

    • libraryName: string

      file name to upload. Minimum length of the filename should be 1 excluding the extension length.

    • Optional options: coreHttp.OperationOptions

      The options parameters.

    Returns Promise<LibraryGetResponse>

getOperationResult

list

  • list(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<LibraryResource>

Generated using TypeDoc