Class ContainerClient

Package version

Hierarchy

StorageClient
- ContainerClient

Index

Constructors

constructor

Properties

Accessors

containerName

Methods

Constructors

constructor

new ContainerClient(connectionString: string, containerName: string, options: StoragePipelineOptions): ContainerClient
new ContainerClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options: StoragePipelineOptions): ContainerClient
new ContainerClient(url: string, pipeline: Pipeline): ContainerClient

Overrides StorageClient.constructor
- Defined in Clients.ts:5452
Parameters
- connectionString: string
- containerName: string
- Optional options: StoragePipelineOptions
Returns ContainerClient
Overrides StorageClient.constructor
- Defined in Clients.ts:5467
Parameters
- url: string
- Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
- Optional options: StoragePipelineOptions
Returns ContainerClient
Overrides StorageClient.constructor
- Defined in Clients.ts:5490
Parameters
- url: string
- pipeline: Pipeline
Returns ContainerClient

Properties

accountName

accountName: string

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Protected isHttps

isHttps: boolean

Protected storageClientContext

storageClientContext: StorageClientContext

url

url: string

Accessors

containerName

containerName:

Methods

create

create(options?: ContainerCreateOptions): Promise<ContainerCreateResponse>

- Defined in Clients.ts:5606
Parameters
- Default value options: ContainerCreateOptions = {}
Returns Promise<ContainerCreateResponse>

delete

delete(options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>

- Defined in Clients.ts:5776
Parameters
- Default value options: ContainerDeleteMethodOptions = {}
Returns Promise<ContainerDeleteResponse>

deleteBlob

deleteBlob(blobName: string, options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

- Defined in Clients.ts:6081
Parameters
- blobName: string
- Default value options: BlobDeleteOptions = {}
Returns Promise<BlobDeleteResponse>

Block blob deletion response data.

exists

exists(options?: ContainerExistsOptions): Promise<boolean>

- Defined in Clients.ts:5637
Parameters
- Default value options: ContainerExistsOptions = {}
Returns Promise<boolean>

getAccessPolicy

getAccessPolicy(options?: ContainerGetAccessPolicyOptions): Promise<ContainerGetAccessPolicyResponse>

- Defined in Clients.ts:5880
Parameters
- Default value options: ContainerGetAccessPolicyOptions = {}
Returns Promise<ContainerGetAccessPolicyResponse>

getAppendBlobClient

getAppendBlobClient(blobName: string): AppendBlobClient

- Defined in Clients.ts:5681
Parameters
- blobName: string
Returns AppendBlobClient

getBlobClient

getBlobClient(blobName: string): BlobClient

- Defined in Clients.ts:5670
Parameters
- blobName: string
Returns BlobClient

A new BlobClient object for the given blob name.

getBlobLeaseClient

getBlobLeaseClient(proposeLeaseId: undefined | string): BlobLeaseClient

- Defined in Clients.ts:6011
Parameters
- Optional proposeLeaseId: undefined | string
Returns BlobLeaseClient

A new BlobLeaseClient object for managing leases on the container.

getBlockBlobClient

getBlockBlobClient(blobName: string): BlockBlobClient

- Defined in Clients.ts:5704
Parameters
- blobName: string
Returns BlockBlobClient

getPageBlobClient

getPageBlobClient(blobName: string): PageBlobClient

- Defined in Clients.ts:5718
Parameters
- blobName: string
Returns PageBlobClient

getProperties

getProperties(options?: ContainerGetPropertiesOptions): Promise<ContainerGetPropertiesResponse>

- Defined in Clients.ts:5739
Parameters
- Default value options: ContainerGetPropertiesOptions = {}
Returns Promise<ContainerGetPropertiesResponse>

listBlobsByHierarchy

listBlobsByHierarchy(delimiter: string, options?: ContainerListBlobsOptions): PagedAsyncIterableIterator<object & BlobPrefix | object & BlobItem, ContainerListBlobHierarchySegmentResponse>

- Defined in Clients.ts:6497
Parameters
- delimiter: string
- Default value options: ContainerListBlobsOptions = {}
Returns PagedAsyncIterableIterator<object & BlobPrefix | object & BlobItem, ContainerListBlobHierarchySegmentResponse>

{(PagedAsyncIterableIterator< { kind: "prefix" } & BlobPrefix | { kind: "blob" } & BlobItem, ContainerListBlobHierarchySegmentResponse

)}

listBlobsFlat

listBlobsFlat(options?: ContainerListBlobsOptions): PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse>

- Defined in Clients.ts:6296
Parameters
- Default value options: ContainerListBlobsOptions = {}
Returns PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse>

An asyncIterableIterator that supports paging.

setAccessPolicy

setAccessPolicy(access: PublicAccessType, containerAcl: SignedIdentifier[], options?: ContainerSetAccessPolicyOptions): Promise<ContainerSetAccessPolicyResponse>

- Defined in Clients.ts:5958
Parameters
- Optional access: PublicAccessType
- Optional containerAcl: SignedIdentifier[]
- Default value options: ContainerSetAccessPolicyOptions = {}
Returns Promise<ContainerSetAccessPolicyResponse>

setMetadata

setMetadata(metadata: Metadata, options?: ContainerSetMetadataOptions): Promise<ContainerSetMetadataResponse>

- Defined in Clients.ts:5827
Parameters
- Optional metadata: Metadata
- Default value options: ContainerSetMetadataOptions = {}
Returns Promise<ContainerSetMetadataResponse>

uploadBlockBlob

uploadBlockBlob(blobName: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions): Promise<object>

- Defined in Clients.ts:6038
Parameters
- blobName: string
- body: HttpRequestBody
- contentLength: number
- Default value options: BlockBlobUploadOptions = {}
Returns Promise<object>

} Block Blob upload response data and the corresponding BlockBlobClient instance.

Generated using TypeDoc