azure-storage-blob\src\Blob\BlobRestProxy.php
You may obtain a copy of the License at https://github.com/azure/azure-storage-php/LICENSE
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
PHP version 5
- Author
- Azure Storage PHP SDK
- Category
- Microsoft
- Copyright
- 2016 Microsoft Corporation
- License
- https://github.com/azure/azure-storage-php/LICENSE
- Link
- https://github.com/azure/azure-storage-php
- Package
- MicrosoftAzure\Storage\Blob
\MicrosoftAzure\Storage\Blob\BlobRestProxy
- Implements
- Parent(s)
- \MicrosoftAzure\Storage\Common\Internal\ServiceRestProxy
- Author
- Azure Storage PHP SDK
- Category
- Microsoft
- Copyright
- 2016 Microsoft Corporation
- Inherited_from
- \MicrosoftAzure\Storage\Common\Internal\ServiceRestProxy
- License
- https://github.com/azure/azure-storage-php/LICENSE
- Link
- https://github.com/azure/azure-storage-php
Properties
Methods
__construct(\MicrosoftAzure\Storage\Common\Internal\Serialization\ISerializer $dataSerializer = null) : void
Initializes new RestProxy object.
Inherited from:Name | Type | Description |
---|---|---|
$dataSerializer | \MicrosoftAzure\Storage\Common\Internal\Serialization\ISerializer | The data serializer. |
abortCopy(string $container, string $blob, string $copyId, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : void
Abort a blob copy operation
abortCopyAsync(string $container, string $blob, string $copyId, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to abort a blob copy operation
acquireLease(string $container, string $blob, string $proposedLeaseId = null, integer $leaseDuration = null, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\LeaseResult
Establishes an exclusive write lock on a blob. To write to a locked blob, a client must provide a lease ID.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$proposedLeaseId | string | lease id when acquiring |
$leaseDuration | integer | the lease duration. A non-infinite lease can be between 15 and 60 seconds. Default is never to expire. |
$options | \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions | optional parameters |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\LeaseResult |
acquireLeaseAsync(string $container, string $blob, string $proposedLeaseId = null, integer $leaseDuration = null, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to establish an exclusive one-minute write lock on a blob.
To write to a locked blob, a client must provide a lease ID.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$proposedLeaseId | string | lease id when acquiring |
$leaseDuration | integer | the lease duration. A non-infinite lease can be between 15 and 60 seconds. Default is never to expire. |
$options | \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions | optional parameters |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
addMetadataHeaders(array $headers, array $metadata = null) : array
Adds metadata elements to headers array
Inherited from:Name | Type | Description |
---|---|---|
$headers | array | HTTP request headers |
$metadata | array | user specified metadata |
Type | Description |
---|---|
array |
addOptionalAccessConditionHeader(array $headers, $accessConditions = null) : array
Adds optional header to headers if set
Name | Type | Description |
---|---|---|
$headers | array | The array of request headers. |
$accessConditions |
Type | Description |
---|---|
array |
addOptionalHeader(array $headers, string $key, string $value) : void
Adds optional header.
Inherited from:Doesn't add the value if it satisfies empty().
Name | Type | Description |
---|---|---|
$headers | array | &$headers The HTTP header parameters. |
$key | string | The HTTP header name. |
$value | string | The HTTP header value. |
addOptionalQueryParam(array $queryParameters, string $key, string $value) : void
Adds optional query parameter.
Inherited from:Doesn't add the value if it satisfies empty().
Name | Type | Description |
---|---|---|
$queryParameters | array | &$queryParameters The query parameters. |
$key | string | The query variable name. |
$value | string | The query variable value. |
addOptionalSourceAccessConditionHeader(array $headers, $accessConditions = null) : array
Adds optional header to headers if set
Name | Type | Description |
---|---|---|
$headers | array | The array of request headers. |
$accessConditions |
Type | Description |
---|---|
array |
addPostParameter(array $postParameters, string $key, string $value) : array
Adds HTTP POST parameter to the specified
Inherited from:Name | Type | Description |
---|---|---|
$postParameters | array | An array of HTTP POST parameters. |
$key | string | The key of a HTTP POST parameter. |
$value | string | the value of a HTTP POST parameter. |
Type | Description |
---|---|
array |
appendBlock(string $container, string $blob, resource | string | \Psr\Http\Message\StreamInterface $content, \MicrosoftAzure\Storage\Blob\Models\AppendBlockOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\AppendBlockResult
Commits a new block of data to the end of an existing append blob.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$content | resource | string | \Psr\Http\Message\StreamInterface | the blob block contents |
$options | \MicrosoftAzure\Storage\Blob\Models\AppendBlockOptions | optional parameters |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\AppendBlockResult |
appendBlockAsync(string $container, string $blob, resource | string | \Psr\Http\Message\StreamInterface $content, \MicrosoftAzure\Storage\Blob\Models\AppendBlockOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to commit a new block of data to the end of an existing append blob.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$content | resource | string | \Psr\Http\Message\StreamInterface | the blob block contents |
$options | \MicrosoftAzure\Storage\Blob\Models\AppendBlockOptions | optional parameters |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
breakLease(string $container, string $blob, integer $breakPeriod = null, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\BreakLeaseResult
Ends the lease but ensure that another client cannot acquire a new lease until the current lease period has expired.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$breakPeriod | integer | the proposed duration of seconds that lease should continue before it it broken, between 0 and 60 seconds. |
$options | \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions | optional parameters |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\BreakLeaseResult |
breakLeaseAsync(string $container, string $blob, integer $breakPeriod = null, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to end the lease but ensure that another client cannot acquire a new lease until the current lease period has expired.
changeLease(string $container, string $blob, string $leaseId, string $proposedLeaseId, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\LeaseResult
change an existing lease
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$leaseId | string | lease id when acquiring |
$proposedLeaseId | string | lease id when acquiring |
$options | \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions | optional parameters |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\LeaseResult |
changeLeaseAsync(string $container, string $blob, string $leaseId, string $proposedLeaseId, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to change an existing lease
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$leaseId | string | lease id when acquiring |
$proposedLeaseId | string | the proposed lease id |
$options | \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions | optional parameters |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
clearBlobPages(string $container, string $blob, \MicrosoftAzure\Storage\Common\Models\Range $range, \MicrosoftAzure\Storage\Blob\Models\CreateBlobPagesOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\CreateBlobPagesResult
Clears a range of pages from the blob.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$range | \MicrosoftAzure\Storage\Common\Models\Range | Can be up to the value of the blob's full size. Note that ranges must be aligned to 512 (0-511, 512-1023) |
$options | \MicrosoftAzure\Storage\Blob\Models\CreateBlobPagesOptions | optional parameters |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\CreateBlobPagesResult |
clearBlobPagesAsync(string $container, string $blob, \MicrosoftAzure\Storage\Common\Models\Range $range, \MicrosoftAzure\Storage\Blob\Models\CreateBlobPagesOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to clear a range of pages from the blob.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$range | \MicrosoftAzure\Storage\Common\Models\Range | Can be up to the value of the blob's full size. Note that ranges must be aligned to 512 (0-511, 512-1023) |
$options | \MicrosoftAzure\Storage\Blob\Models\CreateBlobPagesOptions | optional parameters |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
commitBlobBlocks(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\BlockList | array<mixed,\MicrosoftAzure\Storage\Blob\Models\Block> $blockList, \MicrosoftAzure\Storage\Blob\Models\CommitBlobBlocksOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\PutBlobResult
This method writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior createBlobBlock method.
You can call Put Block List to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. You can do this by specifying whether to commit a block from the committed block list or from the uncommitted block list, or to commit the most recently uploaded version of the block, whichever list it may belong to.
Name | Type | Description |
---|---|---|
$container | string | The container name. |
$blob | string | The blob name. |
$blockList | \MicrosoftAzure\Storage\Blob\Models\BlockList | array<mixed,\MicrosoftAzure\Storage\Blob\Models\Block> | The block entries. |
$options | \MicrosoftAzure\Storage\Blob\Models\CommitBlobBlocksOptions | The optional parameters. |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\PutBlobResult |
commitBlobBlocksAsync(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\BlockList | array<mixed,\MicrosoftAzure\Storage\Blob\Models\Block> $blockList, \MicrosoftAzure\Storage\Blob\Models\CommitBlobBlocksOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
This method writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior createBlobBlock method.
You can call Put Block List to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. You can do this by specifying whether to commit a block from the committed block list or from the uncommitted block list, or to commit the most recently uploaded version of the block, whichever list it may belong to.
Name | Type | Description |
---|---|---|
$container | string | The container name. |
$blob | string | The blob name. |
$blockList | \MicrosoftAzure\Storage\Blob\Models\BlockList | array<mixed,\MicrosoftAzure\Storage\Blob\Models\Block> | The block entries. |
$options | \MicrosoftAzure\Storage\Blob\Models\CommitBlobBlocksOptions | The optional parameters. |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
copyBlob(string $destinationContainer, string $destinationBlob, string $sourceContainer, string $sourceBlob, \MicrosoftAzure\Storage\Blob\Models\CopyBlobOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\CopyBlobResult
Copies a source blob to a destination blob within the same storage account.
Name | Type | Description |
---|---|---|
$destinationContainer | string | name of the destination container |
$destinationBlob | string | name of the destination blob |
$sourceContainer | string | name of the source container |
$sourceBlob | string | name of the source blob |
$options | \MicrosoftAzure\Storage\Blob\Models\CopyBlobOptions | optional parameters |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\CopyBlobResult |
copyBlobAsync(string $destinationContainer, string $destinationBlob, string $sourceContainer, string $sourceBlob, \MicrosoftAzure\Storage\Blob\Models\CopyBlobOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to copy a source blob to a destination blob within the same storage account.
Name | Type | Description |
---|---|---|
$destinationContainer | string | name of the destination container |
$destinationBlob | string | name of the destination blob |
$sourceContainer | string | name of the source container |
$sourceBlob | string | name of the source blob |
$options | \MicrosoftAzure\Storage\Blob\Models\CopyBlobOptions | optional parameters |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
copyBlobFromURL(string $destinationContainer, string $destinationBlob, string $sourceURL, \MicrosoftAzure\Storage\Blob\Models\CopyBlobFromURLOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\CopyBlobResult
Copies from a source URL to a destination blob.
Name | Type | Description |
---|---|---|
$destinationContainer | string | name of the destination container |
$destinationBlob | string | name of the destination blob |
$sourceURL | string | URL of the source resource |
$options | \MicrosoftAzure\Storage\Blob\Models\CopyBlobFromURLOptions | optional parameters |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\CopyBlobResult |
copyBlobFromURLAsync(string $destinationContainer, string $destinationBlob, string $sourceURL, \MicrosoftAzure\Storage\Blob\Models\CopyBlobFromURLOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to copy from source URL to a destination blob.
Name | Type | Description |
---|---|---|
$destinationContainer | string | name of the destination container |
$destinationBlob | string | name of the destination blob |
$sourceURL | string | URL of the source resource |
$options | \MicrosoftAzure\Storage\Blob\Models\CopyBlobFromURLOptions | optional parameters |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
createAppendBlob(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\CreateBlobOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\PutBlobResult
Create a new append blob.
If the blob already exists on the service, it will be overwritten.
Name | Type | Description |
---|---|---|
$container | string | The container name. |
$blob | string | The blob name. |
$options | \MicrosoftAzure\Storage\Blob\Models\CreateBlobOptions | The optional parameters. |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\PutBlobResult |
createAppendBlobAsync(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\CreateBlobOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to create a new append blob.
If the blob already exists on the service, it will be overwritten.
Name | Type | Description |
---|---|---|
$container | string | The container name. |
$blob | string | The blob name. |
$options | \MicrosoftAzure\Storage\Blob\Models\CreateBlobOptions | The optional parameters. |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
createBlobBlock(string $container, string $blob, string $blockId, resource | string | \Psr\Http\Message\StreamInterface $content, \MicrosoftAzure\Storage\Blob\Models\CreateBlobBlockOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\PutBlockResult
Creates a new block to be committed as part of a block blob.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$blockId | string | must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. |
$content | resource | string | \Psr\Http\Message\StreamInterface | the blob block contents |
$options | \MicrosoftAzure\Storage\Blob\Models\CreateBlobBlockOptions | optional parameters |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\PutBlockResult |
createBlobBlockAsync(string $container, string $blob, string $blockId, resource | string | \Psr\Http\Message\StreamInterface $content, \MicrosoftAzure\Storage\Blob\Models\CreateBlobBlockOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates a new block to be committed as part of a block blob.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$blockId | string | must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. |
$content | resource | string | \Psr\Http\Message\StreamInterface | the blob block contents |
$options | \MicrosoftAzure\Storage\Blob\Models\CreateBlobBlockOptions | optional parameters |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
createBlobBlockHeader(\MicrosoftAzure\Storage\Blob\Models\CreateBlobBlockOptions $options = null) : array
create the header for createBlobBlock(s)
Name | Type | Description |
---|---|---|
$options | \MicrosoftAzure\Storage\Blob\Models\CreateBlobBlockOptions | the option of the request |
Type | Description |
---|---|
array |
createBlobBlockQueryParams(\MicrosoftAzure\Storage\Blob\Models\CreateBlobBlockOptions $options, string $blockId, boolean $isConcurrent = false) : array
create the query params for createBlobBlock(s)
Name | Type | Description |
---|---|---|
$options | \MicrosoftAzure\Storage\Blob\Models\CreateBlobBlockOptions | the option of the request |
$blockId | string | the block id of the block. |
$isConcurrent | boolean | if the query parameter is for concurrent upload. |
Type | Description |
---|---|
array | the constructed query parameters. |
createBlobPages(string $container, string $blob, \MicrosoftAzure\Storage\Common\Models\Range $range, string | resource | \Psr\Http\Message\StreamInterface $content, \MicrosoftAzure\Storage\Blob\Models\CreateBlobPagesOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\CreateBlobPagesResult
Creates a range of pages to a page blob.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$range | \MicrosoftAzure\Storage\Common\Models\Range | Can be up to 4 MB in size. Note that ranges must be aligned to 512 (0-511, 512-1023) |
$content | string | resource | \Psr\Http\Message\StreamInterface | the blob contents. |
$options | \MicrosoftAzure\Storage\Blob\Models\CreateBlobPagesOptions | optional parameters |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\CreateBlobPagesResult |
createBlobPagesAsync(string $container, string $blob, \MicrosoftAzure\Storage\Common\Models\Range $range, string | resource | \Psr\Http\Message\StreamInterface $content, \MicrosoftAzure\Storage\Blob\Models\CreateBlobPagesOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to create a range of pages to a page blob.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$range | \MicrosoftAzure\Storage\Common\Models\Range | Can be up to 4 MB in size. Note that ranges must be aligned to 512 (0-511, 512-1023) |
$content | string | resource | \Psr\Http\Message\StreamInterface | the blob contents. |
$options | \MicrosoftAzure\Storage\Blob\Models\CreateBlobPagesOptions | optional parameters |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
createBlobService(string $connectionString, array $options = array()) : \MicrosoftAzure\Storage\Blob\BlobRestProxy
Builds a blob service object, it accepts the following options:
- http: (array) the underlying guzzle options. refer to http://docs.guzzlephp.org/en/latest/request-options.html for detailed available options
- middlewares: (mixed) the middleware should be either an instance of a sub-class that
implements \MicrosoftAzure\Storage\Blob\MicrosoftAzure\Storage\Common\Middlewares\IMiddleware, or a
callable
that follows the Guzzle middleware implementation convention
Please refer to https://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string for how to construct a connection string with storage account name/key, or with a shared access signature (SAS Token).
Name | Type | Description |
---|---|---|
$connectionString | string | The configuration connection string. |
$options | array | Array of options to pass to the service |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\BlobRestProxy |
createBlobServiceWithTokenCredential(string $token, string $connectionString, array $options = array()) : \MicrosoftAzure\Storage\Blob\BlobRestProxy
Builds a blob service object, it accepts the following options:
- http: (array) the underlying guzzle options. refer to http://docs.guzzlephp.org/en/latest/request-options.html for detailed available options
- middlewares: (mixed) the middleware should be either an instance of a sub-class that
implements \MicrosoftAzure\Storage\Blob\MicrosoftAzure\Storage\Common\Middlewares\IMiddleware, or a
callable
that follows the Guzzle middleware implementation convention
Please refer to https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad for authenticate access to Azure blobs and queues using Azure Active Directory.
Name | Type | Description |
---|---|---|
$token | string | The bearer token passed as reference. |
$connectionString | string | The configuration connection string. |
$options | array | Array of options to pass to the service |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\BlobRestProxy |
createBlobSnapshot(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\CreateBlobSnapshotOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\CreateBlobSnapshotResult
Creates a snapshot of a blob.
createBlobSnapshotAsync(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\CreateBlobSnapshotOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to create a snapshot of a blob.
createBlockBlob(string $container, string $blob, string | resource | \Psr\Http\Message\StreamInterface $content, \MicrosoftAzure\Storage\Blob\Models\CreateBlockBlobOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\PutBlobResult
Creates a new block blob or updates the content of an existing block blob.
Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with createBlockBlob the content of the existing blob is overwritten with the content of the new blob. To perform a partial update of the content of a block blob, use the createBlockList method. Note that the default content type is application/octet-stream.
Name | Type | Description |
---|---|---|
$container | string | The name of the container. |
$blob | string | The name of the blob. |
$content | string | resource | \Psr\Http\Message\StreamInterface | The content of the blob. |
$options | \MicrosoftAzure\Storage\Blob\Models\CreateBlockBlobOptions | The optional parameters. |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\PutBlobResult |
createBlockBlobAsync(string $container, string $blob, string | resource | \Psr\Http\Message\StreamInterface $content, \MicrosoftAzure\Storage\Blob\Models\CreateBlockBlobOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates a promise to create a new block blob or updates the content of an existing block blob.
Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with createBlockBlob the content of the existing blob is overwritten with the content of the new blob. To perform a partial update of the content of a block blob, use the createBlockList method.
Name | Type | Description |
---|---|---|
$container | string | The name of the container. |
$blob | string | The name of the blob. |
$content | string | resource | \Psr\Http\Message\StreamInterface | The content of the blob. |
$options | \MicrosoftAzure\Storage\Blob\Models\CreateBlockBlobOptions | The optional parameters. |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
createBlockBlobByMultipleUploadAsync(string $container, string $blob, \Psr\Http\Message\StreamInterface $content, \MicrosoftAzure\Storage\Blob\Models\CreateBlockBlobOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
This method creates the blob blocks. This method will send the request concurrently for better performance.
Name | Type | Description |
---|---|---|
$container | string | Name of the container |
$blob | string | Name of the blob |
$content | \Psr\Http\Message\StreamInterface | Content's stream |
$options | \MicrosoftAzure\Storage\Blob\Models\CreateBlockBlobOptions | Array that contains all the option |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
createBlockBlobBySingleUploadAsync(string $container, string $blob, \Psr\Http\Message\StreamInterface $content, \MicrosoftAzure\Storage\Blob\Models\CreateBlobOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to create a new block blob or updates the content of an existing block blob. This only supports contents smaller than single upload threashold.
Updating an existing block blob overwrites any existing metadata on the blob.
Name | Type | Description |
---|---|---|
$container | string | The name of the container. |
$blob | string | The name of the blob. |
$content | \Psr\Http\Message\StreamInterface | The content of the blob. |
$options | \MicrosoftAzure\Storage\Blob\Models\CreateBlobOptions | The optional parameters. |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
createContainer(string $container, \MicrosoftAzure\Storage\Blob\Models\CreateContainerOptions $options = null) : void
Creates a new container in the given storage account.
createContainerAnonymousAccess(string $primaryServiceEndpoint, array $options = array()) : \MicrosoftAzure\Storage\Blob\BlobRestProxy
Builds an anonymous access object with given primary service endpoint. The service endpoint should contain a scheme and a host, e.g.: http://mystorageaccount.blob.core.windows.net
Name | Type | Description |
---|---|---|
$primaryServiceEndpoint | string | Primary service endpoint. |
$options | array | Optional request options. |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\BlobRestProxy |
createContainerAsync(string $container, \MicrosoftAzure\Storage\Blob\Models\CreateContainerOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates a new container in the given storage account.
createMiddlewareStack(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $serviceOptions) : \MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack
Create a middleware stack with given middleware.
Inherited from:Name | Type | Description |
---|---|---|
$serviceOptions | \MicrosoftAzure\Storage\Common\Models\ServiceOptions | The options user passed in. |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack |
createPageBlob(string $container, string $blob, integer $length, \MicrosoftAzure\Storage\Blob\Models\CreatePageBlobOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\PutBlobResult
Creates a new page blob. Note that calling createPageBlob to create a page blob only initializes the blob.
To add content to a page blob, call createBlobPages method.
Name | Type | Description |
---|---|---|
$container | string | The container name. |
$blob | string | The blob name. |
$length | integer | Specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary. |
$options | \MicrosoftAzure\Storage\Blob\Models\CreatePageBlobOptions | The optional parameters. |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\PutBlobResult |
createPageBlobAsync(string $container, string $blob, integer $length, \MicrosoftAzure\Storage\Blob\Models\CreatePageBlobOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to create a new page blob. Note that calling createPageBlob to create a page blob only initializes the blob.
To add content to a page blob, call createBlobPages method.
Name | Type | Description |
---|---|---|
$container | string | The container name. |
$blob | string | The blob name. |
$length | integer | Specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary. |
$options | \MicrosoftAzure\Storage\Blob\Models\CreatePageBlobOptions | The optional parameters. |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
createPageBlobFromContent(string $container, string $blob, integer $length, string | resource | \Psr\Http\Message\StreamInterface $content, \MicrosoftAzure\Storage\Blob\Models\CreatePageBlobFromContentOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\GetBlobPropertiesResult
Create a new page blob and upload the content to the page blob.
Name | Type | Description |
---|---|---|
$container | string | The name of the container. |
$blob | string | The name of the blob. |
$length | integer | The length of the blob. |
$content | string | resource | \Psr\Http\Message\StreamInterface | The content of the blob. |
$options | \MicrosoftAzure\Storage\Blob\Models\CreatePageBlobFromContentOptions | The optional parameters. |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\GetBlobPropertiesResult |
createPageBlobFromContentAsync(string $container, string $blob, integer $length, string | resource | \Psr\Http\Message\StreamInterface $content, \MicrosoftAzure\Storage\Blob\Models\CreatePageBlobFromContentOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates a promise to create a new page blob and upload the content to the page blob.
Name | Type | Description |
---|---|---|
$container | string | The name of the container. |
$blob | string | The name of the blob. |
$length | integer | The length of the blob. |
$content | string | resource | \Psr\Http\Message\StreamInterface | The content of the blob. |
$options | \MicrosoftAzure\Storage\Blob\Models\CreatePageBlobFromContentOptions | The optional parameters. |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
createRequest(string $method, array $headers, array $queryParams, array $postParameters, string $path, $locationMode, string $body = \MicrosoftAzure\Storage\Common\Internal\Resources::EMPTY_STRING) : \GuzzleHttp\Psr7\Request
Create the request to be sent.
Inherited from:Name | Type | Description |
---|---|---|
$method | string | The method of the HTTP request |
$headers | array | The header field of the request |
$queryParams | array | The query parameter of the request |
$postParameters | array | The HTTP POST parameters |
$path | string | URL path |
$locationMode | ||
$body | string | Request body |
Type | Description |
---|---|
\GuzzleHttp\Psr7\Request |
deleteBlob(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\DeleteBlobOptions $options = null) : void
Deletes a blob or blob snapshot.
Note that if the snapshot entry is specified in the $options then only this blob snapshot is deleted. To delete all blob snapshots, do not set Snapshot and just set getDeleteSnaphotsOnly to true.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$options | \MicrosoftAzure\Storage\Blob\Models\DeleteBlobOptions | optional parameters |
deleteBlobAsync(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\DeleteBlobOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to delete a blob or blob snapshot.
Note that if the snapshot entry is specified in the $options then only this blob snapshot is deleted. To delete all blob snapshots, do not set Snapshot and just set getDeleteSnaphotsOnly to true.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$options | \MicrosoftAzure\Storage\Blob\Models\DeleteBlobOptions | optional parameters |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
deleteContainer(string $container, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : void
Deletes a container in the given storage account.
deleteContainerAsync(string $container, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface
Create a promise for deleting a container.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$options | \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions | null | optional parameters |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
generateMetadataHeaders(array $metadata = null) : array
Generates metadata headers by prefixing each element with 'x-ms-meta'.
Inherited from:Name | Type | Description |
---|---|---|
$metadata | array | user defined metadata. |
Type | Description |
---|---|
array |
generateRequestOptions(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $serviceOptions, callable $handler) : array
Generate the request options using the given service options and stored information.
Inherited from:Name | Type | Description |
---|---|---|
$serviceOptions | \MicrosoftAzure\Storage\Common\Models\ServiceOptions | The service options used to generate request options. |
$handler | callable | The handler used to send the request. |
Type | Description |
---|---|
array |
getAccountName() : string
Gets the account name.
Inherited from:Type | Description |
---|---|
string |
getBlob(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\GetBlobOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\GetBlobResult
Reads or downloads a blob from the system, including its metadata and properties.
getBlobAsync(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\GetBlobOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to read or download a blob from the system, including its metadata and properties.
getBlobMetadata(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\GetBlobMetadataOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\GetBlobMetadataResult
Returns all properties and metadata on the blob.
getBlobMetadataAsync(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\GetBlobMetadataOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to return all properties and metadata on the blob.
getBlobProperties(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\GetBlobPropertiesOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\GetBlobPropertiesResult
Returns all properties and metadata on the blob.
getBlobPropertiesAsync(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\GetBlobPropertiesOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to return all properties and metadata on the blob.
getBlobUrl(string $container, string $blob) : string
Creates full URI to the given blob.
Name | Type | Description |
---|---|---|
$container | string | The container name. |
$blob | string | The blob name. |
Type | Description |
---|---|
string |
getContainerAcl(string $container, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\GetContainerACLResult
Gets the access control list (ACL) and any container-level access policies for the container.
getContainerAclAsync(string $container, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates the promise to get the access control list (ACL) and any container-level access policies for the container.
getContainerMetadata(string $container, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\GetContainerPropertiesResult
Returns only user-defined metadata for the specified container.
getContainerMetadataAsync(string $container, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Create promise to return only user-defined metadata for the specified container.
getContainerProperties(string $container, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\GetContainerPropertiesResult
Returns all properties and metadata on the container.
getContainerPropertiesAsync(string $container, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Create promise to return all properties and metadata on the container.
getMiddlewares() : array
Gets middlewares that will be handling the request and response.
Inherited from:Type | Description |
---|---|
array |
getPsrPrimaryUri() : \GuzzleHttp\Psr7\Uri
Get the primary URI in PSR form.
Inherited from:Type | Description |
---|---|
\GuzzleHttp\Psr7\Uri |
getPsrSecondaryUri() : \GuzzleHttp\Psr7\Uri
Get the secondary URI in PSR form.
Inherited from:Type | Description |
---|---|
\GuzzleHttp\Psr7\Uri |
getServiceProperties(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : \MicrosoftAzure\Storage\Common\Models\GetServicePropertiesResult
Gets the properties of the service.
Inherited from:getServicePropertiesAsync(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to get the properties of the service.
Inherited from:getServiceStats(\MicrosoftAzure\Storage\Common\Models\ServiceOptions | null $options = null) : \MicrosoftAzure\Storage\Common\Models\GetServiceStatsResult
Retrieves statistics related to replication for the service. The operation will only be sent to secondary location endpoint.
Inherited from:Name | Type | Description |
---|---|---|
$options | \MicrosoftAzure\Storage\Common\Models\ServiceOptions | null | The options this operation sends with. |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Common\Models\GetServiceStatsResult |
getServiceStatsAsync(\MicrosoftAzure\Storage\Common\Models\ServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise that retrieves statistics related to replication for the service. The operation will only be sent to secondary location endpoint.
Inherited from:Name | Type | Description |
---|---|---|
$options | \MicrosoftAzure\Storage\Common\Models\ServiceOptions | null | The options this operation sends with. |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
getSingleBlobUploadThresholdInBytes() : integer
Get the value for SingleBlobUploadThresholdInBytes
Type | Description |
---|---|
integer |
groupQueryValues(array $values) : string
Groups set of values into one value separated with Resources::SEPARATOR
Inherited from:Name | Type | Description |
---|---|---|
$values | array | array of values to be grouped. |
Type | Description |
---|---|
string |
listBlobBlocks(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\ListBlobBlocksOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\ListBlobBlocksResult
Retrieves the list of blocks that have been uploaded as part of a block blob.
There are two block lists maintained for a blob: 1) Committed Block List: The list of blocks that have been successfully committed to a given blob with commitBlobBlocks. 2) Uncommitted Block List: The list of blocks that have been uploaded for a blob using Put Block (REST API), but that have not yet been committed. These blocks are stored in Windows Azure in association with a blob, but do not yet form part of the blob.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$options | \MicrosoftAzure\Storage\Blob\Models\ListBlobBlocksOptions | optional parameters |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\ListBlobBlocksResult |
listBlobBlocksAsync(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\ListBlobBlocksOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to retrieve the list of blocks that have been uploaded as part of a block blob.
There are two block lists maintained for a blob: 1) Committed Block List: The list of blocks that have been successfully committed to a given blob with commitBlobBlocks. 2) Uncommitted Block List: The list of blocks that have been uploaded for a blob using Put Block (REST API), but that have not yet been committed. These blocks are stored in Windows Azure in association with a blob, but do not yet form part of the blob.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$options | \MicrosoftAzure\Storage\Blob\Models\ListBlobBlocksOptions | optional parameters |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
listBlobs(string $container, \MicrosoftAzure\Storage\Blob\Models\ListBlobsOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\ListBlobsResult
Lists all of the blobs in the given container.
listBlobsAsync(string $container, \MicrosoftAzure\Storage\Blob\Models\ListBlobsOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to list all of the blobs in the given container.
listContainers(\MicrosoftAzure\Storage\Blob\Models\ListContainersOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\ListContainersResult
Lists all of the containers in the given storage account.
listContainersAsync(\MicrosoftAzure\Storage\Blob\Models\ListContainersOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Create a promise for lists all of the containers in the given storage account.
Name | Type | Description |
---|---|---|
$options | \MicrosoftAzure\Storage\Blob\Models\ListContainersOptions | The optional parameters. |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
listPageBlobRanges(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\ListPageBlobRangesOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\ListPageBlobRangesResult
Returns a list of active page ranges for a page blob. Active page ranges are those that have been populated with data.
listPageBlobRangesAsync(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\ListPageBlobRangesOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to return a list of active page ranges for a page blob.
Active page ranges are those that have been populated with data.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$options | \MicrosoftAzure\Storage\Blob\Models\ListPageBlobRangesOptions | optional parameters |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
listPageBlobRangesDiff(string $container, string $blob, string $previousSnapshotTime, \MicrosoftAzure\Storage\Blob\Models\ListPageBlobRangesOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\ListPageBlobRangesDiffResult
Returns a list of page ranges that have been updated or cleared.
Returns a list of page ranges that have been updated or cleared since
the snapshot specified by previousSnapshotTime
. Gets all of the page
ranges by default, or only the page ranges over a specific range of
bytes if rangeStart
and rangeEnd
in the options
are specified.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$previousSnapshotTime | string | previous snapshot time
for comparison which
should be prior to the
snapshot time defined
in |
$options | \MicrosoftAzure\Storage\Blob\Models\ListPageBlobRangesOptions | optional parameters |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\ListPageBlobRangesDiffResult |
listPageBlobRangesDiffAsync(string $container, string $blob, string $previousSnapshotTime, \MicrosoftAzure\Storage\Blob\Models\ListPageBlobRangesOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to return a list of page ranges that have been updated or cleared.
Creates promise to return a list of page ranges that have been updated
or cleared since the snapshot specified by previousSnapshotTime
. Gets
all of the page ranges by default, or only the page ranges over a specific
range of bytes if rangeStart
and rangeEnd
in the options
are specified.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$previousSnapshotTime | string | previous snapshot time
for comparison which
should be prior to the
snapshot time defined
in |
$options | \MicrosoftAzure\Storage\Blob\Models\ListPageBlobRangesOptions | optional parameters |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
onRejected(string | \Exception $reason, array | integer $expected) : \Psr\Http\Message\ResponseInterface
Name | Type | Description |
---|---|---|
$reason | string | \Exception | Rejection reason. |
$expected | array | integer | Expected Status Codes. |
Type | Description |
---|---|
\Psr\Http\Message\ResponseInterface |
pushMiddleware(callable | \MicrosoftAzure\Storage\Common\Internal\IMiddleware $middleware) : void
Push a new middleware into the middlewares array. The newly added middleware will be the most inner middleware when executed.
Inherited from:Name | Type | Description |
---|---|---|
$middleware | callable | \MicrosoftAzure\Storage\Common\Internal\IMiddleware | the middleware to be added. |
releaseLease(string $container, string $blob, string $leaseId, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : void
Frees the lease if it is no longer needed so that another client may immediately acquire a lease against the blob.
releaseLeaseAsync(string $container, string $blob, string $leaseId, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to free the lease if it is no longer needed so that another client may immediately acquire a lease against the blob.
renewLease(string $container, string $blob, string $leaseId, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\LeaseResult
Renews an existing lease
renewLeaseAsync(string $container, string $blob, string $leaseId, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to renew an existing lease
saveBlobToFile(string $path, string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\GetBlobOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\GetBlobResult
Downloads a blob to a file, the result contains its metadata and properties. The result will not contain a stream pointing to the content of the file.
saveBlobToFileAsync(string $path, string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\GetBlobOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to download a blob to a file, the result contains its metadata and properties. The result will not contain a stream pointing to the content of the file.
Name | Type | Description |
---|---|---|
$path | string | The path and name of the file |
$container | string | name of the container |
$blob | string | name of the blob |
$options | \MicrosoftAzure\Storage\Blob\Models\GetBlobOptions | optional parameters |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
Exception | Description |
---|---|
\Exception |
sendAsync(string $method, array $headers, array $queryParams, array $postParameters, string $path, array | integer $expected = \MicrosoftAzure\Storage\Common\Internal\Resources::STATUS_OK, string $body = \MicrosoftAzure\Storage\Common\Internal\Resources::EMPTY_STRING, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $serviceOptions = null) : \GuzzleHttp\Promise\PromiseInterface
Create promise of sending HTTP request with the specified parameters.
Inherited from:Name | Type | Description |
---|---|---|
$method | string | HTTP method used in the request |
$headers | array | HTTP headers. |
$queryParams | array | URL query parameters. |
$postParameters | array | The HTTP POST parameters. |
$path | string | URL path |
$expected | array | integer | Expected Status Codes. |
$body | string | Request body |
$serviceOptions | \MicrosoftAzure\Storage\Common\Models\ServiceOptions | Service options |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
sendConcurrentAsync(callable $generator, integer $statusCode, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $options) : \GuzzleHttp\Promise\Promise | \GuzzleHttp\Promise\PromiseInterface
Send the requests concurrently. Number of concurrency can be modified by inserting a new key/value pair with the key 'number_of_concurrency' into the $requestOptions of $serviceOptions. Return only the promise.
Inherited from:Name | Type | Description |
---|---|---|
$generator | callable | the generator function to generate request upon fulfillment |
$statusCode | integer | The expected status code for each of the request generated by generator. |
$options | \MicrosoftAzure\Storage\Common\Models\ServiceOptions | The service options for the concurrent requests. |
Type | Description |
---|---|
\GuzzleHttp\Promise\Promise | \GuzzleHttp\Promise\PromiseInterface |
sendContext(\MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext $context) : \GuzzleHttp\Psr7\Response
Sends the context.
Inherited from:Name | Type | Description |
---|---|---|
$context | \MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext | The context of the request. |
Type | Description |
---|---|
\GuzzleHttp\Psr7\Response |
sendContextAsync(\MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext $context) : \GuzzleHttp\Promise\PromiseInterface
Creates the promise to send the context.
Inherited from:Name | Type | Description |
---|---|---|
$context | \MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext | The context of the request. |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
setBlobMetadata(string $container, string $blob, array $metadata, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\SetBlobMetadataResult
Sets metadata headers on the blob.
Name | Type | Description |
---|---|---|
$container | string | name of the container |
$blob | string | name of the blob |
$metadata | array | key/value pair representation |
$options | \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions | optional parameters |
Type | Description |
---|---|
\MicrosoftAzure\Storage\Blob\Models\SetBlobMetadataResult |
setBlobMetadataAsync(string $container, string $blob, array $metadata, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to set metadata headers on the blob.
setBlobProperties(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\SetBlobPropertiesOptions $options = null) : \MicrosoftAzure\Storage\Blob\Models\SetBlobPropertiesResult
Sets system properties defined for a blob.
setBlobPropertiesAsync(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\SetBlobPropertiesOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to set system properties defined for a blob.
setBlobTier(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\SetBlobTierOptions $options = null) : void
Sets blob tier on the blob.
setBlobTierAsync(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\SetBlobTierOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Sets blob tier on the blob.
setBlockSize(integer $val) : void
Set the value for block size, Max 100MB
Name | Type | Description |
---|---|---|
$val | integer | The max size for each block to be sent. |
setContainerAcl(string $container, \MicrosoftAzure\Storage\Blob\Models\ContainerACL $acl, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : void
Sets the ACL and any container-level access policies for the container.
setContainerAclAsync(string $container, \MicrosoftAzure\Storage\Blob\Models\ContainerACL $acl, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates promise to set the ACL and any container-level access policies for the container.
setContainerMetadata(string $container, array $metadata, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : void
Sets metadata headers on the container.
setContainerMetadataAsync(string $container, array $metadata, \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Sets metadata headers on the container.
setServiceProperties(\MicrosoftAzure\Storage\Common\Models\ServiceProperties $serviceProperties, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : void
Sets the properties of the service.
Inherited from:It's recommended to use getServiceProperties, alter the returned object and then use setServiceProperties with this altered object.
Name | Type | Description |
---|---|---|
$serviceProperties | \MicrosoftAzure\Storage\Common\Models\ServiceProperties | The service properties. |
$options | \MicrosoftAzure\Storage\Common\Models\ServiceOptions | The optional parameters. |
setServicePropertiesAsync(\MicrosoftAzure\Storage\Common\Models\ServiceProperties $serviceProperties, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
Creates the promise to set the properties of the service.
Inherited from:It's recommended to use getServiceProperties, alter the returned object and then use setServiceProperties with this altered object.
Name | Type | Description |
---|---|---|
$serviceProperties | \MicrosoftAzure\Storage\Common\Models\ServiceProperties | The service properties. |
$options | \MicrosoftAzure\Storage\Common\Models\ServiceOptions | The optional parameters. |
Type | Description |
---|---|
\GuzzleHttp\Promise\PromiseInterface |
setSingleBlobUploadThresholdInBytes(integer $val) : void
Set the value for SingleBlobUploadThresholdInBytes, Max 256MB
Name | Type | Description |
---|---|---|
$val | integer | The max size to send as a single blob block |
throwIfError(\Psr\Http\Message\ResponseInterface $response, array | integer $expected) : void
Throws ServiceException if the received status code is not expected.
Inherited from:Name | Type | Description |
---|---|---|
$response | \Psr\Http\Message\ResponseInterface | The response received |
$expected | array | integer | The expected status codes. |
Exception | Description |
---|---|
\MicrosoftAzure\Storage\Common\Exceptions\ServiceException |
undeleteBlob(string $container, string $blob, \MicrosoftAzure\Storage\Blob\Models\UndeleteBlobOptions $options = null) : void
Undeletes a blob.