Skip to content

Commit 794c763

Browse files
authored
Merge pull request Azure#10474 from Azure/task-adls-adddocumentation
Update documentation of Get-AzDataLakeStoreDeletedItem and Restore-AzDataLakeStoreDeletedItem
2 parents c8cbc41 + 61c4731 commit 794c763

File tree

3 files changed

+5
-0
lines changed

3 files changed

+5
-0
lines changed

src/DataLakeStore/DataLakeStore/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
- Additional information about change #1
1919
-->
2020
## Upcoming Release
21+
* Update documentation of Get-AzDataLakeStoreDeletedItem and Restore-AzDataLakeStoreDeletedItem
2122

2223
## Version 1.2.4
2324
* Update ADLS SDK version (https://github.com/Azure/azure-data-lake-store-net/blob/preview-alpha/CHANGELOG.md#version-123-alpha), brings following fixes

src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreDeletedItem.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Get-AzDataLakeStoreDeletedItem [-Account] <String> [-Filter] <String> [-Count <I
2222
The **Get-AzDataLakeStoreDeletedItem** cmdlet searches the deleted files or folders in Data Lake Store which match the given filter.
2323
It displays the following attributes of the deleted items - OriginalPath, TrashDirPath, Type, CreationTime.
2424
This could be a long running operation as it may have to search through millions of files in trash and could be run as a job.
25+
Caution: Undeleting files is a best effort operation. There are no guarantees that a file can be restored once it is deleted. The use of this API is enabled via whitelisting.
26+
If your ADL account is not whitelisted, then using this api will throw Not implemented exception. For further information and assistance please contact Microsoft support.
2527

2628
## EXAMPLES
2729

src/DataLakeStore/DataLakeStore/help/Restore-AzDataLakeStoreDeletedItem.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Restore-AzDataLakeStoreDeletedItem [-Account] <String> [-DeletedItem] <DataLakeS
2929

3030
## DESCRIPTION
3131
The **Restore-AzDataLakeStoreDeletedItem** cmdlet restores a deleted file or folder in Data Lake Store. Requires the path of deleted item in trash returned by Get-AzDataLakeStoreDeletedItem.
32+
Caution: Undeleting files is a best effort operation. There are no guarantees that a file can be restored once it is deleted. The use of this API is enabled via whitelisting.
33+
If your ADL account is not whitelisted, then using this api will throw Not implemented exception. For further information and assistance please contact Microsoft support.
3234

3335
## EXAMPLES
3436

0 commit comments

Comments
 (0)