Quickstart

Prerequisites

• A storage account connection string
• An existing blob container (for example: quickstart)

If you want to authenticate without account keys (recommended for production), see Microsoft Entra ID.

For local testing you can export:

export AZURE_STORAGE_CONNECTION_STRING="DefaultEndpointsProtocol=...;AccountName=...;AccountKey=...;EndpointSuffix=core.windows.net"
export AZURE_STORAGE_CONTAINER="quickstart"

Create The Filesystem

<?php

use AzureOss\Storage\Blob\BlobServiceClient;
use AzureOss\Storage\BlobFlysystem\AzureBlobStorageAdapter;
use League\Flysystem\Filesystem;

$service = BlobServiceClient::fromConnectionString(
    getenv('AZURE_STORAGE_CONNECTION_STRING')
);

$container = $service->getContainerClient(
    getenv('AZURE_STORAGE_CONTAINER')
);

$adapter = new AzureBlobStorageAdapter($container);
$filesystem = new Filesystem($adapter);

Basic Operations

// Write
$filesystem->write('docs/hello.txt', 'Hello Azure Blob + Flysystem');

// Read
$contents = $filesystem->read('docs/hello.txt');

// Stream upload
$stream = fopen('/path/to/big-file.zip', 'r');
$filesystem->writeStream('archives/big-file.zip', $stream);
fclose($stream);

// List recursively
foreach ($filesystem->listContents('docs', true) as $item) {
    echo $item->path().PHP_EOL;
}

// Delete
$filesystem->delete('docs/hello.txt');

Upload Options (HTTP Headers)

You can pass Azure upload options via Flysystem Config, including HTTP headers like Cache-Control:

use League\Flysystem\Config;

$css = 'body { color: #0f172a; }';

$filesystem->write(
    'assets/app.css',
    $css,
    new Config([
        'httpHeaders' => [
            'cacheControl' => 'public, max-age=31536000',
            'contentType' => 'text/css',
        ],
    ])
);

Supported httpHeaders keys:

• cacheControl
• contentDisposition
• contentEncoding
• contentHash
• contentLanguage
• contentType

The adapter also supports these upload tuning keys:

• initialTransferSize (int)
• maximumTransferSize (int)
• maximumConcurrency (int)

Public And Temporary URLs

By default, publicUrl() generates a long-lived SAS URL.
If your container is publicly accessible, set isPublicContainer: true to return the direct blob URL.

use League\Flysystem\Config;

$adapter = new AzureBlobStorageAdapter(
    $container,
    isPublicContainer: true
);

$directPublicUrl = $adapter->publicUrl('images/logo.png', new Config());

Temporary SAS URLs:

use DateTimeImmutable;
use League\Flysystem\Config;

$temporaryUrl = $adapter->temporaryUrl(
    'exports/report.csv',
    new DateTimeImmutable('+15 minutes'),
    new Config(['permissions' => 'r'])
);

Notes

• Azure Blob Storage does not support Unix-style visibility metadata. Calling setVisibility() throws by default.
• Azure Blob Storage does not have real directories; directory operations are path-prefix based.
• SAS-based URLs (temporaryUrl() and non-public publicUrl()) require credentials that can sign SAS tokens.