👁 Image
Azure.Storage.Files.Shares 12.27.0

Azure Storage File Shares client library for .NET

Server Version: 2021-02-12, 2020-12-06, 2020-10-02, 2020-08-04, 2020-06-12, 2020-04-08, 2020-02-10, 2019-12-12, 2019-07-07, and 2019-02-02

Azure File Shares offers fully managed file shares in the cloud that are accessible via the industry standard Server Message Block (SMB) protocol. Azure file shares can be mounted concurrently by cloud or on-premises deployments of Windows, Linux, and macOS. Additionally, Azure file shares can be cached on Windows Servers with Azure File Sync for fast access near where the data is being used.

Source code | Package (NuGet) | API reference documentation | REST API documentation | Product documentation

Getting started

Install the package

Install the Azure Storage File Shares client library for .NET with NuGet:

dotnet add package Azure.Storage.Files.Shares

Prerequisites

You need an Azure subscription and a Storage Account to use this package.

To create a new Storage Account, you can use the Azure Portal, Azure PowerShell, or the Azure CLI. Here's an example using the Azure CLI:

az storage account create --name MyStorageAccount --resource-group MyResourceGroup --location westus --sku Standard_LRS

Authenticate the client

In order to interact with the Azure Blobs Storage service, you'll need to create an instance of the ShareServiceClient class. The Azure Identity library makes it easy to add Azure Active Directory support for authenticating Azure SDK clients with their corresponding Azure services.

// Create a TokenCredential that we can use to authenticate
TokenCredential credential = new DefaultAzureCredential();

// Create a client that can authenticate with a TokenCredential
ShareServiceClient shareServiceClient = new ShareServiceClient(
 StorageAccountFileUri,
 credential);

Key concepts

Azure file shares can be used to:

• Completely replace or supplement traditional on-premises file servers or NAS devices.
• "Lift and shift" applications to the cloud that expect a file share to store file application or user data.
• Simplify new cloud development projects with shared application settings, diagnostic shares, and Dev/Test/Debug tool file shares.

Thread safety

We guarantee that all client instance methods are thread-safe and independent of each other (guideline). This ensures that the recommendation of reusing client instances is always safe, even across threads.

Additional concepts

Client options | Accessing the response | Long-running operations | Handling failures | Diagnostics | Mocking | Client lifetime

Examples

Create a share and upload a file

// Get a connection string to our Azure Storage account. You can
// obtain your connection string from the Azure Portal (click
// Access Keys under Settings in the Portal Storage account blade)
// or using the Azure CLI with:
//
// az storage account show-connection-string --name <account_name> --resource-group <resource_group>
//
// And you can provide the connection string to your application
// using an environment variable.
string connectionString = "<connection_string>";

// Name of the share, directory, and file we'll create
string shareName = "sample-share";
string dirName = "sample-dir";
string fileName = "sample-file";

// Path to the local file to upload
string localFilePath = @"<path_to_local_file>";

// Get a reference to a share and then create it
ShareClient share = new ShareClient(connectionString, shareName);
share.Create();

// Get a reference to a directory and create it
ShareDirectoryClient directory = share.GetDirectoryClient(dirName);
directory.Create();

// Get a reference to a file and upload it
ShareFileClient file = directory.GetFileClient(fileName);
using (FileStream stream = File.OpenRead(localFilePath))
{
 file.Create(stream.Length);
 file.UploadRange(
 new HttpRange(0, stream.Length),
 stream);
}

Download a file

string connectionString = "<connection_string>";

// Name of the share, directory, and file we'll download from
string shareName = "sample-share";
string dirName = "sample-dir";
string fileName = "sample-file";

// Path to the save the downloaded file
string localFilePath = @"<path_to_local_file>";

// Get a reference to the file
ShareClient share = new ShareClient(connectionString, shareName);
ShareDirectoryClient directory = share.GetDirectoryClient(dirName);
ShareFileClient file = directory.GetFileClient(fileName);

// Download the file
ShareFileDownloadInfo download = file.Download();
using (FileStream stream = File.OpenWrite(localFilePath))
{
 download.Content.CopyTo(stream);
}

Traverse a share

// Connect to the share
string connectionString = "<connection_string>";
string shareName = "sample-share";
ShareClient share = new ShareClient(connectionString, shareName);

// Track the remaining directories to walk, starting from the root
var remaining = new Queue<ShareDirectoryClient>();
remaining.Enqueue(share.GetRootDirectoryClient());
while (remaining.Count > 0)
{
 // Get all of the next directory's files and subdirectories
 ShareDirectoryClient dir = remaining.Dequeue();
 foreach (ShareFileItem item in dir.GetFilesAndDirectories())
 {
 // Print the name of the item
 Console.WriteLine(item.Name);

 // Keep walking down directories
 if (item.IsDirectory)
 {
 remaining.Enqueue(dir.GetSubdirectoryClient(item.Name));
 }
 }
}

Async APIs

We fully support both synchronous and asynchronous APIs.

string connectionString = "<connection_string>";

// Name of the share, directory, and file we'll download from
string shareName = "sample-share";
string dirName = "sample-dir";
string fileName = "sample-file";

// Path to the save the downloaded file
string localFilePath = @"<path_to_local_file>";

// Get a reference to the file
ShareClient share = new ShareClient(connectionString, shareName);
ShareDirectoryClient directory = share.GetDirectoryClient(dirName);
ShareFileClient file = directory.GetFileClient(fileName);

// Download the file
ShareFileDownloadInfo download = await file.DownloadAsync();
using (FileStream stream = File.OpenWrite(localFilePath))
{
 await download.Content.CopyToAsync(stream);
}

Troubleshooting

All Azure Storage File Shares service operations will throw a RequestFailedException on failure with helpful ErrorCodes. Many of these errors are recoverable. If multiple failures occur, an AggregateException will be thrown, containing each failure instance.

// Connect to the existing share
string connectionString = "<connection_string>";
string shareName = "sample-share";
ShareClient share = new ShareClient(connectionString, shareName);

try
{
 // Try to create the share again
 share.Create();
}
catch (RequestFailedException ex)
 when (ex.ErrorCode == ShareErrorCode.ShareAlreadyExists)
{
 // Ignore any errors if the share already exists
}

Next steps

Get started with our File samples:

1. Hello World: Upload files, download files, and traverse shares (or asynchronously)
2. Auth: Authenticate with connection strings, shared keys, and shared access signatures.

Contributing

See the Storage CONTRIBUTING.md for details on building, testing, and contributing to this library.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit cla.microsoft.com.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments.