Skip to content

Commit 4232b11

Browse files
committed
Update docs metadata
1 parent 5160bbd commit 4232b11

File tree

2 files changed

+27
-18
lines changed

2 files changed

+27
-18
lines changed

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

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Azure DataLake service client library for Python
33
keywords: Azure, python, SDK, API, azure-storage-file-datalake, storage
4-
ms.date: 08/07/2024
4+
ms.date: 10/10/2024
55
ms.topic: reference
66
ms.devlang: python
77
ms.service: storage
88
---
9-
# Azure DataLake service client library for Python - version 12.17.0b1
9+
# Azure DataLake service client library for Python - version 12.18.0b1
1010

1111
Overview
1212

@@ -15,12 +15,12 @@ This preview package for Python includes ADLS Gen2 specific API support made ava
1515
2. Permission related operations (Get/Set ACLs) for hierarchical namespace enabled (HNS) accounts.
1616

1717

18-
[Source code](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-datalake_12.17.0b1/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake)
18+
[Source code](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-datalake_12.18.0b1/sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake)
1919
| [Package (PyPi)](https://pypi.org/project/azure-storage-file-datalake/)
2020
| [Package (Conda)](https://anaconda.org/microsoft/azure-storage/)
2121
| [API reference documentation](https://aka.ms/azsdk-python-storage-filedatalake-ref)
2222
| [Product documentation](/azure/storage/)
23-
| [Samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-datalake_12.17.0b1/sdk/storage/azure-storage-file-datalake/samples)
23+
| [Samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-datalake_12.18.0b1/sdk/storage/azure-storage-file-datalake/samples)
2424

2525

2626
## Getting started
@@ -64,7 +64,7 @@ Interaction with DataLake Storage starts with an instance of the DataLakeService
6464
To authenticate the client you have a few options:
6565
1. Use a SAS token string
6666
2. Use an account shared access key
67-
3. Use a token credential from [azure.identity](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-datalake_12.17.0b1/sdk/identity/azure-identity)
67+
3. Use a token credential from [azure.identity](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-datalake_12.18.0b1/sdk/identity/azure-identity)
6868

6969
Alternatively, you can authenticate with a storage connection string using the `from_connection_string` method. See example: [Client creation with a connection string](#client-creation-with-a-connection-string).
7070

@@ -92,7 +92,7 @@ DataLake storage offers four types of resources:
9292
This library includes a complete async API supported on Python 3.5+. To use it, you must
9393
first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/).
9494
See
95-
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/azure-storage-file-datalake_12.17.0b1/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
95+
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/azure-storage-file-datalake_12.18.0b1/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
9696
for more information.
9797

9898
Async clients and credentials should be closed when they're no longer needed. These
@@ -101,26 +101,31 @@ objects are async context managers and define async `close` methods.
101101
#### Clients
102102

103103
The DataLake Storage SDK provides four different clients to interact with the DataLake Service:
104-
1. **DataLakeServiceClient** - this client interacts with the DataLake Service at the account level.
104+
1. [DataLakeServiceClient](https://learn.microsoft.com/python/api/azure-storage-file-datalake/azure.storage.filedatalake.datalakeserviceclient?view=azure-python) -
105+
this client interacts with the DataLake Service at the account level.
105106
It provides operations to retrieve and configure the account properties
106107
as well as list, create, and delete file systems within the account.
107108
For operations relating to a specific file system, directory or file, clients for those entities
108109
can also be retrieved using the `get_file_client`, `get_directory_client` or `get_file_system_client` functions.
109-
2. **FileSystemClient** - this client represents interaction with a specific
110+
2. [FileSystemClient](https://learn.microsoft.com/python/api/azure-storage-file-datalake/azure.storage.filedatalake.filesystemclient?view=azure-python) -
111+
this client represents interaction with a specific
110112
file system, even if that file system does not exist yet. It provides operations to create, delete, or
111113
configure file systems and includes operations to list paths under file system, upload, and delete file or
112114
directory in the file system.
113115
For operations relating to a specific file, the client can also be retrieved using
114116
the `get_file_client` function.
115117
For operations relating to a specific directory, the client can be retrieved using
116118
the `get_directory_client` function.
117-
3. **DataLakeDirectoryClient** - this client represents interaction with a specific
119+
3. [DatalakeDirectoryClient](https://learn.microsoft.com/python/api/azure-storage-file-datalake/azure.storage.filedatalake.datalakedirectoryclient?view=azure-python) -
120+
this client represents interaction with a specific
118121
directory, even if that directory does not exist yet. It provides directory operations create, delete, rename,
119122
get properties and set properties operations.
120-
3. **DataLakeFileClient** - this client represents interaction with a specific
123+
4. [DatalakeFileClient](https://learn.microsoft.com/python/api/azure-storage-file-datalake/azure.storage.filedatalake.datalakefileclient?view=azure-python) -
124+
this client represents interaction with a specific
121125
file, even if that file does not exist yet. It provides file operations to append data, flush data, delete,
122126
create, and read file.
123-
4. **DataLakeLeaseClient** - this client represents lease interactions with a FileSystemClient, DataLakeDirectoryClient
127+
5. [DatalakeLeaseClient](https://learn.microsoft.com/python/api/azure-storage-file-datalake/azure.storage.filedatalake.datalakeleaseclient?view=azure-python) -
128+
this client represents lease interactions with a FileSystemClient, DataLakeDirectoryClient
124129
or DataLakeFileClient. It provides operations to acquire, renew, release, change, and break leases on the resources.
125130

126131
## Examples
@@ -227,7 +232,7 @@ the client level to enable it for all requests.
227232

228233
## Troubleshooting
229234
### General
230-
DataLake Storage clients raise exceptions defined in [Azure Core](https://github.com/Azure/azure-sdk-for-python/blob/azure-storage-file-datalake_12.17.0b1/sdk/core/azure-core/README.md).
235+
DataLake Storage clients raise exceptions defined in [Azure Core](https://github.com/Azure/azure-sdk-for-python/blob/azure-storage-file-datalake_12.18.0b1/sdk/core/azure-core/README.md).
231236

232237
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`.
233238

@@ -266,19 +271,19 @@ service_client.list_file_systems(logging_enable=True)
266271

267272
### More sample code
268273

269-
Get started with our [Azure DataLake samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-datalake_12.17.0b1/sdk/storage/azure-storage-file-datalake/samples).
274+
Get started with our [Azure DataLake samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-datalake_12.18.0b1/sdk/storage/azure-storage-file-datalake/samples).
270275

271276
Several DataLake Storage 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 DataLake Storage:
272277

273-
* [`datalake_samples_access_control.py`](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-datalake_12.17.0b1/sdk/storage/azure-storage-file-datalake/samples/datalake_samples_access_control.py) - Examples for common DataLake Storage tasks:
278+
* [`datalake_samples_access_control.py`](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-datalake_12.18.0b1/sdk/storage/azure-storage-file-datalake/samples/datalake_samples_access_control.py) - Examples for common DataLake Storage tasks:
274279
* Set up a file system
275280
* Create a directory
276281
* Set/Get access control for the directory
277282
* Create files under the directory
278283
* Set/Get access control for each file
279284
* Delete file system
280285

281-
* [`datalake_samples_upload_download.py`](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-datalake_12.17.0b1/sdk/storage/azure-storage-file-datalake/samples/datalake_samples_upload_download.py) - Examples for common DataLake Storage tasks:
286+
* [`datalake_samples_upload_download.py`](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-file-datalake_12.18.0b1/sdk/storage/azure-storage-file-datalake/samples/datalake_samples_upload_download.py) - Examples for common DataLake Storage tasks:
282287
* Set up a file system
283288
* Create file
284289
* Append data to the file
@@ -289,7 +294,7 @@ Several DataLake Storage Python SDK samples are available to you in the SDK's Gi
289294

290295
### Additional documentation
291296

292-
Table for [ADLS Gen1 to ADLS Gen2 API Mapping](https://github.com/Azure/azure-sdk-for-python/blob/azure-storage-file-datalake_12.17.0b1/sdk/storage/azure-storage-file-datalake/GEN1_GEN2_MAPPING.md)
297+
Table for [ADLS Gen1 to ADLS Gen2 API Mapping](https://github.com/Azure/azure-sdk-for-python/blob/azure-storage-file-datalake_12.18.0b1/sdk/storage/azure-storage-file-datalake/GEN1_GEN2_MAPPING.md)
293298
For more extensive REST documentation on Data Lake Storage Gen2, see the [Data Lake Storage Gen2 documentation](/rest/api/storageservices/datalakestoragegen2/filesystem) on docs.microsoft.com.
294299

295300

metadata/preview/azure-storage-file-datalake.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Name": "azure-storage-file-datalake",
3-
"Version": "12.17.0b1",
3+
"Version": "12.18.0b1",
44
"DevVersion": null,
55
"DirectoryPath": "sdk/storage/azure-storage-file-datalake",
66
"ServiceDirectory": "storage",
@@ -10,7 +10,11 @@
1010
"SdkType": "client",
1111
"IsNewSdk": true,
1212
"ArtifactName": "azure-storage-file-datalake",
13-
"ReleaseStatus": "2024-08-07",
13+
"ReleaseStatus": "2024-10-10",
14+
"IncludedForValidation": false,
15+
"AdditionalValidationPackages": [
16+
""
17+
],
1418
"Namespaces": [
1519
"azure.storage.filedatalake"
1620
]

0 commit comments

Comments
 (0)