Azure.Storage.Files.Shares 12.18.0-beta.2

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
This is a prerelease version of Azure.Storage.Files.Shares.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Azure.Storage.Files.Shares --version 12.18.0-beta.2
NuGet\Install-Package Azure.Storage.Files.Shares -Version 12.18.0-beta.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Azure.Storage.Files.Shares" Version="12.18.0-beta.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Azure.Storage.Files.Shares --version 12.18.0-beta.2
#r "nuget: Azure.Storage.Files.Shares, 12.18.0-beta.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Azure.Storage.Files.Shares as a Cake Addin
#addin nuget:?package=Azure.Storage.Files.Shares&version=12.18.0-beta.2&prerelease

// Install Azure.Storage.Files.Shares as a Cake Tool
#tool nuget:?package=Azure.Storage.Files.Shares&version=12.18.0-beta.2&prerelease

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

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.

// 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 opencode@microsoft.com with any additional questions or comments.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (43)

Showing the top 5 NuGet packages that depend on Azure.Storage.Files.Shares:

Package Downloads
AspNetCore.HealthChecks.AzureStorage

HealthChecks.AzureStorage is the health check package for Blobs, Tables and Queues.

Rystem.Content.Infrastructure.Storage.File

Rystem.Content helps you to integrate with azure services or to create an abstraction layer among your infrastructure and your business.

Microsoft.Azure.Workflows.WebJobs.Extension The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Extensions for running workflows in Azure Functions

Service.Extensions.Azure.Storage.Files.Shares The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Extensions to provide consistent configurations and patterns for your service.

Xenhey.BPM.Core.DotNet

Package Description

GitHub repositories (9)

Showing the top 5 popular GitHub repositories that depend on Azure.Storage.Files.Shares:

Repository Stars
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
Xabaril/AspNetCore.Diagnostics.HealthChecks
Enterprise HealthChecks for ASP.NET Core Diagnostics Package
stryker-mutator/stryker-net
Mutation testing for .NET core and .NET framework!
WireMock-Net/WireMock.Net
WireMock.Net is a flexible product for stubbing and mocking web HTTP responses using advanced request matching and response templating. Based on the functionality from http://WireMock.org, but extended with more functionality.
elastic/apm-agent-dotnet
Elastic APM .NET Agent
Version Downloads Last updated
12.18.0 19,522 5/14/2024
12.18.0-beta.2 1,528 4/16/2024
12.18.0-beta.1 15,542 12/5/2023
12.17.1 1,753,154 11/14/2023
12.17.0 77,535 11/6/2023
12.17.0-beta.1 21,652 10/16/2023
12.16.0 463,376 9/12/2023
12.16.0-beta.1 2,788 8/8/2023
12.15.0 1,602,523 7/11/2023
12.15.0-beta.1 2,187 5/30/2023
12.14.0 856,351 4/11/2023
12.14.0-beta.1 902 3/28/2023
12.13.1 162,326 3/24/2023
12.13.0 317,990 2/22/2023
12.13.0-beta.1 531 2/8/2023
12.12.1 1,374,581 10/25/2022
12.12.0 209,452 10/12/2022
12.12.0-beta.1 1,705 8/23/2022
12.11.0 5,511,146 7/8/2022
12.11.0-beta.1 1,578 6/15/2022
12.10.0 712,583 5/2/2022
12.10.0-beta.1 571 4/12/2022
12.9.0 833,779 3/10/2022
12.9.0-beta.3 12,308 2/7/2022
12.9.0-beta.2 4,988 11/30/2021
12.9.0-beta.1 5,305 11/4/2021
12.8.0 3,960,854 9/9/2021
12.8.0-beta.2 3,592 7/23/2021
12.8.0-beta.1 217 7/23/2021
12.7.0 960,736 6/9/2021
12.7.0-beta.4 3,068 5/12/2021
12.7.0-beta.3 3,817 4/9/2021
12.7.0-beta.2 2,339 3/10/2021
12.7.0-beta.1 4,382 2/10/2021
12.6.2 172,638 5/21/2021
12.6.1 569,511 3/29/2021
12.6.0 1,648,756 1/12/2021
12.6.0-beta.1 2,719 12/7/2020
12.5.0 531,878 11/10/2020
12.5.0-preview.1 48,983 10/1/2020
12.4.0 549,985 8/31/2020
12.3.1 36,997 8/18/2020
12.3.0-preview.2 16,223 7/28/2020
12.3.0-preview.1 6,781 7/3/2020
12.2.3 206,032 6/5/2020
12.2.2 10,618 6/2/2020
12.2.1 38,749 5/6/2020
12.2.0 161,608 3/12/2020
12.1.0 835,835 2/11/2020
12.0.1 351,063 1/10/2020
12.0.0 11,330 12/4/2019
12.0.0-preview.5 25,066 10/31/2019