Skip to content

Commit ee9ea21

Browse files
Improve README by linking to documentation per client (#37064)
1 parent f671e6d commit ee9ea21

File tree

1 file changed

+10
-5
lines changed
  • sdk/storage/azure-storage-file-datalake

1 file changed

+10
-5
lines changed

sdk/storage/azure-storage-file-datalake/README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,26 +92,31 @@ objects are async context managers and define async `close` methods.
9292
#### Clients
9393

9494
The DataLake Storage SDK provides four different clients to interact with the DataLake Service:
95-
1. **DataLakeServiceClient** - this client interacts with the DataLake Service at the account level.
95+
1. [DataLakeServiceClient](https://learn.microsoft.com/python/api/azure-storage-file-datalake/azure.storage.filedatalake.datalakeserviceclient?view=azure-python) -
96+
this client interacts with the DataLake Service at the account level.
9697
It provides operations to retrieve and configure the account properties
9798
as well as list, create, and delete file systems within the account.
9899
For operations relating to a specific file system, directory or file, clients for those entities
99100
can also be retrieved using the `get_file_client`, `get_directory_client` or `get_file_system_client` functions.
100-
2. **FileSystemClient** - this client represents interaction with a specific
101+
2. [FileSystemClient](https://learn.microsoft.com/python/api/azure-storage-file-datalake/azure.storage.filedatalake.filesystemclient?view=azure-python) -
102+
this client represents interaction with a specific
101103
file system, even if that file system does not exist yet. It provides operations to create, delete, or
102104
configure file systems and includes operations to list paths under file system, upload, and delete file or
103105
directory in the file system.
104106
For operations relating to a specific file, the client can also be retrieved using
105107
the `get_file_client` function.
106108
For operations relating to a specific directory, the client can be retrieved using
107109
the `get_directory_client` function.
108-
3. **DataLakeDirectoryClient** - this client represents interaction with a specific
110+
3. [DatalakeDirectoryClient](https://learn.microsoft.com/python/api/azure-storage-file-datalake/azure.storage.filedatalake.datalakedirectoryclient?view=azure-python) -
111+
this client represents interaction with a specific
109112
directory, even if that directory does not exist yet. It provides directory operations create, delete, rename,
110113
get properties and set properties operations.
111-
3. **DataLakeFileClient** - this client represents interaction with a specific
114+
4. [DatalakeFileClient](https://learn.microsoft.com/python/api/azure-storage-file-datalake/azure.storage.filedatalake.datalakefileclient?view=azure-python) -
115+
this client represents interaction with a specific
112116
file, even if that file does not exist yet. It provides file operations to append data, flush data, delete,
113117
create, and read file.
114-
4. **DataLakeLeaseClient** - this client represents lease interactions with a FileSystemClient, DataLakeDirectoryClient
118+
5. [DatalakeLeaseClient](https://learn.microsoft.com/python/api/azure-storage-file-datalake/azure.storage.filedatalake.datalakeleaseclient?view=azure-python) -
119+
this client represents lease interactions with a FileSystemClient, DataLakeDirectoryClient
115120
or DataLakeFileClient. It provides operations to acquire, renew, release, change, and break leases on the resources.
116121

117122
## Examples

0 commit comments

Comments
 (0)