# 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://docs.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://docs.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.8 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://docs.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://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal),
[Azure PowerShell](https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-powershell),
or [Azure CLI](https://docs.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://docs.microsoft.com/azure/storage/common/storage-account-overview#storage-account-endpoints),
[Azure PowerShell](https://docs.microsoft.com/powershell/module/az.storage/get-azstorageaccount),
or [Azure CLI](https://docs.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://docs.microsoft.com/azure/storage/common/storage-auth) you wish to use:
1. To use a [shared access signature (SAS) token](https://docs.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),
expiry=datetime.utcnow() + timedelta(hours=1)
)
share_service_client = ShareServiceClient(account_url="https://<my_account_name>.file.core.windows.net", credential=sas_token)
```
2. To use a storage account [shared key](https://docs.microsoft.com/rest/api/storageservices/authenticate-with-shared-key/)
(aka account key or access key), provide the key as a string. This can be found in the Azure Portal under the "Access Keys"
section or by running the following Azure CLI command:
```az storage account keys list -g MyResourceGroup -n MyStorageAccount```
Use the key as the credential parameter to authenticate the client:
```python
from azure.storage.fileshare import ShareServiceClient
service = ShareServiceClient(account_url="https://<my_account_name>.file.core.windows.net", credential="<account_access_key>")
```
#### Creating the client from a connection string
Depending on your use case and authorization method, you may prefer to initialize a client instance with a storage
connection string instead of providing the account URL and credential separately. To do this, pass the storage
connection string to the client's `from_connection_string` class method:
```python
from azure.storage.fileshare import ShareServiceClient
connection_string = "DefaultEndpointsProtocol=https;AccountName=xxxx;AccountKey=xxxx;EndpointSuffix=core.windows.net"
service = ShareServiceClient.from_connection_string(conn_str=connection_string)
```
The connection string to your storage account can be found in the Azure Portal under the "Access Keys" section or by running the following CLI command:
```bash
az storage account show-connection-string -g MyResourceGroup -n MyStorageAccount
```
## Key concepts
The following components make up the Azure File Share Service:
* The storage account itself
* A file share within the storage account
* An optional hierarchy of directories within the file share
* A file within the file share, which may be up to 1 TiB in size
The Azure Storage File Share client library for Python allows you to interact with each of these components through the
use of a dedicated client object.
### Async Clients
This library includes a complete async API supported on Python 3.5+. To use it, you must
first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/).
See
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
for more information.
Async clients and credentials should be closed when they're no longer needed. These
objects are async context managers and define async `close` methods.
### Clients
Four different clients are provided to interact with the various components of the File Share Service:
1. [ShareServiceClient](https://aka.ms/azsdk-python-storage-fileshare-shareserviceclient) -
this client represents interaction with the Azure storage account itself, and allows you to acquire preconfigured
client instances to access the file shares within. It provides operations to retrieve and configure the service
properties as well as list, create, and delete shares within the account. To perform operations on a specific share,
retrieve a client using the `get_share_client` method.
2. [ShareClient](https://aka.ms/azsdk-python-storage-fileshare-shareclient) -
this client represents interaction with a specific file share (which need not exist yet), and allows you to acquire
preconfigured client instances to access the directories and files within. It provides operations to create, delete,
configure, or create snapshots of a share and includes operations to create and enumerate the contents of
directories within it. To perform operations on a specific directory or file, retrieve a client using the
`get_directory_client` or `get_file_client` methods.
3. [ShareDirectoryClient](https://aka.ms/azsdk-python-storage-fileshare-sharedirectoryclient) -
this client represents interaction with a specific directory (which need not exist yet). It provides operations to
create, delete, or enumerate the contents of an immediate or nested subdirectory, and includes operations to create
and delete files within it. For operations relating to a specific subdirectory or file, a client for that entity can
also be retrieved using the `get_subdirectory_client` and `get_file_client` functions.
4. [ShareFileClient](https://aka.ms/azsdk-python-storage-fileshare-sharefileclient) -
this client represents interaction with a specific file (which need not exist yet). It provides operations to
upload, download, create, delete, and copy a file.
For details on path naming restrictions, see [Naming and Referencing Shares, Directories, Files, and Metadata](https://docs.microsoft.com/rest/api/storageservices/naming-and-referencing-shares--directories--files--and-metadata).
## Examples
The following sections provide several code snippets covering some of the most common Storage File Share tasks, including:
* [Creating a file share](#creating-a-file-share "Creating a file share")
* [Uploading a file](#uploading-a-file "Uploading a file")
* [Downloading a file](#downloading-a-file "Downloading a file")
* [Listing contents of a directory](#listing-contents-of-a-directory "Listing contents of a directory")
### Creating a file share
Create a file share to store your files
```python
from azure.storage.fileshare import ShareClient
share = ShareClient.from_connection_string(conn_str="<connection_string>", share_name="myshare")
share.create_share()
```
Use the async client to create a file share
```python
from azure.storage.fileshare.aio import ShareClient
share = ShareClient.from_connection_string(conn_str="<connection_string>", share_name="myshare")
await share.create_share()
```
### Uploading a file
Upload a file to the share
```python
from azure.storage.fileshare import ShareFileClient
file_client = ShareFileClient.from_connection_string(conn_str="<connection_string>", share_name="myshare", file_path="my_file")
with open("./SampleSource.txt", "rb") as source_file:
file_client.upload_file(source_file)
```
Upload a file asynchronously
```python
from azure.storage.fileshare.aio import ShareFileClient
file_client = ShareFileClient.from_connection_string(conn_str="<connection_string>", share_name="myshare", file_path="my_file")
with open("./SampleSource.txt", "rb") as source_file:
await file_client.upload_file(source_file)
```
### Downloading a file
Download a file from the share
```python
from azure.storage.fileshare import ShareFileClient
file_client = ShareFileClient.from_connection_string(conn_str="<connection_string>", share_name="myshare", file_path="my_file")
with open("DEST_FILE", "wb") as file_handle:
data = file_client.download_file()
data.readinto(file_handle)
```
Download a file asynchronously
```python
from azure.storage.fileshare.aio import ShareFileClient
file_client = ShareFileClient.from_connection_string(conn_str="<connection_string>", share_name="myshare", file_path="my_file")
with open("DEST_FILE", "wb") as file_handle:
data = await file_client.download_file()
await data.readinto(file_handle)
```
### Listing contents of a directory
List all directories and files under a parent directory
```python
from azure.storage.fileshare import ShareDirectoryClient
parent_dir = ShareDirectoryClient.from_connection_string(conn_str="<connection_string>", share_name="myshare", directory_path="parent_dir")
my_list = list(parent_dir.list_directories_and_files())
print(my_list)
```
List contents of a directory asynchronously
```python
from azure.storage.fileshare.aio import ShareDirectoryClient
parent_dir = ShareDirectoryClient.from_connection_string(conn_str="<connection_string>", share_name="myshare", directory_path="parent_dir")
my_files = []
async for item in parent_dir.list_directories_and_files():
my_files.append(item)
print(my_files)
```
## Optional Configuration
Optional keyword arguments that can be passed in at the client and per-operation level.
### Retry Policy configuration
Use the following keyword arguments when instantiating a client to configure the retry policy:
* __retry_total__ (int): Total number of retries to allow. Takes precedence over other counts.
Pass in `retry_total=0` if you do not want to retry on requests. Defaults to 10.
* __retry_connect__ (int): How many connection-related errors to retry on. Defaults to 3.
* __retry_read__ (int): How many times to retry on read errors. Defaults to 3.
* __retry_status__ (int): How many times to retry on bad status codes. Defaults to 3.
* __retry_to_secondary__ (bool): Whether the request should be retried to secondary, if able.
This should only be enabled of RA-GRS accounts are used and potentially stale data can be handled.
Defaults to `False`.
### Other client / per-operation configuration
Other optional configuration keyword arguments that can be specified on the client or per-operation.
**Client keyword arguments:**
* __connection_timeout__ (int): The number of seconds the client will wait to establish a connection to the server.
Defaults to 20 seconds.
* __read_timeout__ (int): The number of seconds the client will wait, between consecutive read operations, for a
response from the server. This is a socket level timeout and is not affected by overall data size. Client-side read
timeouts will be automatically retried. Defaults to 60 seconds.
* __transport__ (Any): User-provided transport to send the HTTP request.
**Per-operation keyword arguments:**
* __raw_response_hook__ (callable): The given callback uses the response returned from the service.
* __raw_request_hook__ (callable): The given callback uses the request before being sent to service.
* __client_request_id__ (str): Optional user specified identification of the request.
* __user_agent__ (str): Appends the custom value to the user-agent header to be sent with the request.
* __logging_enable__ (bool): Enables logging at the DEBUG level. Defaults to False. Can also be passed in at
the client level to enable it for all requests.
* __logging_body__ (bool): Enables logging the request and response body. Defaults to False. Can also be passed in at
the client level to enable it for all requests.
* __headers__ (dict): Pass in custom headers as key, value pairs. E.g. `headers={'CustomValue': value}`
## Troubleshooting
### General
Storage File clients raise exceptions defined in [Azure Core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md).
This list can be used for reference to catch thrown exceptions. To get the specific error code of the exception, use the `error_code` attribute, i.e, `exception.error_code`.
### Logging
This library uses the standard
[logging](https://docs.python.org/3/library/logging.html) library for logging.
Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO
level.
Detailed DEBUG level logging, including request/response bodies and unredacted
headers, can be enabled on a client with the `logging_enable` argument:
```python
import sys
import logging
from azure.storage.fileshare import ShareServiceClient
# Create a logger for the 'azure.storage.fileshare' SDK
logger = logging.getLogger('azure.storage.fileshare')
logger.setLevel(logging.DEBUG)
# Configure a console output
handler = logging.StreamHandler(stream=sys.stdout)
logger.addHandler(handler)
# This client will log detailed information about its HTTP sessions, at DEBUG level
service_client = ShareServiceClient.from_connection_string("your_connection_string", logging_enable=True)
```
Similarly, `logging_enable` can enable detailed logging for a single operation,
even when it isn't enabled for the client:
```python
service_client.get_service_properties(logging_enable=True)
```
## Next steps
### More sample code
Get started with our [File Share samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples).
Several Storage File Share Python SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Storage File Share:
* [file_samples_hello_world.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_hello_world.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_hello_world_async.py)) - Examples found in this article:
* Client creation
* Create a file share
* Upload a file
* [file_samples_authentication.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_authentication.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_authentication_async.py)) - Examples for authenticating and creating the client:
* From a connection string
* From a shared access key
* From a shared access signature token
* [file_samples_service.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_service.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_service_async.py)) - Examples for interacting with the file service:
* Get and set service properties
* Create, list, and delete shares
* Get a share client
* [file_samples_share.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_share.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_share_async.py)) - Examples for interacting with file shares:
* Create a share snapshot
* Set share quota and metadata
* List directories and files
* Get the directory or file client to interact with a specific entity
* [file_samples_directory.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_directory.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_directory_async.py)) - Examples for interacting with directories:
* Create a directory and add files
* Create and delete subdirectories
* Get the subdirectory client
* [file_samples_client.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_client.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_client_async.py)) - Examples for interacting with files:
* Create, upload, download, and delete files
* Copy a file from a URL
### Additional documentation
For more extensive documentation on Azure File Share storage, see the [Azure File Share storage documentation](https://docs.microsoft.com/azure/storage/files/) on docs.microsoft.com.
## Contributing
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 https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
# Release History
## 12.20.0 (2024-11-13)
### Features Added
- Stable release of features from 12.20.0b1
## 12.20.0b1 (2024-10-10)
### Features Added
- Added support for service version 2025-01-05.
- Added support to specify `Premium` enum value in `access_tier` for `create_share` and `set_share_properties` APIs.
- Added `file_permission_format` to specify permission format for File's `copy_file` API.
- Added support for provisioned V2 billing model, including `provisioned_iops` and `provisioned_bandwidth_mibps` for
`ShareClient` and `ShareServiceClient`'s `create_share` APIs; `provisioned_max_iops` and `provisioned_max_bandwidth_mibps`
for `ShareClient`'s `set_share_properties` API; and retrieve `included_burst_iop`, `max_burst_credits_for_iops`,
`next_provisioned_iops_downgrade` and `next_provisioned_bandwidth_downgrade` through `get_share_properties` API.
`ShareServiceClient`'s `list_shares` API returns the new properties through `get_share_properties` for each share.
## 12.19.0 (2024-10-08)
### Features Added
- Updated type hints across the entire package and enabled MyPy to run during CI. Some public types may have been adjusted if they were previously erroneous or incomplete.
## 12.18.0 (2024-09-17)
### Features Added
- Stable release of features from 12.18.0b1
## 12.18.0b1 (2024-08-07)
### Features Added
- Added support for service version 2024-11-04.
- Added support for Entra ID authentication for all data plane file operations that were previously not enabled.
- Added support to set `paid_bursting_enabled`, `paid_bursting_bandwidth_mibps`, and `paid_bursting_iops` for Share's
`create_share` and `set_share_properties` APIs, and also retrieve them on the `get_share_properties` API.
- Added `file_permission_format` to specify permission format for Share's `create_permission_for_share` and
`get_permission_for_share` APIs; File's `create_file`, `rename_file`, and `set_http_headers` APIs; and
Directory's `rename_directory` and `set_http_headers` APIs.
### Other Changes
- Bumped minimum `azure-core` dependency to 1.30.0.
## 12.17.0 (2024-07-18)
### Features Added
- Stable release of features from 12.17.0b1
## 12.17.0b1 (2024-06-11)
### Features Added
- Added a more descriptive authorization error message when facing authorization errors.
## 12.16.0 (2024-05-07)
### Features Added
- Stable release of features from 12.16.0b1
## 12.16.0b1 (2024-04-16)
This version and all future versions will require Python 3.8+. Python 3.7 is no longer supported.
### Features Added
- Added `exists` method to `ShareFileClient` to check if a file exists.
- Added support for service version 2024-05-04.
- The `services` parameter has been added to the `generate_account_sas` API, which enables the ability to generate SAS
tokens to be used with multiple services. By default, the SAS token service scope will default to the current service.
- Added `client_name` property to `Handle`.
- Added support for `support_rename` to `get_ranges_diff()`
### Bugs Fixed
- Fixed an issue where the `ShareDirectoryClient` returned by `get_subdirectory_client` with a `ShareDirectoryClient`
pointing to the root of the file share would raise an `InvalidResourceName` on any operations.
- Bumped dependency of `typing-extensions` to `>=4.6.0` to avoid potential `TypeError` with `typing.TypeVar` on
Python 3.12.
- Fixed an issue where authentication errors could raise `AttributeError` instead of `ClientAuthenticationError` when
using async OAuth credentials.
- Fixed an issue where parameter `delete_snapshots` to `delete_share` API did not support all possible enums. This change
makes `delete_snapshots` now accept string literals 'include' and 'include-leased'.
- Fixed an issue where specifying datetime objects with less than 7 digits of precision as input could incorrectly raise
`InvalidHeaderValue` due to improper precision parsing.
## 12.15.0 (2023-11-07)
### Features Added
- Stable release of features from 12.15.0b1
## 12.15.0b1 (2023-10-17)
### Features Added
- Added support for service version 2023-11-03.
- Added `audience` as an optional keyword that can be specified on APIs that have a `credential` parameter. This
keyword only has an effect when the credential provided is of type `TokenCredential`.
## 12.14.2 (2023-10-10)
### Bugs Fixed
- Fixed an issue when an invalid type was provided for `credential` during client construction, the
`__str__` of the object would be present in the exception message and therefore potentially logged.
## 12.14.1 (2023-09-13)
### Bugs Fixed
- Fixed breaking `KeyError: 'sdk_moniker'` in `create_configuration`.
NOTE: This is not an exported method and therefore should not be imported/called directly.
## 12.14.0 (2023-09-12)
### Features Added
- Stable release of features from 12.14.0b1
## 12.14.0b1 (2023-08-08)
### Features Added
- Added support for service versions 2023-05-03 and 2023-08-03.
## 12.13.0 (2023-07-11)
### Features Added
- Stable release of features from 12.13.0b1
## 12.13.0b1 (2023-05-30)
### Features Added
- Added support for service version 2023-01-03.
- Added `access_rights` property to `Handle`.
## 12.12.0 (2023-04-12)
### Features Added
- Stable release of features from 12.12.0b1
## 12.12.0b1 (2023-03-28)
### Features Added
- Added support for service version 2022-11-02.
- Added support for `TokenCredential` to be used for authentication. A `TokenCredential` can be provided for the
`credential` parameter to any client constructor. **Note:** When using a `TokenCredential`, the new keyword parameter
`token_intent` is **required** and must be provided. Additionally, this form of authentication is only supported for
certain operations in the Data Plane SDK.
- Added support for `allow_trailing_dot` and `allow_source_trailing_dot` on client construction. When
`allow_trailing_dot` is provided, the service will not silently remove any trailing `.` character from directory/file
names for all operations made from that client. `allow_source_trailing_dot` will apply this same rule to source files
when performing a rename or copy operation.
## 12.11.1 (2023-03-08)
### Bugs Fixed
- Fixed "duplicate type signatures" MyPy error.
## 12.11.0 (2023-02-22)
### Features Added
- Stable release of features from 12.11.0b1
## 12.11.0b1 (2023-02-02)
### Features Added
- Added support for service version 2021-12-02.
- Added support for file and directory paths that contain invalid XML characters. When listing or fetching properties,
the service will encode illegal characters and the SDK will now automatically decode them.
- Added support for `AsyncIterable` as data type for async file upload.
### Bugs Fixed
- Fixed an issue where keyword `name_starts_with` was not being passed to the service properly for the `list_shares` async API
### Other Changes
- Removed `msrest` dependency.
- Added `typing-extensions>=4.0.1` as a dependency.
- Added `isodate>=0.6.1` as a dependency.
- Added extra dependency `aio` for installing optional async dependencies. Use `pip install azure-storage-file-share[aio]` to install.
## 12.10.1 (2022-10-18)
### Bugs Fixed
- Fixed possible `ValueError` for invalid content range that gets raised when downloading empty files through Azurite.
## 12.10.0 (2022-10-11)
### Features Added
- Stable release of features from 12.10.0b1.
### Bugs Fixed
- Fixed an issue where calling `download_file` with an invalid base64-encoded account key would raise an
`AttributeError` rather than the proper `AzureSigningError`.
### Other Changes
- Changed the default value for `read_timeout` to 60 seconds for all clients.
## 12.10.0b1 (2022-08-23)
This version and all future versions will require Python 3.7+. Python 3.6 is no longer supported.
### Features Added
- Added support for `AzureNamedKeyCredential` as a valid `credential` type.
## 12.9.0 (2022-07-07)
### Features Added
- Stable release of features from 12.9.0b1.
- Added support for progress tracking to `upload_file()` and `download_file()` via a new optional callback, `progress_hook`.
## 12.9.0b1 (2022-06-15)
### Features Added
- Added support for `file_change_time` to `start_copy_from_url` API
## 12.8.0 (2022-05-09)
### Features Added
- Stable release of features from 12.8.0b1.
### Bugs Fixed
- Fixed a bug, introduced in the previous beta release, that caused Authentication errors when attempting to use
an Account SAS with certain service level operations.
## 12.8.0b1 (2022-04-14)
### Features Added
- Added support for service version 2021-06-08.
- Added support for missing parameters on `create_directory()` including `file_attributes`, `file_creation_time`,
`file_last_write_time`, `file_permission` and `file_permission_key`.
- Added support for setting `content_type` on `rename_file()`.
- Added support for setting `file_change_time` on `create_directory()`, `set_http_headers()` (directory)
`rename_directory()`, `create_file()`, `set_http_headers()` (file) and `rename_file()`.
- Added support for setting `file_last_write_mode` on `upload_range()` and `upload_range_from_url()`
with possible values of `Now` or `Preserve`.
### Bugs Fixed
- Updated `create_share()` docstring to have the correct return-type of `None`
## 12.7.0 (2022-03-08)
This version and all future versions will require Python 3.6+. Python 2.7 is no longer supported.
### Stable release of preview features
- Added support for service version 2021-02-12, 2021-04-10.
- Added support for premium file share provisioned_bandwidth property.
- Added support for checking if a directory exists using `exists()`.
- Added support for `rename_directory()` and `rename_file()`.
- Added support for `Create (c)` SAS permission for Share SAS.
### Bugs Fixed
- Fixed a bug where `start_copy_from_url()` was not sending the `ignore_read_only` parameter correctly.
## 12.7.0b2 (2022-02-08)
This version and all future versions will require Python 3.6+. Python 2.7 is no longer supported.
### Features Added
- Added support for service version 2021-04-10.
- Added support for `rename_directory()` and `rename_file()`.
- Added support for `Create (c)` SAS permission for Share SAS.
### Bugs Fixed
- Update `azure-core` dependency to avoid inconsistent dependencies from being installed.
- Fixed a bug, that was introduced in the previous beta release, where `generate_account_sas()`
was not generating the proper SAS signature.
## 12.7.0b1 (2021-12-13)
### Features Added
- Added support for service version 2021-02-12.
- Added support for premium file share provisioned_bandwidth property.
- Added support for checking if a directory exists using `exists()`.
## 12.6.0 (2021-09-15)
**Stable release of preview features**
- Added support for service version 2020-10-02 (STG78)
- Added OAuth support for file copy source.
## 12.6.0b1 (2021-07-27)
**New features**
- Added OAuth support for file copy source.
**Fixes**
- Ensured that download fails if file modified mid download
## 12.5.0 (2021-06-09)
**New features**
- Added support for lease operation on a share, eg. acquire_lease
## 12.5.0b1 (2021-05-12)
**New features**
- Added support for lease operation on a share, eg. acquire_lease
## 12.4.2 (2021-04-20)
**Fixes**
- Make `AccountName`, `AccountKey` etc. in conn_str case insensitive
- Fixed `downloader.chunks()` return chunks in different size (#9419, #15648)
- Fixed unclosed `ThreadPoolExecutor` (#8955)
## 12.4.1 (2021-01-20)
**Fixes**
- Fixed msrest dependency issue (#16250)
## 12.4.0 (2021-01-13)
**Stable release of preview features**
- Added support for enabling root squash and share protocols for file share.
- Added support for `AzureSasCredential` to allow SAS rotation in long living clients.
## 12.4.0b1 (2020-12-07)
**New features**
- Added support for enabling root squash and share protocols for file share.
## 12.3.0 (2020-11-10)
**Stable release of preview features**
- Preview feature enabling SMB Multichannel for the share service.
- Preview feature `get_ranges` on ShareFileClient
**New features**
- Added `set_share_properties` which allows setting share tier.
**Notes**
- Updated dependency `azure-core` from azure-core<2.0.0,>=1.2.2 to azure-core<2.0.0,>=1.9.0 to get continuation_token attr on AzureError.
## 12.3.0b1 (2020-10-02)
**New features**
- Added support for enabling SMB Multichannel for the share service.
- Added support for leasing a share.
- Added support for getting the range diff between current file and a snapshot as well as getting the diff between two file snapshots.
## 12.2.0 (2020-08-13)
**Stable release of preview features**
- Preview feature `undelete_share` on FileShareServiceClient.
## 12.2.0b1 (2020-07-07)
**New features**
- Added `undelete_share` on FileShareServiceClient so that users can restore deleted share on share soft delete enabled account. Users can also list deleted shares when `list_shares` by specifying `include_deleted=True`.
## 12.1.2
**Fixes**
- Improve the performance of upload when using max_concurrency
## 12.1.1 (2020-03-10)
**Notes**
- The `StorageUserAgentPolicy` is now replaced with the `UserAgentPolicy` from azure-core. With this, the custom user agents are now added as a prefix instead of being appended.
## 12.1.0
**New features**
- Added support for the 2019-07-07 service version, and added `api_version` parameter to clients.
- `ShareLeaseClient` was introduced to both sync and async versions of the SDK, which allows users to perform operations on file leases.
- `failed_handles_count` info was included in `close_handle` and `close_all_handles` result.
- Added support for obtaining premium file properties in `list_shares` and `get_share_properties`.
- Added support for additional `start_copy_from_url` parameters - `file_permission`, `permission_key`, `file_attributes`, `file_creation_time`, `file_last_write_time`, `ignore_read_only`, and `set_archive_attribute`.
**Fixes and improvements**
- Fixed a bug: `clear_range` API was not working.
**Fixes**
- Responses are always decoded as UTF8
## 12.0.0
**New features**
- Added `delete_directory` method to the `share_client`.
- All the clients now have a `close()` method to close the sockets opened by the client when using without a context manager.
**Fixes and improvements**
- Fixes a bug where determining length breaks while uploading a file when provided with an invalid fileno.
**Breaking changes**
- `close_handle(handle)` and `close_all_handles()` no longer return int. These functions return a dictionary which has the number of handles closed and number of handles failed to be closed.
## 12.0.0b5
**Important: This package was previously named azure-storage-file**
Going forward, to use this SDK, please install `azure-storage-file-share`.
Additionally:
- The namespace within the package has also been renamed to `azure.storage.fileshare`.
- `FileServiceClient` has been renamed to `ShareServiceClient`.
- `DirectoryClient` has been renamed to `ShareDirectoryClient`.
- `FileClient` has been renamed to `ShareFileClient`.
**Additional Breaking changes**
- `ShareClient` now accepts only `account_url` with mandatory a string param `share_name`.
To use a share_url, the method `from_share_url` must be used.
- `ShareDirectoryClient` now accepts only `account_url` with mandatory string params `share_name` and `directory_path`.
To use a directory_url, the method `from_directory_url` must be used.
- `ShareFileClient` now accepts only `account_url` with mandatory string params `share_name` and
`file_path`. To use a file_url, the method `from_file_url` must be used.
- `file_permission_key` parameter has been renamed to `permission_key`
- `set_share_access_policy` has required parameter `signed_identifiers`.
- `NoRetry` policy has been removed. Use keyword argument `retry_total=0` for no retries.
- Removed types that were accidentally exposed from two modules. Only `ShareServiceClient`, `ShareClient`, `ShareDirectoryClient` and `ShareFileClient` should be imported from azure.storage.fileshare.aio
- Some parameters have become keyword only, rather than positional. Some examples include:
- `loop`
- `max_concurrency`
- `validate_content`
- `timeout` etc.
- Client and model files have been made internal. Users should import from the top level modules `azure.storage.fileshare` and `azure.storage.fileshare.aio` only.
- The `generate_shared_access_signature` methods on each of `ShareServiceClient`, `ShareClient` and `ShareFileClient` have been replaced by module level functions `generate_account_sas`, `generate_share_sas` and `generate_file_sas`.
- `start_range` and `end_range` params are now renamed to and behave like`offset` and `length` in
the following APIs:
- download_file
- upload_range
- upload_range_from_url
- clear_range
- get_ranges
- `StorageStreamDownloader` is no longer iterable. To iterate over the file data stream, use `StorageStreamDownloader.chunks`.
- The public attributes of `StorageStreamDownloader` have been limited to:
- `name` (str): The name of the file.
- `path` (str): The full path of the file.
- `share` (str): The share the file will be downloaded from.
- `properties` (`FileProperties`): The properties of the file.
- `size` (int): The size of the download. Either the total file size, or the length of a subsection if specified. Previously called `download_size`.
- `StorageStreamDownloader` now has new functions:
- `readall()`: Reads the complete download stream, returning bytes. This replaces the functions `content_as_bytes` and `content_as_text` which have been deprecated.
- `readinto(stream)`: Download the complete stream into the supplied writable stream, returning the number of bytes written. This replaces the function `download_to_stream` which has been deprecated.
- `ShareFileClient.close_handles` and `ShareDirectoryClient.close_handles` have both been replaced by two functions each; `close_handle(handle)` and `close_all_handles()`. These functions are blocking and return integers (the number of closed handles) rather than polling objects.
- `get_service_properties` now returns a dict with keys consistent to `set_service_properties`
**New features**
- `ResourceTypes`, `NTFSAttributes`, and `Services` now have method `from_string` which takes parameters as a string.
## 12.0.0b4
**Breaking changes**
- Permission models.
- `AccountPermissions`, `SharePermissions` and `FilePermissions` have been renamed to
`AccountSasPermissions`, `ShareSasPermissions` and `FileSasPermissions` respectively.
- enum-like list parameters have been removed from all three of them.
- `__add__` and `__or__` methods are removed.
- `max_connections` is now renamed to `max_concurrency`.
**New features**
- `AccountSasPermissions`, `FileSasPermissions`, `ShareSasPermissions` now have method `from_string` which
takes parameters as a string.
## 12.0.0b3
**New features**
- Added upload_range_from_url API to write the bytes from one Azure File endpoint into the specified range of another Azure File endpoint.
- Added set_http_headers for directory_client, create_permission_for_share and get_permission_for_share APIs.
- Added optional parameters for smb properties related parameters for create_file*, create_directory* related APIs and set_http_headers API.
- Updated get_properties for directory and file so that the response has SMB properties.
**Dependency updates**
- Adopted [azure-core](https://pypi.org/project/azure-core/) 1.0.0b3
- If you later want to revert to previous versions of azure-storage-file, or another Azure SDK
library requiring azure-core 1.0.0b1 or azure-core 1.0.0b2, you must explicitly install
the specific version of azure-core as well. For example:
`pip install azure-core==1.0.0b2 azure-storage-file==12.0.0b2`
**Fixes and improvements**
- Fix where content-type was being added in the request when not mentioned explicitly.
## 12.0.0b2
**Breaking changes**
- Renamed `copy_file_from_url` to `start_copy_from_url` and changed behaviour to return a dictionary of copy properties rather than a polling object. Status of the copy operation can be retrieved with the `get_file_properties` operation.
- Added `abort_copy` operation to the `FileClient` class. This replaces the previous abort operation on the copy status polling operation.
- The behavior of listing operations has been modified:
- The previous `marker` parameter has been removed.
- The iterable response object now supports a `by_page` function that will return a secondary iterator of batches of results. This function supports a `continuation_token` parameter to replace the previous `marker` parameter.
- The new listing behaviour is also adopted by the `receive_messages` operation:
- The receive operation returns a message iterator as before.
- The returned iterator supports a `by_page` operation to receive messages in batches.
**New features**
- Added async APIs to subnamespace `azure.storage.file.aio`.
- Distributed tracing framework OpenCensus is now supported.
**Dependency updates**
- Adopted [azure-core](https://pypi.org/project/azure-core/) 1.0.0b2
- If you later want to revert to azure-storage-file 12.0.0b1, or another Azure SDK
library requiring azure-core 1.0.0b1, you must explicitly install azure-core
1.0.0b1 as well. For example:
`pip install azure-core==1.0.0b1 azure-storage-file==12.0.0b1`
**Fixes and improvements**
- Fix for closing file handles - continuation token was not being passed to subsequent calls.
- General refactor of duplicate and shared code.
## 12.0.0b1
Version 12.0.0b1 is the first preview of our efforts to create a user-friendly and Pythonic client library for Azure Storage Files. For more information about this, and preview releases of other Azure SDK libraries, please visit
https://aka.ms/azure-sdk-preview1-python.
**Breaking changes: New API design**
- Operations are now scoped to a particular client:
- `FileServiceClient`: This client handles account-level operations. This includes managing service properties and listing the shares within an account.
- `ShareClient`: The client handles operations for a particular share. This includes creating or deleting that share, as well as listing the directories within that share, and managing properties and metadata.
- `DirectoryClient`: The client handles operations for a particular directory. This includes creating or deleting that directory, as well as listing the files and subdirectories, and managing properties and metadata.
- `FileClient`: The client handles operations for a particular file. This includes creating or deleting that file, as well as upload and download data and managing properties.
These clients can be accessed by navigating down the client hierarchy, or instantiated directly using URLs to the resource (account, share, directory or file).
For full details on the new API, please see the [reference documentation](https://azure.github.io/azure-sdk-for-python/storage.html#azure-storage-file-share).
- The copy file operation now returns a polling object that can be used to check the status of the operation, as well as abort the operation.
- The `close_handles` operation now return a polling object that can be used to check the status of the operation.
- Download operations now return a streaming object that can download data in multiple ways:
- Iteration: The streamer is an iterable object that will download and yield the content in chunks. Only supports single threaded download.
- `content_as_bytes`: Return the entire file content as bytes. Blocking operation that supports multi-threaded download.
- `content_as_text`: Return the entire file content as decoded text. Blocking operation that supports multi-threaded download.
- `download_to_stream`: Download the entire content to an open stream handle (e.g. an open file). Supports multi-threaded download.
- New underlying REST pipeline implementation, based on the new `azure.core` library.
- Client and pipeline configuration is now available via keyword arguments at both the client level, and per-operation. See reference documentation for a full list of optional configuration arguments.
- New error hierarchy:
- All service errors will now use the base type: `azure.core.exceptions.HttpResponseError`
- The are a couple of specific exception types derived from this base type for common error scenarios:
- `ResourceNotFoundError`: The resource (e.g. queue, message) could not be found. Commonly a 404 status code.
- `ResourceExistsError`: A resource conflict - commonly caused when attempting to create a resource that already exists.
- `ResourceModifiedError`: The resource has been modified (e.g. overwritten) and therefore the current operation is in conflict. Alternatively this may be raised if a condition on the operation is not met.
- `ClientAuthenticationError`: Authentication failed.
- Operation `set_file_properties` has been renamed to `set_http_headers`.
- Operations `get_file_to_<output>` have been replaced with `download_file`. See above for download output options.
- Operations `create_file_from_<input>` have been replace with `upload_file`.
- Operations `get_share_acl` and `set_share_acl` have been renamed to `get_share_access_policy` and `set_share_access_policy`.
- Operation `set_share_properties` has been renamed to `set_share_quota`.
- Operation `snapshot_share` has been renamed to `create_snapshot`.
- Operation `copy_file` has been renamed to `copy_file_from_url`.
- No longer have specific operations for `get_metadata` - use `get_properties` instead.
- No longer have specific operations for `exists` - use `get_properties` instead.
- Operation `update_range` has been renamed to `upload_range`.
## 2.0.1
- Updated dependency on azure-storage-common.
## 2.0.0
- Support for 2018-11-09 REST version. Please see our REST API documentation and blogs for information about the related added features.
- Added an option to get share stats in bytes.
- Added support for listing and closing file handles.
## 1.4.0
- azure-storage-nspkg is not installed anymore on Python 3 (PEP420-based namespace package)
## 1.3.1
- Fixed design flaw where get_file_to_* methods buffer entire file when max_connections is set to 1.
## 1.3.0
- Support for 2018-03-28 REST version. Please see our REST API documentation and blog for information about the related added features.
## 1.2.0rc1
- Support for 2017-11-09 REST version. Please see our REST API documentation and blog for information about the related added features.
## 1.1.0
- Support for 2017-07-29 REST version. Please see our REST API documentation and blogs for information about the related added features.
- Error message now contains the ErrorCode from the x-ms-error-code header value.
## 1.0.0
- The package has switched from Apache 2.0 to the MIT license.
- Fixed bug where get_file_to_* cannot get a single byte when start_range and end_range are both equal to 0.
- Metadata keys are now case-preserving when fetched from the service. Previously they were made lower-case by the library.
Raw data
{
"_id": null,
"home_page": "https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share",
"name": "azure-storage-file-share",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "azure, azure sdk",
"author": "Microsoft Corporation",
"author_email": "ascl@microsoft.com",
"download_url": "https://files.pythonhosted.org/packages/48/6d/d14447b85df0455a612e5df97d18bf1b4bf3fcc0716fcbf2c50b79f154bd/azure_storage_file_share-12.20.0.tar.gz",
"platform": null,
"description": "# Azure Storage File Share client library for Python\nAzure File Share storage offers fully managed file shares in the cloud that are accessible via the industry standard [Server Message Block (SMB) protocol](https://docs.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.\n\nAzure file shares can be used to:\n\n* Replace or supplement on-premises file servers\n* \"Lift and shift\" applications\n* Simplify cloud development with shared application settings, diagnostic share, and Dev/Test/Debug tools\n\n[Source code](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/azure/storage/fileshare)\n| [Package (PyPI)](https://pypi.org/project/azure-storage-file-share/)\n| [Package (Conda)](https://anaconda.org/microsoft/azure-storage/)\n| [API reference documentation](https://aka.ms/azsdk-python-storage-fileshare-ref)\n| [Product documentation](https://docs.microsoft.com/azure/storage/)\n| [Samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples)\n\n## Getting started\n\n### Prerequisites\n* Python 3.8 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).\n* You must have an [Azure subscription](https://azure.microsoft.com/free/) and an\n[Azure storage account](https://docs.microsoft.com/azure/storage/common/storage-account-overview) to use this package.\n\n### Install the package\nInstall the Azure Storage File Share client library for Python with [pip](https://pypi.org/project/pip/):\n\n```bash\npip install azure-storage-file-share\n```\n\n### Create a storage account\nIf you wish to create a new storage account, you can use the\n[Azure Portal](https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal),\n[Azure PowerShell](https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-powershell),\nor [Azure CLI](https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-cli):\n\n```bash\n# Create a new resource group to hold the storage account -\n# if using an existing resource group, skip this step\naz group create --name my-resource-group --location westus2\n\n# Create the storage account\naz storage account create -n my-storage-account-name -g my-resource-group\n```\n\n### Create the client\nThe Azure Storage File Share client library for Python allows you to interact with four types of resources: the storage\naccount itself, file shares, directories, and files. Interaction with these resources starts with an instance of a\n[client](#clients). To create a client object, you will need the storage account's file service URL and a\ncredential that allows you to access the storage account:\n\n```python\nfrom azure.storage.fileshare import ShareServiceClient\n\nservice = ShareServiceClient(account_url=\"https://<my-storage-account-name>.file.core.windows.net/\", credential=credential)\n```\n\n#### Looking up the account URL\nYou can find the storage account's file service URL using the\n[Azure Portal](https://docs.microsoft.com/azure/storage/common/storage-account-overview#storage-account-endpoints),\n[Azure PowerShell](https://docs.microsoft.com/powershell/module/az.storage/get-azstorageaccount),\nor [Azure CLI](https://docs.microsoft.com/cli/azure/storage/account?view=azure-cli-latest#az-storage-account-show):\n\n```bash\n# Get the file service URL for the storage account\naz storage account show -n my-storage-account-name -g my-resource-group --query \"primaryEndpoints.file\"\n```\n\n#### Types of credentials\nThe `credential` parameter may be provided in a number of different forms, depending on the type of\n[authorization](https://docs.microsoft.com/azure/storage/common/storage-auth) you wish to use:\n1. To use a [shared access signature (SAS) token](https://docs.microsoft.com/azure/storage/common/storage-sas-overview),\n provide the token as a string. If your account URL includes the SAS token, omit the credential parameter.\n You can generate a SAS token from the Azure Portal under \"Shared access signature\" or use one of the `generate_sas()`\n functions to create a sas token for the storage account, share, or file:\n\n ```python\n from datetime import datetime, timedelta\n from azure.storage.fileshare import ShareServiceClient, generate_account_sas, ResourceTypes, AccountSasPermissions\n\n sas_token = generate_account_sas(\n account_name=\"<storage-account-name>\",\n account_key=\"<account-access-key>\",\n resource_types=ResourceTypes(service=True),\n permission=AccountSasPermissions(read=True),\n expiry=datetime.utcnow() + timedelta(hours=1)\n )\n\n share_service_client = ShareServiceClient(account_url=\"https://<my_account_name>.file.core.windows.net\", credential=sas_token)\n ```\n\n2. To use a storage account [shared key](https://docs.microsoft.com/rest/api/storageservices/authenticate-with-shared-key/)\n (aka account key or access key), provide the key as a string. This can be found in the Azure Portal under the \"Access Keys\"\n section or by running the following Azure CLI command:\n\n ```az storage account keys list -g MyResourceGroup -n MyStorageAccount```\n\n Use the key as the credential parameter to authenticate the client:\n ```python\n from azure.storage.fileshare import ShareServiceClient\n service = ShareServiceClient(account_url=\"https://<my_account_name>.file.core.windows.net\", credential=\"<account_access_key>\")\n ```\n\n#### Creating the client from a connection string\nDepending on your use case and authorization method, you may prefer to initialize a client instance with a storage\nconnection string instead of providing the account URL and credential separately. To do this, pass the storage\nconnection string to the client's `from_connection_string` class method:\n\n```python\nfrom azure.storage.fileshare import ShareServiceClient\n\nconnection_string = \"DefaultEndpointsProtocol=https;AccountName=xxxx;AccountKey=xxxx;EndpointSuffix=core.windows.net\"\nservice = ShareServiceClient.from_connection_string(conn_str=connection_string)\n```\n\nThe connection string to your storage account can be found in the Azure Portal under the \"Access Keys\" section or by running the following CLI command:\n\n```bash\naz storage account show-connection-string -g MyResourceGroup -n MyStorageAccount\n```\n\n## Key concepts\nThe following components make up the Azure File Share Service:\n* The storage account itself\n* A file share within the storage account\n* An optional hierarchy of directories within the file share\n* A file within the file share, which may be up to 1 TiB in size\n\nThe Azure Storage File Share client library for Python allows you to interact with each of these components through the\nuse of a dedicated client object.\n\n### Async Clients \nThis library includes a complete async API supported on Python 3.5+. To use it, you must\nfirst install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/).\nSee\n[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)\nfor more information.\n\nAsync clients and credentials should be closed when they're no longer needed. These\nobjects are async context managers and define async `close` methods.\n\n### Clients\nFour different clients are provided to interact with the various components of the File Share Service:\n1. [ShareServiceClient](https://aka.ms/azsdk-python-storage-fileshare-shareserviceclient) -\n this client represents interaction with the Azure storage account itself, and allows you to acquire preconfigured\n client instances to access the file shares within. It provides operations to retrieve and configure the service\n properties as well as list, create, and delete shares within the account. To perform operations on a specific share,\n retrieve a client using the `get_share_client` method.\n2. [ShareClient](https://aka.ms/azsdk-python-storage-fileshare-shareclient) -\n this client represents interaction with a specific file share (which need not exist yet), and allows you to acquire\n preconfigured client instances to access the directories and files within. It provides operations to create, delete,\n configure, or create snapshots of a share and includes operations to create and enumerate the contents of\n directories within it. To perform operations on a specific directory or file, retrieve a client using the\n `get_directory_client` or `get_file_client` methods.\n3. [ShareDirectoryClient](https://aka.ms/azsdk-python-storage-fileshare-sharedirectoryclient) -\n this client represents interaction with a specific directory (which need not exist yet). It provides operations to\n create, delete, or enumerate the contents of an immediate or nested subdirectory, and includes operations to create\n and delete files within it. For operations relating to a specific subdirectory or file, a client for that entity can\n also be retrieved using the `get_subdirectory_client` and `get_file_client` functions.\n4. [ShareFileClient](https://aka.ms/azsdk-python-storage-fileshare-sharefileclient) -\n this client represents interaction with a specific file (which need not exist yet). It provides operations to\n upload, download, create, delete, and copy a file.\n\nFor details on path naming restrictions, see [Naming and Referencing Shares, Directories, Files, and Metadata](https://docs.microsoft.com/rest/api/storageservices/naming-and-referencing-shares--directories--files--and-metadata).\n\n## Examples\nThe following sections provide several code snippets covering some of the most common Storage File Share tasks, including:\n\n* [Creating a file share](#creating-a-file-share \"Creating a file share\")\n* [Uploading a file](#uploading-a-file \"Uploading a file\")\n* [Downloading a file](#downloading-a-file \"Downloading a file\")\n* [Listing contents of a directory](#listing-contents-of-a-directory \"Listing contents of a directory\")\n\n### Creating a file share\nCreate a file share to store your files\n\n```python\nfrom azure.storage.fileshare import ShareClient\n\nshare = ShareClient.from_connection_string(conn_str=\"<connection_string>\", share_name=\"myshare\")\nshare.create_share()\n```\n\nUse the async client to create a file share\n\n```python\nfrom azure.storage.fileshare.aio import ShareClient\n\nshare = ShareClient.from_connection_string(conn_str=\"<connection_string>\", share_name=\"myshare\")\nawait share.create_share()\n```\n\n### Uploading a file\nUpload a file to the share\n\n```python\nfrom azure.storage.fileshare import ShareFileClient\n\nfile_client = ShareFileClient.from_connection_string(conn_str=\"<connection_string>\", share_name=\"myshare\", file_path=\"my_file\")\n\nwith open(\"./SampleSource.txt\", \"rb\") as source_file:\n file_client.upload_file(source_file)\n```\n\nUpload a file asynchronously\n\n```python\nfrom azure.storage.fileshare.aio import ShareFileClient\n\nfile_client = ShareFileClient.from_connection_string(conn_str=\"<connection_string>\", share_name=\"myshare\", file_path=\"my_file\")\n\nwith open(\"./SampleSource.txt\", \"rb\") as source_file:\n await file_client.upload_file(source_file)\n```\n\n### Downloading a file\nDownload a file from the share\n\n```python\nfrom azure.storage.fileshare import ShareFileClient\n\nfile_client = ShareFileClient.from_connection_string(conn_str=\"<connection_string>\", share_name=\"myshare\", file_path=\"my_file\")\n\nwith open(\"DEST_FILE\", \"wb\") as file_handle:\n data = file_client.download_file()\n data.readinto(file_handle)\n```\n\nDownload a file asynchronously\n\n```python\nfrom azure.storage.fileshare.aio import ShareFileClient\n\nfile_client = ShareFileClient.from_connection_string(conn_str=\"<connection_string>\", share_name=\"myshare\", file_path=\"my_file\")\n\nwith open(\"DEST_FILE\", \"wb\") as file_handle:\n data = await file_client.download_file()\n await data.readinto(file_handle)\n```\n\n### Listing contents of a directory\nList all directories and files under a parent directory\n\n```python\nfrom azure.storage.fileshare import ShareDirectoryClient\n\nparent_dir = ShareDirectoryClient.from_connection_string(conn_str=\"<connection_string>\", share_name=\"myshare\", directory_path=\"parent_dir\")\n\nmy_list = list(parent_dir.list_directories_and_files())\nprint(my_list)\n```\n\nList contents of a directory asynchronously\n\n```python\nfrom azure.storage.fileshare.aio import ShareDirectoryClient\n\nparent_dir = ShareDirectoryClient.from_connection_string(conn_str=\"<connection_string>\", share_name=\"myshare\", directory_path=\"parent_dir\")\n\nmy_files = []\nasync for item in parent_dir.list_directories_and_files():\n my_files.append(item)\nprint(my_files)\n```\n\n## Optional Configuration\n\nOptional keyword arguments that can be passed in at the client and per-operation level.\n\n### Retry Policy configuration\n\nUse the following keyword arguments when instantiating a client to configure the retry policy:\n\n* __retry_total__ (int): Total number of retries to allow. Takes precedence over other counts.\nPass in `retry_total=0` if you do not want to retry on requests. Defaults to 10.\n* __retry_connect__ (int): How many connection-related errors to retry on. Defaults to 3.\n* __retry_read__ (int): How many times to retry on read errors. Defaults to 3.\n* __retry_status__ (int): How many times to retry on bad status codes. Defaults to 3.\n* __retry_to_secondary__ (bool): Whether the request should be retried to secondary, if able.\nThis should only be enabled of RA-GRS accounts are used and potentially stale data can be handled.\nDefaults to `False`.\n\n### Other client / per-operation configuration\n\nOther optional configuration keyword arguments that can be specified on the client or per-operation.\n\n**Client keyword arguments:**\n\n* __connection_timeout__ (int): The number of seconds the client will wait to establish a connection to the server.\nDefaults to 20 seconds.\n* __read_timeout__ (int): The number of seconds the client will wait, between consecutive read operations, for a\nresponse from the server. This is a socket level timeout and is not affected by overall data size. Client-side read \ntimeouts will be automatically retried. Defaults to 60 seconds.\n* __transport__ (Any): User-provided transport to send the HTTP request.\n\n**Per-operation keyword arguments:**\n\n* __raw_response_hook__ (callable): The given callback uses the response returned from the service.\n* __raw_request_hook__ (callable): The given callback uses the request before being sent to service.\n* __client_request_id__ (str): Optional user specified identification of the request.\n* __user_agent__ (str): Appends the custom value to the user-agent header to be sent with the request.\n* __logging_enable__ (bool): Enables logging at the DEBUG level. Defaults to False. Can also be passed in at\nthe client level to enable it for all requests.\n* __logging_body__ (bool): Enables logging the request and response body. Defaults to False. Can also be passed in at\nthe client level to enable it for all requests.\n* __headers__ (dict): Pass in custom headers as key, value pairs. E.g. `headers={'CustomValue': value}`\n\n\n## Troubleshooting\n### General\nStorage File clients raise exceptions defined in [Azure Core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md).\n\nThis list can be used for reference to catch thrown exceptions. To get the specific error code of the exception, use the `error_code` attribute, i.e, `exception.error_code`.\n\n### Logging\nThis library uses the standard\n[logging](https://docs.python.org/3/library/logging.html) library for logging.\nBasic information about HTTP sessions (URLs, headers, etc.) is logged at INFO\nlevel.\n\nDetailed DEBUG level logging, including request/response bodies and unredacted\nheaders, can be enabled on a client with the `logging_enable` argument:\n```python\nimport sys\nimport logging\nfrom azure.storage.fileshare import ShareServiceClient\n\n# Create a logger for the 'azure.storage.fileshare' SDK\nlogger = logging.getLogger('azure.storage.fileshare')\nlogger.setLevel(logging.DEBUG)\n\n# Configure a console output\nhandler = logging.StreamHandler(stream=sys.stdout)\nlogger.addHandler(handler)\n\n# This client will log detailed information about its HTTP sessions, at DEBUG level\nservice_client = ShareServiceClient.from_connection_string(\"your_connection_string\", logging_enable=True)\n```\n\nSimilarly, `logging_enable` can enable detailed logging for a single operation,\neven when it isn't enabled for the client:\n```python\nservice_client.get_service_properties(logging_enable=True)\n```\n\n## Next steps\n\n### More sample code\n\nGet started with our [File Share samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples).\n\nSeveral Storage File Share Python SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Storage File Share:\n\n* [file_samples_hello_world.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_hello_world.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_hello_world_async.py)) - Examples found in this article:\n * Client creation\n * Create a file share\n * Upload a file\n\n* [file_samples_authentication.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_authentication.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_authentication_async.py)) - Examples for authenticating and creating the client:\n * From a connection string\n * From a shared access key\n * From a shared access signature token\n\n* [file_samples_service.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_service.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_service_async.py)) - Examples for interacting with the file service:\n * Get and set service properties\n * Create, list, and delete shares\n * Get a share client\n\n* [file_samples_share.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_share.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_share_async.py)) - Examples for interacting with file shares:\n * Create a share snapshot\n * Set share quota and metadata\n * List directories and files\n * Get the directory or file client to interact with a specific entity\n\n* [file_samples_directory.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_directory.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_directory_async.py)) - Examples for interacting with directories:\n * Create a directory and add files\n * Create and delete subdirectories\n * Get the subdirectory client\n\n* [file_samples_client.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_client.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share/samples/file_samples_client_async.py)) - Examples for interacting with files:\n * Create, upload, download, and delete files\n * Copy a file from a URL\n\n### Additional documentation\nFor more extensive documentation on Azure File Share storage, see the [Azure File Share storage documentation](https://docs.microsoft.com/azure/storage/files/) on docs.microsoft.com.\n\n## Contributing\nThis 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 https://cla.microsoft.com.\n\nWhen you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n\n\n# Release History\n\n## 12.20.0 (2024-11-13)\n\n### Features Added\n- Stable release of features from 12.20.0b1\n\n## 12.20.0b1 (2024-10-10)\n\n### Features Added\n- Added support for service version 2025-01-05.\n- Added support to specify `Premium` enum value in `access_tier` for `create_share` and `set_share_properties` APIs.\n- Added `file_permission_format` to specify permission format for File's `copy_file` API.\n- Added support for provisioned V2 billing model, including `provisioned_iops` and `provisioned_bandwidth_mibps` for \n`ShareClient` and `ShareServiceClient`'s `create_share` APIs; `provisioned_max_iops` and `provisioned_max_bandwidth_mibps`\nfor `ShareClient`'s `set_share_properties` API; and retrieve `included_burst_iop`, `max_burst_credits_for_iops`, \n`next_provisioned_iops_downgrade` and `next_provisioned_bandwidth_downgrade` through `get_share_properties` API. \n`ShareServiceClient`'s `list_shares` API returns the new properties through `get_share_properties` for each share.\n\n## 12.19.0 (2024-10-08)\n\n### Features Added\n- Updated type hints across the entire package and enabled MyPy to run during CI. Some public types may have been adjusted if they were previously erroneous or incomplete.\n\n## 12.18.0 (2024-09-17)\n\n### Features Added\n- Stable release of features from 12.18.0b1\n\n## 12.18.0b1 (2024-08-07)\n\n### Features Added\n- Added support for service version 2024-11-04.\n- Added support for Entra ID authentication for all data plane file operations that were previously not enabled.\n- Added support to set `paid_bursting_enabled`, `paid_bursting_bandwidth_mibps`, and `paid_bursting_iops` for Share's\n`create_share` and `set_share_properties` APIs, and also retrieve them on the `get_share_properties` API.\n- Added `file_permission_format` to specify permission format for Share's `create_permission_for_share` and\n`get_permission_for_share` APIs; File's `create_file`, `rename_file`, and `set_http_headers` APIs; and\nDirectory's `rename_directory` and `set_http_headers` APIs.\n\n### Other Changes\n- Bumped minimum `azure-core` dependency to 1.30.0.\n\n## 12.17.0 (2024-07-18)\n\n### Features Added\n- Stable release of features from 12.17.0b1\n\n## 12.17.0b1 (2024-06-11)\n\n### Features Added\n- Added a more descriptive authorization error message when facing authorization errors.\n\n## 12.16.0 (2024-05-07)\n\n### Features Added\n- Stable release of features from 12.16.0b1\n\n## 12.16.0b1 (2024-04-16)\n\nThis version and all future versions will require Python 3.8+. Python 3.7 is no longer supported.\n\n### Features Added\n- Added `exists` method to `ShareFileClient` to check if a file exists.\n- Added support for service version 2024-05-04.\n- The `services` parameter has been added to the `generate_account_sas` API, which enables the ability to generate SAS\ntokens to be used with multiple services. By default, the SAS token service scope will default to the current service.\n- Added `client_name` property to `Handle`.\n- Added support for `support_rename` to `get_ranges_diff()`\n\n### Bugs Fixed\n- Fixed an issue where the `ShareDirectoryClient` returned by `get_subdirectory_client` with a `ShareDirectoryClient`\npointing to the root of the file share would raise an `InvalidResourceName` on any operations.\n- Bumped dependency of `typing-extensions` to `>=4.6.0` to avoid potential `TypeError` with `typing.TypeVar` on\nPython 3.12.\n- Fixed an issue where authentication errors could raise `AttributeError` instead of `ClientAuthenticationError` when\nusing async OAuth credentials.\n- Fixed an issue where parameter `delete_snapshots` to `delete_share` API did not support all possible enums. This change\nmakes `delete_snapshots` now accept string literals 'include' and 'include-leased'.\n- Fixed an issue where specifying datetime objects with less than 7 digits of precision as input could incorrectly raise\n`InvalidHeaderValue` due to improper precision parsing.\n\n## 12.15.0 (2023-11-07)\n\n### Features Added\n- Stable release of features from 12.15.0b1\n\n## 12.15.0b1 (2023-10-17)\n\n### Features Added\n- Added support for service version 2023-11-03.\n- Added `audience` as an optional keyword that can be specified on APIs that have a `credential` parameter. This\nkeyword only has an effect when the credential provided is of type `TokenCredential`.\n\n## 12.14.2 (2023-10-10)\n\n### Bugs Fixed\n- Fixed an issue when an invalid type was provided for `credential` during client construction, the\n`__str__` of the object would be present in the exception message and therefore potentially logged.\n\n## 12.14.1 (2023-09-13)\n\n### Bugs Fixed\n- Fixed breaking `KeyError: 'sdk_moniker'` in `create_configuration`.\nNOTE: This is not an exported method and therefore should not be imported/called directly.\n\n## 12.14.0 (2023-09-12)\n\n### Features Added\n- Stable release of features from 12.14.0b1\n\n## 12.14.0b1 (2023-08-08)\n\n### Features Added\n- Added support for service versions 2023-05-03 and 2023-08-03.\n\n## 12.13.0 (2023-07-11)\n\n### Features Added\n- Stable release of features from 12.13.0b1\n\n## 12.13.0b1 (2023-05-30)\n\n### Features Added\n- Added support for service version 2023-01-03.\n- Added `access_rights` property to `Handle`.\n\n## 12.12.0 (2023-04-12)\n\n### Features Added\n- Stable release of features from 12.12.0b1\n\n## 12.12.0b1 (2023-03-28)\n\n### Features Added\n- Added support for service version 2022-11-02.\n- Added support for `TokenCredential` to be used for authentication. A `TokenCredential` can be provided for the\n`credential` parameter to any client constructor. **Note:** When using a `TokenCredential`, the new keyword parameter\n`token_intent` is **required** and must be provided. Additionally, this form of authentication is only supported for\ncertain operations in the Data Plane SDK.\n- Added support for `allow_trailing_dot` and `allow_source_trailing_dot` on client construction. When\n`allow_trailing_dot` is provided, the service will not silently remove any trailing `.` character from directory/file\nnames for all operations made from that client. `allow_source_trailing_dot` will apply this same rule to source files\nwhen performing a rename or copy operation.\n\n## 12.11.1 (2023-03-08)\n\n### Bugs Fixed\n- Fixed \"duplicate type signatures\" MyPy error.\n\n## 12.11.0 (2023-02-22)\n\n### Features Added\n- Stable release of features from 12.11.0b1\n\n## 12.11.0b1 (2023-02-02)\n\n### Features Added\n- Added support for service version 2021-12-02.\n- Added support for file and directory paths that contain invalid XML characters. When listing or fetching properties,\nthe service will encode illegal characters and the SDK will now automatically decode them.\n- Added support for `AsyncIterable` as data type for async file upload.\n\n### Bugs Fixed\n- Fixed an issue where keyword `name_starts_with` was not being passed to the service properly for the `list_shares` async API\n\n### Other Changes\n- Removed `msrest` dependency.\n- Added `typing-extensions>=4.0.1` as a dependency.\n- Added `isodate>=0.6.1` as a dependency.\n- Added extra dependency `aio` for installing optional async dependencies. Use `pip install azure-storage-file-share[aio]` to install.\n\n## 12.10.1 (2022-10-18)\n\n### Bugs Fixed\n- Fixed possible `ValueError` for invalid content range that gets raised when downloading empty files through Azurite.\n\n## 12.10.0 (2022-10-11)\n\n### Features Added\n- Stable release of features from 12.10.0b1.\n\n### Bugs Fixed\n- Fixed an issue where calling `download_file` with an invalid base64-encoded account key would raise an\n`AttributeError` rather than the proper `AzureSigningError`.\n\n### Other Changes\n- Changed the default value for `read_timeout` to 60 seconds for all clients.\n\n## 12.10.0b1 (2022-08-23)\n\nThis version and all future versions will require Python 3.7+. Python 3.6 is no longer supported.\n\n### Features Added\n- Added support for `AzureNamedKeyCredential` as a valid `credential` type.\n\n## 12.9.0 (2022-07-07)\n\n### Features Added\n- Stable release of features from 12.9.0b1.\n- Added support for progress tracking to `upload_file()` and `download_file()` via a new optional callback, `progress_hook`.\n\n## 12.9.0b1 (2022-06-15)\n\n### Features Added\n- Added support for `file_change_time` to `start_copy_from_url` API\n\n## 12.8.0 (2022-05-09)\n\n### Features Added\n- Stable release of features from 12.8.0b1.\n\n### Bugs Fixed\n- Fixed a bug, introduced in the previous beta release, that caused Authentication errors when attempting to use\nan Account SAS with certain service level operations.\n\n## 12.8.0b1 (2022-04-14)\n\n### Features Added\n- Added support for service version 2021-06-08.\n- Added support for missing parameters on `create_directory()` including `file_attributes`, `file_creation_time`,\n`file_last_write_time`, `file_permission` and `file_permission_key`.\n- Added support for setting `content_type` on `rename_file()`.\n- Added support for setting `file_change_time` on `create_directory()`, `set_http_headers()` (directory)\n`rename_directory()`, `create_file()`, `set_http_headers()` (file) and `rename_file()`.\n- Added support for setting `file_last_write_mode` on `upload_range()` and `upload_range_from_url()`\nwith possible values of `Now` or `Preserve`.\n\n### Bugs Fixed\n- Updated `create_share()` docstring to have the correct return-type of `None`\n\n## 12.7.0 (2022-03-08)\n\nThis version and all future versions will require Python 3.6+. Python 2.7 is no longer supported.\n\n### Stable release of preview features\n- Added support for service version 2021-02-12, 2021-04-10.\n- Added support for premium file share provisioned_bandwidth property.\n- Added support for checking if a directory exists using `exists()`.\n- Added support for `rename_directory()` and `rename_file()`.\n- Added support for `Create (c)` SAS permission for Share SAS.\n\n### Bugs Fixed\n- Fixed a bug where `start_copy_from_url()` was not sending the `ignore_read_only` parameter correctly.\n\n## 12.7.0b2 (2022-02-08)\n\nThis version and all future versions will require Python 3.6+. Python 2.7 is no longer supported.\n\n### Features Added\n- Added support for service version 2021-04-10.\n- Added support for `rename_directory()` and `rename_file()`.\n- Added support for `Create (c)` SAS permission for Share SAS.\n\n### Bugs Fixed\n- Update `azure-core` dependency to avoid inconsistent dependencies from being installed.\n- Fixed a bug, that was introduced in the previous beta release, where `generate_account_sas()`\nwas not generating the proper SAS signature.\n\n## 12.7.0b1 (2021-12-13)\n\n### Features Added\n- Added support for service version 2021-02-12.\n- Added support for premium file share provisioned_bandwidth property.\n- Added support for checking if a directory exists using `exists()`.\n\n## 12.6.0 (2021-09-15)\n**Stable release of preview features**\n- Added support for service version 2020-10-02 (STG78)\n- Added OAuth support for file copy source.\n\n## 12.6.0b1 (2021-07-27)\n**New features**\n- Added OAuth support for file copy source.\n\n**Fixes**\n- Ensured that download fails if file modified mid download\n\n## 12.5.0 (2021-06-09)\n**New features**\n- Added support for lease operation on a share, eg. acquire_lease\n\n## 12.5.0b1 (2021-05-12)\n**New features**\n- Added support for lease operation on a share, eg. acquire_lease\n\n## 12.4.2 (2021-04-20)\n**Fixes**\n- Make `AccountName`, `AccountKey` etc. in conn_str case insensitive\n- Fixed `downloader.chunks()` return chunks in different size (#9419, #15648)\n- Fixed unclosed `ThreadPoolExecutor` (#8955)\n\n## 12.4.1 (2021-01-20)\n**Fixes**\n- Fixed msrest dependency issue (#16250)\n\n## 12.4.0 (2021-01-13)\n**Stable release of preview features**\n- Added support for enabling root squash and share protocols for file share.\n- Added support for `AzureSasCredential` to allow SAS rotation in long living clients.\n\n## 12.4.0b1 (2020-12-07)\n**New features**\n- Added support for enabling root squash and share protocols for file share.\n\n\n## 12.3.0 (2020-11-10)\n**Stable release of preview features**\n- Preview feature enabling SMB Multichannel for the share service.\n- Preview feature `get_ranges` on ShareFileClient\n\n**New features**\n- Added `set_share_properties` which allows setting share tier.\n\n**Notes**\n- Updated dependency `azure-core` from azure-core<2.0.0,>=1.2.2 to azure-core<2.0.0,>=1.9.0 to get continuation_token attr on AzureError.\n\n## 12.3.0b1 (2020-10-02)\n**New features**\n- Added support for enabling SMB Multichannel for the share service.\n- Added support for leasing a share.\n- Added support for getting the range diff between current file and a snapshot as well as getting the diff between two file snapshots.\n\n\n## 12.2.0 (2020-08-13)\n**Stable release of preview features**\n- Preview feature `undelete_share` on FileShareServiceClient.\n\n## 12.2.0b1 (2020-07-07)\n**New features**\n- Added `undelete_share` on FileShareServiceClient so that users can restore deleted share on share soft delete enabled account. Users can also list deleted shares when `list_shares` by specifying `include_deleted=True`.\n\n## 12.1.2\n**Fixes**\n- Improve the performance of upload when using max_concurrency\n\n## 12.1.1 (2020-03-10)\n\n**Notes**\n- The `StorageUserAgentPolicy` is now replaced with the `UserAgentPolicy` from azure-core. With this, the custom user agents are now added as a prefix instead of being appended.\n\n## 12.1.0\n\n**New features**\n- Added support for the 2019-07-07 service version, and added `api_version` parameter to clients.\n- `ShareLeaseClient` was introduced to both sync and async versions of the SDK, which allows users to perform operations on file leases.\n- `failed_handles_count` info was included in `close_handle` and `close_all_handles` result.\n- Added support for obtaining premium file properties in `list_shares` and `get_share_properties`.\n- Added support for additional `start_copy_from_url` parameters - `file_permission`, `permission_key`, `file_attributes`, `file_creation_time`, `file_last_write_time`, `ignore_read_only`, and `set_archive_attribute`.\n\n**Fixes and improvements**\n- Fixed a bug: `clear_range` API was not working.\n\n**Fixes**\n- Responses are always decoded as UTF8\n\n## 12.0.0\n\n**New features**\n- Added `delete_directory` method to the `share_client`.\n- All the clients now have a `close()` method to close the sockets opened by the client when using without a context manager.\n\n**Fixes and improvements**\n- Fixes a bug where determining length breaks while uploading a file when provided with an invalid fileno.\n\n**Breaking changes**\n- `close_handle(handle)` and `close_all_handles()` no longer return int. These functions return a dictionary which has the number of handles closed and number of handles failed to be closed.\n\n## 12.0.0b5\n\n**Important: This package was previously named azure-storage-file**\n\nGoing forward, to use this SDK, please install `azure-storage-file-share`.\nAdditionally:\n- The namespace within the package has also been renamed to `azure.storage.fileshare`.\n- `FileServiceClient` has been renamed to `ShareServiceClient`.\n- `DirectoryClient` has been renamed to `ShareDirectoryClient`.\n- `FileClient` has been renamed to `ShareFileClient`.\n\n**Additional Breaking changes**\n\n- `ShareClient` now accepts only `account_url` with mandatory a string param `share_name`.\nTo use a share_url, the method `from_share_url` must be used.\n- `ShareDirectoryClient` now accepts only `account_url` with mandatory string params `share_name` and `directory_path`.\nTo use a directory_url, the method `from_directory_url` must be used.\n- `ShareFileClient` now accepts only `account_url` with mandatory string params `share_name` and\n`file_path`. To use a file_url, the method `from_file_url` must be used.\n- `file_permission_key` parameter has been renamed to `permission_key`\n- `set_share_access_policy` has required parameter `signed_identifiers`.\n- `NoRetry` policy has been removed. Use keyword argument `retry_total=0` for no retries.\n- Removed types that were accidentally exposed from two modules. Only `ShareServiceClient`, `ShareClient`, `ShareDirectoryClient` and `ShareFileClient` should be imported from azure.storage.fileshare.aio\n- Some parameters have become keyword only, rather than positional. Some examples include:\n - `loop`\n - `max_concurrency`\n - `validate_content`\n - `timeout` etc.\n- Client and model files have been made internal. Users should import from the top level modules `azure.storage.fileshare` and `azure.storage.fileshare.aio` only.\n- The `generate_shared_access_signature` methods on each of `ShareServiceClient`, `ShareClient` and `ShareFileClient` have been replaced by module level functions `generate_account_sas`, `generate_share_sas` and `generate_file_sas`.\n- `start_range` and `end_range` params are now renamed to and behave like`offset` and `length` in\nthe following APIs:\n - download_file\n - upload_range\n - upload_range_from_url\n - clear_range\n - get_ranges\n- `StorageStreamDownloader` is no longer iterable. To iterate over the file data stream, use `StorageStreamDownloader.chunks`.\n- The public attributes of `StorageStreamDownloader` have been limited to:\n - `name` (str): The name of the file.\n - `path` (str): The full path of the file.\n - `share` (str): The share the file will be downloaded from.\n - `properties` (`FileProperties`): The properties of the file.\n - `size` (int): The size of the download. Either the total file size, or the length of a subsection if specified. Previously called `download_size`.\n- `StorageStreamDownloader` now has new functions:\n - `readall()`: Reads the complete download stream, returning bytes. This replaces the functions `content_as_bytes` and `content_as_text` which have been deprecated.\n - `readinto(stream)`: Download the complete stream into the supplied writable stream, returning the number of bytes written. This replaces the function `download_to_stream` which has been deprecated.\n- `ShareFileClient.close_handles` and `ShareDirectoryClient.close_handles` have both been replaced by two functions each; `close_handle(handle)` and `close_all_handles()`. These functions are blocking and return integers (the number of closed handles) rather than polling objects.\n- `get_service_properties` now returns a dict with keys consistent to `set_service_properties`\n\n**New features**\n\n- `ResourceTypes`, `NTFSAttributes`, and `Services` now have method `from_string` which takes parameters as a string.\n\n\n## 12.0.0b4\n\n**Breaking changes**\n\n- Permission models.\n - `AccountPermissions`, `SharePermissions` and `FilePermissions` have been renamed to\n `AccountSasPermissions`, `ShareSasPermissions` and `FileSasPermissions` respectively.\n - enum-like list parameters have been removed from all three of them.\n - `__add__` and `__or__` methods are removed.\n- `max_connections` is now renamed to `max_concurrency`.\n\n**New features**\n\n- `AccountSasPermissions`, `FileSasPermissions`, `ShareSasPermissions` now have method `from_string` which\ntakes parameters as a string.\n\n## 12.0.0b3\n\n**New features**\n- Added upload_range_from_url API to write the bytes from one Azure File endpoint into the specified range of another Azure File endpoint.\n- Added set_http_headers for directory_client, create_permission_for_share and get_permission_for_share APIs.\n- Added optional parameters for smb properties related parameters for create_file*, create_directory* related APIs and set_http_headers API.\n- Updated get_properties for directory and file so that the response has SMB properties.\n\n**Dependency updates**\n- Adopted [azure-core](https://pypi.org/project/azure-core/) 1.0.0b3\n - If you later want to revert to previous versions of azure-storage-file, or another Azure SDK\n library requiring azure-core 1.0.0b1 or azure-core 1.0.0b2, you must explicitly install\n the specific version of azure-core as well. For example:\n\n `pip install azure-core==1.0.0b2 azure-storage-file==12.0.0b2`\n\n**Fixes and improvements**\n- Fix where content-type was being added in the request when not mentioned explicitly.\n\n\n## 12.0.0b2\n\n**Breaking changes**\n- Renamed `copy_file_from_url` to `start_copy_from_url` and changed behaviour to return a dictionary of copy properties rather than a polling object. Status of the copy operation can be retrieved with the `get_file_properties` operation.\n- Added `abort_copy` operation to the `FileClient` class. This replaces the previous abort operation on the copy status polling operation.\n- The behavior of listing operations has been modified:\n - The previous `marker` parameter has been removed.\n - The iterable response object now supports a `by_page` function that will return a secondary iterator of batches of results. This function supports a `continuation_token` parameter to replace the previous `marker` parameter.\n- The new listing behaviour is also adopted by the `receive_messages` operation:\n - The receive operation returns a message iterator as before.\n - The returned iterator supports a `by_page` operation to receive messages in batches.\n\n**New features**\n- Added async APIs to subnamespace `azure.storage.file.aio`.\n- Distributed tracing framework OpenCensus is now supported.\n\n**Dependency updates**\n- Adopted [azure-core](https://pypi.org/project/azure-core/) 1.0.0b2\n - If you later want to revert to azure-storage-file 12.0.0b1, or another Azure SDK\n library requiring azure-core 1.0.0b1, you must explicitly install azure-core\n 1.0.0b1 as well. For example:\n\n `pip install azure-core==1.0.0b1 azure-storage-file==12.0.0b1`\n\n**Fixes and improvements**\n- Fix for closing file handles - continuation token was not being passed to subsequent calls.\n- General refactor of duplicate and shared code.\n\n\n## 12.0.0b1\n\nVersion 12.0.0b1 is the first preview of our efforts to create a user-friendly and Pythonic client library for Azure Storage Files. For more information about this, and preview releases of other Azure SDK libraries, please visit\nhttps://aka.ms/azure-sdk-preview1-python.\n\n**Breaking changes: New API design**\n- Operations are now scoped to a particular client:\n - `FileServiceClient`: This client handles account-level operations. This includes managing service properties and listing the shares within an account.\n - `ShareClient`: The client handles operations for a particular share. This includes creating or deleting that share, as well as listing the directories within that share, and managing properties and metadata.\n - `DirectoryClient`: The client handles operations for a particular directory. This includes creating or deleting that directory, as well as listing the files and subdirectories, and managing properties and metadata.\n - `FileClient`: The client handles operations for a particular file. This includes creating or deleting that file, as well as upload and download data and managing properties.\n\n These clients can be accessed by navigating down the client hierarchy, or instantiated directly using URLs to the resource (account, share, directory or file).\n For full details on the new API, please see the [reference documentation](https://azure.github.io/azure-sdk-for-python/storage.html#azure-storage-file-share).\n- The copy file operation now returns a polling object that can be used to check the status of the operation, as well as abort the operation.\n- The `close_handles` operation now return a polling object that can be used to check the status of the operation.\n- Download operations now return a streaming object that can download data in multiple ways:\n - Iteration: The streamer is an iterable object that will download and yield the content in chunks. Only supports single threaded download.\n - `content_as_bytes`: Return the entire file content as bytes. Blocking operation that supports multi-threaded download.\n - `content_as_text`: Return the entire file content as decoded text. Blocking operation that supports multi-threaded download.\n - `download_to_stream`: Download the entire content to an open stream handle (e.g. an open file). Supports multi-threaded download.\n- New underlying REST pipeline implementation, based on the new `azure.core` library.\n- Client and pipeline configuration is now available via keyword arguments at both the client level, and per-operation. See reference documentation for a full list of optional configuration arguments.\n- New error hierarchy:\n - All service errors will now use the base type: `azure.core.exceptions.HttpResponseError`\n - The are a couple of specific exception types derived from this base type for common error scenarios:\n - `ResourceNotFoundError`: The resource (e.g. queue, message) could not be found. Commonly a 404 status code.\n - `ResourceExistsError`: A resource conflict - commonly caused when attempting to create a resource that already exists.\n - `ResourceModifiedError`: The resource has been modified (e.g. overwritten) and therefore the current operation is in conflict. Alternatively this may be raised if a condition on the operation is not met.\n - `ClientAuthenticationError`: Authentication failed.\n- Operation `set_file_properties` has been renamed to `set_http_headers`.\n- Operations `get_file_to_<output>` have been replaced with `download_file`. See above for download output options.\n- Operations `create_file_from_<input>` have been replace with `upload_file`.\n- Operations `get_share_acl` and `set_share_acl` have been renamed to `get_share_access_policy` and `set_share_access_policy`.\n- Operation `set_share_properties` has been renamed to `set_share_quota`.\n- Operation `snapshot_share` has been renamed to `create_snapshot`.\n- Operation `copy_file` has been renamed to `copy_file_from_url`.\n- No longer have specific operations for `get_metadata` - use `get_properties` instead.\n- No longer have specific operations for `exists` - use `get_properties` instead.\n- Operation `update_range` has been renamed to `upload_range`.\n\n## 2.0.1\n- Updated dependency on azure-storage-common.\n\n## 2.0.0\n- Support for 2018-11-09 REST version. Please see our REST API documentation and blogs for information about the related added features.\n- Added an option to get share stats in bytes.\n- Added support for listing and closing file handles.\n\n## 1.4.0\n\n- azure-storage-nspkg is not installed anymore on Python 3 (PEP420-based namespace package)\n\n## 1.3.1\n\n- Fixed design flaw where get_file_to_* methods buffer entire file when max_connections is set to 1.\n\n## 1.3.0\n\n- Support for 2018-03-28 REST version. Please see our REST API documentation and blog for information about the related added features.\n\n## 1.2.0rc1\n\n- Support for 2017-11-09 REST version. Please see our REST API documentation and blog for information about the related added features.\n\n## 1.1.0\n\n- Support for 2017-07-29 REST version. Please see our REST API documentation and blogs for information about the related added features.\n- Error message now contains the ErrorCode from the x-ms-error-code header value.\n\n## 1.0.0\n\n- The package has switched from Apache 2.0 to the MIT license.\n- Fixed bug where get_file_to_* cannot get a single byte when start_range and end_range are both equal to 0.\n- Metadata keys are now case-preserving when fetched from the service. Previously they were made lower-case by the library.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Microsoft Azure Azure File Share Storage Client Library for Python",
"version": "12.20.0",
"project_urls": {
"Homepage": "https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-file-share"
},
"split_keywords": [
"azure",
" azure sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "997e9759e27b82c021d80fbd0184176e37c79824b0b6ff4c6f517391113e5473",
"md5": "ba2da04fc4401ed93769dd9179f71f13",
"sha256": "fd5c4f09d7784d68b8ed3de473b7525904f1c4b115f9cd200c838b0ee720cb5f"
},
"downloads": -1,
"filename": "azure_storage_file_share-12.20.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba2da04fc4401ed93769dd9179f71f13",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 286485,
"upload_time": "2024-11-13T20:55:49",
"upload_time_iso_8601": "2024-11-13T20:55:49.764496Z",
"url": "https://files.pythonhosted.org/packages/99/7e/9759e27b82c021d80fbd0184176e37c79824b0b6ff4c6f517391113e5473/azure_storage_file_share-12.20.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "486dd14447b85df0455a612e5df97d18bf1b4bf3fcc0716fcbf2c50b79f154bd",
"md5": "c92f978a4891c3fd1eb0012ec697790f",
"sha256": "f120fc67bae0a84c1b54d06faa70df351be14d1395b9a085350e833f7d347a65"
},
"downloads": -1,
"filename": "azure_storage_file_share-12.20.0.tar.gz",
"has_sig": false,
"md5_digest": "c92f978a4891c3fd1eb0012ec697790f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 344595,
"upload_time": "2024-11-13T20:55:47",
"upload_time_iso_8601": "2024-11-13T20:55:47.362963Z",
"url": "https://files.pythonhosted.org/packages/48/6d/d14447b85df0455a612e5df97d18bf1b4bf3fcc0716fcbf2c50b79f154bd/azure_storage_file_share-12.20.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 20:55:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Azure",
"github_project": "azure-sdk-for-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "azure-storage-file-share"
}
JSON
