Package version:

Interface Library

Interface representing a Library.

Hierarchy

Library

Index

Methods

append beginCreate beginCreateAndWait beginDelete beginDeleteAndWait beginFlush beginFlushAndWait get getOperationResult list

Methods

append

append(libraryName: string, content: RequestBodyType, options?: LibraryAppendOptionalParams): Promise<void>
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: RequestBodyType
  
  Library file chunk.
- Optional options: LibraryAppendOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/library.ts:122

beginCreate

beginCreate(libraryName: string, options?: LibraryCreateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
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: LibraryCreateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/library.ts:100

beginCreateAndWait

beginCreateAndWait(libraryName: string, options?: LibraryCreateOptionalParams): Promise<void>
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: LibraryCreateOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/library.ts:110

beginDelete

beginDelete(libraryName: string, options?: LibraryDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Delete Library
Parameters
- libraryName: string
  
  file name to upload. Minimum length of the filename should be 1 excluding the extension length.
- Optional options: LibraryDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/library.ts:70

beginDeleteAndWait

beginDeleteAndWait(libraryName: string, options?: LibraryDeleteOptionalParams): Promise<void>
Delete Library
Parameters
- libraryName: string
  
  file name to upload. Minimum length of the filename should be 1 excluding the extension length.
- Optional options: LibraryDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/library.ts:80

beginFlush

beginFlush(libraryName: string, options?: LibraryFlushOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Flush Library
Parameters
- libraryName: string
  
  file name to upload. Minimum length of the filename should be 1 excluding the extension length.
- Optional options: LibraryFlushOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/library.ts:41

beginFlushAndWait

beginFlushAndWait(libraryName: string, options?: LibraryFlushOptionalParams): Promise<void>
Flush Library
Parameters
- libraryName: string
  
  file name to upload. Minimum length of the filename should be 1 excluding the extension length.
- Optional options: LibraryFlushOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/library.ts:51

get

get(libraryName: string, options?: LibraryGetOptionalParams): Promise<LibraryResource>
Get Library
Parameters
- libraryName: string
  
  file name to upload. Minimum length of the filename should be 1 excluding the extension length.
- Optional options: LibraryGetOptionalParams
  
  The options parameters.
Returns Promise<LibraryResource>
- Defined in operationsInterfaces/library.ts:90

getOperationResult

getOperationResult(operationId: string, options?: LibraryGetOperationResultOptionalParams): Promise<LibraryResource>
Get Operation result for Library
Parameters
- operationId: string
  
  operation id for which status is requested
- Optional options: LibraryGetOperationResultOptionalParams
  
  The options parameters.
Returns Promise<LibraryResource>
- Defined in operationsInterfaces/library.ts:60

list

list(options?: LibraryListOptionalParams): PagedAsyncIterableIterator<LibraryResource>
Lists Library.
Parameters
- Optional options: LibraryListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<LibraryResource>
- Defined in operationsInterfaces/library.ts:32

Interface Library

Hierarchy

Index

Methods

Methods

append

Parameters

libraryName: string

content: RequestBodyType

Optional options: LibraryAppendOptionalParams

Returns Promise<void>

beginCreate

Parameters

libraryName: string

Optional options: LibraryCreateOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginCreateAndWait

Parameters

libraryName: string

Optional options: LibraryCreateOptionalParams

Returns Promise<void>

beginDelete

Parameters

libraryName: string

Optional options: LibraryDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

libraryName: string

Optional options: LibraryDeleteOptionalParams

Returns Promise<void>

beginFlush

Parameters

libraryName: string

Optional options: LibraryFlushOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginFlushAndWait

Parameters

libraryName: string

Optional options: LibraryFlushOptionalParams

Returns Promise<void>

get

Parameters

libraryName: string

Optional options: LibraryGetOptionalParams

Returns Promise<LibraryResource>

getOperationResult

Parameters

operationId: string

Optional options: LibraryGetOperationResultOptionalParams

Returns Promise<LibraryResource>

list

Parameters

Optional options: LibraryListOptionalParams

Returns PagedAsyncIterableIterator<LibraryResource>

Settings

Member Visibility

Theme

`Optional` options: LibraryAppendOptionalParams

`Optional` options: LibraryCreateOptionalParams

`Optional` options: LibraryCreateOptionalParams

`Optional` options: LibraryDeleteOptionalParams

`Optional` options: LibraryDeleteOptionalParams

`Optional` options: LibraryFlushOptionalParams

`Optional` options: LibraryFlushOptionalParams

`Optional` options: LibraryGetOptionalParams

`Optional` options: LibraryGetOperationResultOptionalParams

`Optional` options: LibraryListOptionalParams