BlockBlobClient
in package
FinalYes
Provides staged upload operations for an Azure Storage block blob.
Table of Contents
Properties
- $blobName : string
- $containerName : string
- $credential : StorageSharedKeyCredential|TokenCredential|null
- $uri : UriInterface
- $client : Client
- $options : BlockBlobClientOptions
Methods
- __construct() : mixed
- commitBlockList() : void
- Commits an ordered list of staged block IDs as the blob's content.
- commitBlockListAsync() : PromiseInterface
- Asynchronously commits an ordered list of staged block IDs.
- stageBlock() : void
- Stages a block for later inclusion in the blob's committed block list.
- stageBlockAsync() : PromiseInterface
- Asynchronously stages a block for later commitment.
- withSnapshot() : self
- Creates a block blob client that targets the specified snapshot without making a service request.
- withVersion() : self
- Creates a block blob client that targets the specified blob version without making a service request.
Properties
$blobName read-only
public
string
$blobName
$containerName read-only
public
string
$containerName
$credential read-only
public
StorageSharedKeyCredential|TokenCredential|null
$credential
= null
$uri read-only
public
UriInterface
$uri
$client read-only
private
Client
$client
$options read-only
private
BlockBlobClientOptions
$options
= new BlockBlobClientOptions()
Methods
__construct()
public
__construct(UriInterface $uri[, StorageSharedKeyCredential|TokenCredential|null $credential = null ][, BlockBlobClientOptions $options = new BlockBlobClientOptions() ]) : mixed
Parameters
- $uri : UriInterface
- $credential : StorageSharedKeyCredential|TokenCredential|null = null
- $options : BlockBlobClientOptions = new BlockBlobClientOptions()
Tags
commitBlockList()
Commits an ordered list of staged block IDs as the blob's content.
public
commitBlockList(array<string|int, string> $base64BlockIds[, CommitBlockListOptions $options = new CommitBlockListOptions() ]) : void
Parameters
- $base64BlockIds : array<string|int, string>
- $options : CommitBlockListOptions = new CommitBlockListOptions()
commitBlockListAsync()
Asynchronously commits an ordered list of staged block IDs.
public
commitBlockListAsync(array<string|int, string> $base64BlockIds[, CommitBlockListOptions $options = new CommitBlockListOptions() ]) : PromiseInterface
Parameters
- $base64BlockIds : array<string|int, string>
- $options : CommitBlockListOptions = new CommitBlockListOptions()
Return values
PromiseInterfacestageBlock()
Stages a block for later inclusion in the blob's committed block list.
public
stageBlock(string $base64BlockId, StreamInterface|string $content[, StageBlockOptions $options = new StageBlockOptions() ]) : void
Parameters
- $base64BlockId : string
- $content : StreamInterface|string
- $options : StageBlockOptions = new StageBlockOptions()
stageBlockAsync()
Asynchronously stages a block for later commitment.
public
stageBlockAsync(string $base64BlockId, StreamInterface|string $content[, StageBlockOptions $options = new StageBlockOptions() ]) : PromiseInterface
Parameters
- $base64BlockId : string
- $content : StreamInterface|string
- $options : StageBlockOptions = new StageBlockOptions()
Return values
PromiseInterfacewithSnapshot()
Creates a block blob client that targets the specified snapshot without making a service request.
public
withSnapshot(string|null $snapshot) : self
Parameters
- $snapshot : string|null
Return values
selfwithVersion()
Creates a block blob client that targets the specified blob version without making a service request.
public
withVersion(string|null $versionId) : self
Parameters
- $versionId : string|null