You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_
11
+
# Azure Storage File Share client library for Python - Version 12.9.0b1
15
12
16
-
# Azure Storage File Share client library for Python - Version 12.8.0b1
17
-
18
-
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.
13
+
Azure File Share storage offers fully managed file shares in the cloud that are accessible via the industry standard [Server Message Block (SMB) protocol](/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.
19
14
20
15
Azure file shares can be used to:
21
16
22
17
* Replace or supplement on-premises file servers
23
18
* "Lift and shift" applications
24
19
* Simplify cloud development with shared application settings, diagnostic share, and Dev/Test/Debug tools
Async clients and credentials should be closed when they're no longer needed. These
@@ -172,7 +167,7 @@ Four different clients are provided to interact with the various components of t
172
167
this client represents interaction with a specific file (which need not exist yet). It provides operations to
173
168
upload, download, create, delete, and copy a file.
174
169
175
-
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).
170
+
For details on path naming restrictions, see [Naming and Referencing Shares, Directories, Files, and Metadata](/rest/api/storageservices/naming-and-referencing-shares--directories--files--and-metadata).
176
171
177
172
## Examples
178
173
The following sections provide several code snippets covering some of the most common Storage File Share tasks, including:
@@ -297,7 +292,8 @@ Other optional configuration keyword arguments that can be specified on the clie
297
292
298
293
**Client keyword arguments:**
299
294
300
-
*__connection_timeout__ (int): Optionally sets the connect and read timeout value, in seconds.
295
+
*__connection_timeout__ (int): The number of seconds the client will wait to establish a connection to the server.
296
+
*__read_timeout__ (int): The number of seconds the client will wait, after the connections has been established, for the server to send a response.
301
297
*__transport__ (Any): User-provided transport to send the HTTP request.
302
298
303
299
**Per-operation keyword arguments:**
@@ -315,7 +311,7 @@ the client level to enable it for all requests.
315
311
316
312
## Troubleshooting
317
313
### General
318
-
Storage File clients raise exceptions defined in [Azure Core](https://github.com/Azure/azure-sdk-for-python/blob/azure-storage-file-share_12.8.0b1/sdk/core/azure-core/README.md).
314
+
Storage File clients raise exceptions defined in [Azure Core](https://github.com/Azure/azure-sdk-for-python/blob/azure-storage-file-share_12.9.0b1/sdk/core/azure-core/README.md).
319
315
320
316
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`.
Get started with our [File Share samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.8.0b1/sdk/storage/azure-storage-file-share/samples).
353
+
Get started with our [File Share samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.9.0b1/sdk/storage/azure-storage-file-share/samples).
358
354
359
355
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:
360
356
361
-
*[file_samples_hello_world.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.8.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_hello_world.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.8.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_hello_world_async.py)) - Examples found in this article:
357
+
*[file_samples_hello_world.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.9.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_hello_world.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.9.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_hello_world_async.py)) - Examples found in this article:
362
358
* Client creation
363
359
* Create a file share
364
360
* Upload a file
365
361
366
-
*[file_samples_authentication.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.8.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_authentication.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.8.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_authentication_async.py)) - Examples for authenticating and creating the client:
362
+
*[file_samples_authentication.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.9.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_authentication.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.9.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_authentication_async.py)) - Examples for authenticating and creating the client:
367
363
* From a connection string
368
364
* From a shared access key
369
365
* From a shared access signature token
370
366
371
-
*[file_samples_service.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.8.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_service.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.8.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_service_async.py)) - Examples for interacting with the file service:
367
+
*[file_samples_service.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.9.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_service.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.9.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_service_async.py)) - Examples for interacting with the file service:
372
368
* Get and set service properties
373
369
* Create, list, and delete shares
374
370
* Get a share client
375
371
376
-
*[file_samples_share.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.8.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_share.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.8.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_share_async.py)) - Examples for interacting with file shares:
372
+
*[file_samples_share.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.9.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_share.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.9.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_share_async.py)) - Examples for interacting with file shares:
377
373
* Create a share snapshot
378
374
* Set share quota and metadata
379
375
* List directories and files
380
376
* Get the directory or file client to interact with a specific entity
381
377
382
-
*[file_samples_directory.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.8.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_directory.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.8.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_directory_async.py)) - Examples for interacting with directories:
378
+
*[file_samples_directory.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.9.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_directory.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.9.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_directory_async.py)) - Examples for interacting with directories:
383
379
* Create a directory and add files
384
380
* Create and delete subdirectories
385
381
* Get the subdirectory client
386
382
387
-
*[file_samples_client.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.8.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_client.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.8.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_client_async.py)) - Examples for interacting with files:
383
+
*[file_samples_client.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.9.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_client.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.9.0b1/sdk/storage/azure-storage-file-share/samples/file_samples_client_async.py)) - Examples for interacting with files:
388
384
* Create, upload, download, and delete files
389
385
* Copy a file from a URL
390
386
391
387
### Additional documentation
392
-
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.
388
+
For more extensive documentation on Azure File Share storage, see the [Azure File Share storage documentation](/azure/storage/files/) on docs.microsoft.com.
393
389
394
390
## Contributing
395
391
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.
0 commit comments