microsoft/azure-storage

This project provides a set of PHP client libraries that make it easy to access Microsoft Azure storage APIs.

Microsoft Azure Storage PHP Client Libraries (Deprecated)

This project will be in Community Support until 17 March 2024. After this date the project and associated client libraries will be retired permanently. For more details on the retirement and alternatives to using this project, visit Retirement notice: The Azure Storage PHP client libraries will be retired on 17 March 2024., _(*1)

This project provides a set of PHP client libraries that make it easy to access Microsoft Azure Storage services (blobs, tables, queues and files). For documentation on how to host PHP applications on Microsoft Azure, please see the Microsoft Azure PHP Developer Center., _(*2)

• azure-storage-blob
• azure-storage-table
• azure-storage-queue
• azure-storage-file
• azure-storage-common

Note, _(*3)

• If you are looking for the Service Bus, Service Runtime, Service Management or Media Services libraries, please visit Azure SDK for PHP.
• If you need big file (larger than 2GB) or 64-bit integer support, please install PHP 7 64-bit version.

Features

• Blobs
  • create, list, and delete containers, work with container metadata and permissions, list blobs in container
  • create block and page blobs (from a stream or a string), work with blob blocks and pages, delete blobs
  • work with blob properties, metadata, leases, snapshot a blob
• Tables
  • create and delete tables
  • create, query, insert, update, merge, and delete entities
  • batch operations
• Queues
  • create, list, and delete queues, and work with queue metadata and properties
  • create, get, peek, update, delete messages
• Files
  • create, list, and delete file shares and directories
  • create, delete and download files

Please check details on API reference documents., _(*4)

Minimum Requirements

• PHP 5.6 or above
• See composer.json for dependencies

• Required extension for PHP:, _(*5)

  • php_fileinfo.dll
  • php_mbstring.dll
  • php_openssl.dll
  • php_xsl.dll

• Recommended extension for PHP:, _(*6)

  • php_curl.dll

Download Source Code

To get the source code from GitHub, type, _(*7)

git clone https://github.com/Azure/azure-storage-php.git
cd ./azure-storage-php

Install via Composer

1. Create a file named composer.json in the root of your project and add the following code to it:

{
  "require": {
    "microsoft/azure-storage-blob": "*",
    "microsoft/azure-storage-table": "*",
    "microsoft/azure-storage-queue": "*",
    "microsoft/azure-storage-file": "*"
  }
}

1. Download composer.phar in your project root., _(*8)

2. Open a command prompt and execute this in your project root, _(*9)

php composer.phar install

Usage

There are four basic steps that have to be performed before you can make a call to any Microsoft Azure Storage API when using the libraries., _(*10)

• First, include the autoloader script:

require_once "vendor/autoload.php"; 

• Include the namespaces you are going to use., _(*11)

  To create any Microsoft Azure service client you need to use the rest proxy classes, such as BlobRestProxy class:, _(*12)

use MicrosoftAzure\Storage\Blob\BlobRestProxy;

To process exceptions you need:, _(*13)

use MicrosoftAzure\Storage\Common\ServiceException;

• To instantiate the service client you will also need a valid connection string. The format is:

DefaultEndpointsProtocol=[http|https];AccountName=[yourAccount];AccountKey=[yourKey]

Or:, _(*14)

BlobEndpoint=myBlobEndpoint;QueueEndpoint=myQueueEndpoint;TableEndpoint=myTableEndpoint;FileEndpoint=myFileEndpoint;SharedAccessSignature=sasToken

Or if AAD authentication is used:, _(*15)

BlobEndpoint=myBlobEndpoint;QueueEndpoint=myQueueEndpoint;TableEndpoint=myTableEndpoint;FileEndpoint=myFileEndpoint;AccountName=[yourAccount]

Note that account name is required., _(*16)

• Instantiate a client object - a wrapper around the available calls for the given service.

$blobClient = BlobRestProxy::createBlobService($connectionString);
$tableClient = TableRestProxy::createTableService($connectionString);
$queueClient = QueueRestProxy::createQueueService($connectionString);
$fileClient = FileRestProxy::createFileService($connectionString);

Or for AAD authentication:, _(*17)

$blobClient = BlobRestProxy::createBlobServiceWithTokenCredential($token, $connectionString);
$queueClient = QueueRestProxy::createQueueServiceWithTokenCredential($token, $connectionString);

Note that Blob and Queue service supports AAD authentication., _(*18)

Using Middlewares

To specify the middlewares, user have to create an array with middlewares and put it in the $requestOptions with key 'middlewares'. The sequence of the array will affect the sequence in which the middleware is invoked. The $requestOptions can usually be set in the options of an API call, such as MicrosoftAzure\Storage\Blob\Models\ListBlobOptions., _(*19)

The user can push the middleware into the array with key 'middlewares' in services' $_options instead when creating them if the middleware is to be applied to each of the API call for a rest proxy. These middlewares will always be invoked after the middlewares in the $requestOptions. e.g.:, _(*20)

$tableClient = TableRestProxy::createTableService(
    $connectionString,
    $optionsWithMiddlewares
);

Each of the middleware should be either an instance of a sub-class that implements MicrosoftAzure\Storage\Common\Internal\IMiddleware, or a callable that follows the Guzzle middleware implementation convention., _(*21)

User can create self-defined middleware that inherits from MicrosoftAzure\Storage\Common\Internal\Middlewares\MiddlewareBase., _(*22)

Retrying failures

You can use bundled middlewares to retry requests in case they fail for some reason. First you create the middleware:, _(*23)

$retryMiddleware = RetryMiddlewareFactory::create(
    RetryMiddlewareFactory::GENERAL_RETRY_TYPE,  // Specifies the retry logic
    3,  // Number of retries
    1000,  // Interval
    RetryMiddlewareFactory::EXPONENTIAL_INTERVAL_ACCUMULATION,  // How to increase the wait interval
    true  // Whether to retry connection failures too, default false
);

Then you add the middleware when creating the service as explained above:, _(*24)

$optionsWithMiddlewares = [
    'middlewares' = [
        $retryMiddleware
    ],
];
$tableClient = TableRestProxy::createTableService(
    $connectionString,
    $optionsWithMiddlewares
);

Or by pushing it to the existing service:, _(*25)

$tableClient->pushMiddleware($retryMiddleware);

Following errors are not retried in current retry middleware:, _(*26)

• Authentication failures.
• "Resource Not Found" errors.
• Guzzle request exceptions that does not bear an HTTP response, e.g. failed to open stream, or cURL Connection reset by peer, etc. Note: Community contribution to cover the Guzzle request exceptions are welcomed.

Retry types

• RetryMiddlewareFactory::GENERAL_RETRY_TYPE - General type of logic that handles retry
• RetryMiddlewareFactory::APPEND_BLOB_RETRY_TYPE * For the append blob retry only, currently the same as the general type

Interval accumulations

• RetryMiddlewareFactory::LINEAR_INTERVAL_ACCUMULATION - The interval will be increased linearly, the nth retry will have a wait time equal to n * interval
• RetryMiddlewareFactory::EXPONENTIAL_INTERVAL_ACCUMULATION - The interval will be increased exponentially, the nth retry will have a wait time equal to pow(2, n) * interval

Using proxies

To use proxies during HTTP requests, set system variable HTTP_PROXY and the proxy will be used., _(*27)

Troubleshooting

Error: Unable to get local issuer certificate

cURL can't verify the validity of Microsoft certificate when trying to issue a request call to Azure Storage Services. You must configure cURL to use a certificate when issuing https requests by the following steps:, _(*28)

1. Download the cacert.pem file from cURL site., _(*29)

2. Then either:, _(*30)

   • Open your php.ini file and add the following line:, _(*31)

     curl.cainfo = "<absolute path to cacert.pem>"
     

     OR, _(*32)

   • Point to the cacert in the options when creating the Relevant Proxy., _(*33)

     //example of creating the FileRestProxy
     $options["http"] = ["verify" => "<absolute path to cacert.pem>"];
     FileRestProxy::createFileService($connectionString, $options);
     

Code samples

You can find samples in the samples folder., _(*34)

Migrate from Azure SDK for PHP

If you are using Azure SDK for PHP to access Azure Storage Service, we highly recommend you to migrate to this SDK for faster issue resolution and quicker feature implementation. We are working on supporting the latest service features as well as improvement on existing APIs., _(*35)

For now, Microsoft Azure Storage PHP client libraries share almost the same interface as the storage blobs, tables, queues and files APIs in Azure SDK for PHP. However, there are some minor breaking changes need to be addressed during your migration. You can find the details in BreakingChanges.md., _(*36)

Need Help?

Be sure to check out the Microsoft Azure Developer Forums on Stack Overflow and github issues if you have trouble with the provided code., _(*37)

Please note this project will be in Community Support and Azure Storage team commits to validate and release every quarter, as long as there are PRs from community. Azure Storage team is unable to continue to add new features or provide bugfixes., _(*38)

Contribute Code or Provide Feedback

If you would like to become an active contributor to this project please follow the instructions provided in Azure Projects Contribution Guidelines. You can find more details for contributing in the CONTRIBUTING.md., _(*39)

If you encounter any bugs with the library please file an issue in the Issues section of the project., _(*40)