Skip to content

Commit a093d17

Browse files
committed
Update docs metadata
1 parent 4ef060b commit a093d17

File tree

2 files changed

+31
-35
lines changed

2 files changed

+31
-35
lines changed

docs-ref-services/preview/storage-file-share-readme.md

Lines changed: 29 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,31 @@
11
---
22
title: Azure Storage File Share client library for Python
33
keywords: Azure, python, SDK, API, azure-storage-file-share, storage
4-
author: amishra-dev
5-
ms.author: amishra
6-
ms.date: 04/14/2022
4+
author: annatisch
5+
ms.author: antisch
6+
ms.date: 06/15/2022
77
ms.topic: reference
8-
ms.prod: azure
9-
ms.technology: azure
108
ms.devlang: python
119
ms.service: storage
1210
---
13-
## _Disclaimer_
14-
_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
1512

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.
1914

2015
Azure file shares can be used to:
2116

2217
* Replace or supplement on-premises file servers
2318
* "Lift and shift" applications
2419
* Simplify cloud development with shared application settings, diagnostic share, and Dev/Test/Debug tools
2520

26-
[Source code](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.8.0b1/sdk/storage/azure-storage-file-share/azure/storage/fileshare) | [Package (PyPI)](https://pypi.org/project/azure-storage-file-share/) | [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/azure-storage-file-share_12.8.0b1/sdk/storage/azure-storage-file-share/samples)
21+
[Source code](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.9.0b1/sdk/storage/azure-storage-file-share/azure/storage/fileshare) | [Package (PyPI)](https://pypi.org/project/azure-storage-file-share/) | [API reference documentation](https://aka.ms/azsdk-python-storage-fileshare-ref) | [Product documentation](/azure/storage/) | [Samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-share_12.9.0b1/sdk/storage/azure-storage-file-share/samples)
2722

2823
## Getting started
2924

3025
### Prerequisites
3126
* Python 3.6 or later is required to use this package.
3227
* You must have an [Azure subscription](https://azure.microsoft.com/free/) and an
33-
[Azure storage account](https://docs.microsoft.com/azure/storage/common/storage-account-overview) to use this package.
28+
[Azure storage account](/azure/storage/common/storage-account-overview) to use this package.
3429

3530
### Install the package
3631
Install the Azure Storage File Share client library for Python with [pip](https://pypi.org/project/pip/):
@@ -41,9 +36,9 @@ pip install azure-storage-file-share
4136

4237
### Create a storage account
4338
If you wish to create a new storage account, you can use the
44-
[Azure Portal](https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal),
45-
[Azure PowerShell](https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-powershell),
46-
or [Azure CLI](https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-cli):
39+
[Azure Portal](/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal),
40+
[Azure PowerShell](/azure/storage/common/storage-quickstart-create-account?tabs=azure-powershell),
41+
or [Azure CLI](/azure/storage/common/storage-quickstart-create-account?tabs=azure-cli):
4742

4843
```bash
4944
# Create a new resource group to hold the storage account -
@@ -68,9 +63,9 @@ service = ShareServiceClient(account_url="https://<my-storage-account-name>.file
6863

6964
#### Looking up the account URL
7065
You can find the storage account's file service URL using the
71-
[Azure Portal](https://docs.microsoft.com/azure/storage/common/storage-account-overview#storage-account-endpoints),
72-
[Azure PowerShell](https://docs.microsoft.com/powershell/module/az.storage/get-azstorageaccount),
73-
or [Azure CLI](https://docs.microsoft.com/cli/azure/storage/account?view=azure-cli-latest#az-storage-account-show):
66+
[Azure Portal](/azure/storage/common/storage-account-overview#storage-account-endpoints),
67+
[Azure PowerShell](/powershell/module/az.storage/get-azstorageaccount),
68+
or [Azure CLI](/cli/azure/storage/account?view=azure-cli-latest#az-storage-account-show):
7469

7570
```bash
7671
# Get the file service URL for the storage account
@@ -79,8 +74,8 @@ az storage account show -n my-storage-account-name -g my-resource-group --query
7974

8075
#### Types of credentials
8176
The `credential` parameter may be provided in a number of different forms, depending on the type of
82-
[authorization](https://docs.microsoft.com/azure/storage/common/storage-auth) you wish to use:
83-
1. To use a [shared access signature (SAS) token](https://docs.microsoft.com/azure/storage/common/storage-sas-overview),
77+
[authorization](/azure/storage/common/storage-auth) you wish to use:
78+
1. To use a [shared access signature (SAS) token](/azure/storage/common/storage-sas-overview),
8479
provide the token as a string. If your account URL includes the SAS token, omit the credential parameter.
8580
You can generate a SAS token from the Azure Portal under "Shared access signature" or use one of the `generate_sas()`
8681
functions to create a sas token for the storage account, share, or file:
@@ -100,7 +95,7 @@ The `credential` parameter may be provided in a number of different forms, depen
10095
share_service_client = ShareServiceClient(account_url="https://<my_account_name>.file.core.windows.net", credential=sas_token)
10196
```
10297

103-
2. To use a storage account [shared key](https://docs.microsoft.com/rest/api/storageservices/authenticate-with-shared-key/)
98+
2. To use a storage account [shared key](/rest/api/storageservices/authenticate-with-shared-key/)
10499
(aka account key or access key), provide the key as a string. This can be found in the Azure Portal under the "Access Keys"
105100
section or by running the following Azure CLI command:
106101

@@ -144,7 +139,7 @@ use of a dedicated client object.
144139
This library includes a complete async API supported on Python 3.5+. To use it, you must
145140
first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/).
146141
See
147-
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/azure-storage-file-share_12.8.0b1/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
142+
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/azure-storage-file-share_12.9.0b1/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
148143
for more information.
149144

150145
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
172167
this client represents interaction with a specific file (which need not exist yet). It provides operations to
173168
upload, download, create, delete, and copy a file.
174169

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).
176171

177172
## Examples
178173
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
297292

298293
**Client keyword arguments:**
299294

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.
301297
* __transport__ (Any): User-provided transport to send the HTTP request.
302298

303299
**Per-operation keyword arguments:**
@@ -315,7 +311,7 @@ the client level to enable it for all requests.
315311

316312
## Troubleshooting
317313
### 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).
319315

320316
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`.
321317

@@ -354,42 +350,42 @@ service_client.get_service_properties(logging_enable=True)
354350

355351
### More sample code
356352

357-
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).
358354

359355
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:
360356

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:
362358
* Client creation
363359
* Create a file share
364360
* Upload a file
365361

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:
367363
* From a connection string
368364
* From a shared access key
369365
* From a shared access signature token
370366

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:
372368
* Get and set service properties
373369
* Create, list, and delete shares
374370
* Get a share client
375371

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:
377373
* Create a share snapshot
378374
* Set share quota and metadata
379375
* List directories and files
380376
* Get the directory or file client to interact with a specific entity
381377

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:
383379
* Create a directory and add files
384380
* Create and delete subdirectories
385381
* Get the subdirectory client
386382

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:
388384
* Create, upload, download, and delete files
389385
* Copy a file from a URL
390386

391387
### 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.
393389

394390
## Contributing
395391
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.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Name": "azure-storage-file-share",
3-
"Version": "12.8.0b1",
3+
"Version": "12.9.0b1",
44
"DevVersion": null,
55
"DirectoryPath": "sdk/storage/azure-storage-file-share",
66
"ServiceDirectory": "storage",
@@ -10,5 +10,5 @@
1010
"SdkType": "client",
1111
"IsNewSdk": true,
1212
"ArtifactName": "azure-storage-file-share",
13-
"ReleaseStatus": "2022-04-14"
13+
"ReleaseStatus": "2022-06-15"
1414
}

0 commit comments

Comments
 (0)