Description

# Azure Storage File Share client library for Python Azure File Share storage offers fully managed file shares in the cloud that are accessible via the industry standard [Server Message Block (SMB) protocol](https://learn.microsoft.com/windows/desktop/FileIO/microsoft-smb-protocol-and-cifs-protocol-overview). 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. Azure file shares can be used to: * Replace or supplement on-premises file servers * "Lift and shift" applications * Simplify cloud development with shared application settings, diagnostic share, and Dev/Test/Debug tools [Source code](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/azure/storage/fileshare) | [Package (PyPI)](https://pypi.org/project/azure-storage-file-share/) | [Package (Conda)](https://anaconda.org/microsoft/azure-storage/) | [API reference documentation](https://aka.ms/azsdk-python-storage-fileshare-ref) | [Product documentation](https://learn.microsoft.com/azure/storage/) | [Samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples) ## Getting started ### Prerequisites * Python 3.9 or later is required to use this package. For more details, please read our page on [Azure SDK for Python version support policy](https://github.com/Azure/azure-sdk-for-python/wiki/Azure-SDKs-Python-version-support-policy). * You must have an [Azure subscription](https://azure.microsoft.com/free/) and an [Azure storage account](https://learn.microsoft.com/azure/storage/common/storage-account-overview) to use this package. ### Install the package Install the Azure Storage File Share client library for Python with [pip](https://pypi.org/project/pip/): ```bash pip install azure-storage-file-share ``` ### Create a storage account If you wish to create a new storage account, you can use the [Azure Portal](https://learn.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal), [Azure PowerShell](https://learn.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-powershell), or [Azure CLI](https://learn.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-cli): ```bash # Create a new resource group to hold the storage account - # if using an existing resource group, skip this step az group create --name my-resource-group --location westus2 # Create the storage account az storage account create -n my-storage-account-name -g my-resource-group ``` ### Create the client The Azure Storage File Share client library for Python allows you to interact with four types of resources: the storage account itself, file shares, directories, and files. Interaction with these resources starts with an instance of a [client](#clients). To create a client object, you will need the storage account's file service URL and a credential that allows you to access the storage account: ```python from azure.storage.fileshare import ShareServiceClient service = ShareServiceClient(account_url="https://<my-storage-account-name>.file.core.windows.net/", credential=credential) ``` #### Looking up the account URL You can find the storage account's file service URL using the [Azure Portal](https://learn.microsoft.com/azure/storage/common/storage-account-overview#storage-account-endpoints), [Azure PowerShell](https://learn.microsoft.com/powershell/module/az.storage/get-azstorageaccount), or [Azure CLI](https://learn.microsoft.com/cli/azure/storage/account?view=azure-cli-latest#az-storage-account-show): ```bash # Get the file service URL for the storage account az storage account show -n my-storage-account-name -g my-resource-group --query "primaryEndpoints.file" ``` #### Types of credentials The `credential` parameter may be provided in a number of different forms, depending on the type of [authorization](https://learn.microsoft.com/azure/storage/common/storage-auth) you wish to use: 1. To use a [shared access signature (SAS) token](https://learn.microsoft.com/azure/storage/common/storage-sas-overview), provide the token as a string. If your account URL includes the SAS token, omit the credential parameter. You can generate a SAS token from the Azure Portal under "Shared access signature" or use one of the `generate_sas()` functions to create a sas token for the storage account, share, or file: ```python from datetime import datetime, timedelta from azure.storage.fileshare import ShareServiceClient, generate_account_sas, ResourceTypes, AccountSasPermissions sas_token = generate_account_sas( account_name="<storage-account-name>", account_key="<account-access-key>", resource_types=ResourceTypes(service=True), permission=AccountSasPermissions(read=True),