Merge pull request Azure#10474 from Azure/task-adls-adddocumentation

Update documentation of Get-AzDataLakeStoreDeletedItem and Restore-AzDataLakeStoreDeletedItem
hyonholee · Nov 6, 2019 · 794c763 · 794c763
2 parents c8cbc41 + 61c4731
commit 794c763
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/src/DataLakeStore/DataLakeStore/ChangeLog.md b/src/DataLakeStore/DataLakeStore/ChangeLog.md
@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Update documentation of Get-AzDataLakeStoreDeletedItem and Restore-AzDataLakeStoreDeletedItem
 
 ## Version 1.2.4
 * Update ADLS SDK version (https://github.com/Azure/azure-data-lake-store-net/blob/preview-alpha/CHANGELOG.md#version-123-alpha), brings following fixes

diff --git a/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreDeletedItem.md b/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreDeletedItem.md
@@ -22,6 +22,8 @@ Get-AzDataLakeStoreDeletedItem [-Account] <String> [-Filter] <String> [-Count <I
 The **Get-AzDataLakeStoreDeletedItem** cmdlet searches the deleted files or folders in Data Lake Store which match the given filter.
 It displays the following attributes of the deleted items - OriginalPath, TrashDirPath, Type, CreationTime.
 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.
+ 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. 
+ 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.
 
 ## EXAMPLES
 

diff --git a/src/DataLakeStore/DataLakeStore/help/Restore-AzDataLakeStoreDeletedItem.md b/src/DataLakeStore/DataLakeStore/help/Restore-AzDataLakeStoreDeletedItem.md
@@ -29,6 +29,8 @@ Restore-AzDataLakeStoreDeletedItem [-Account] <String> [-DeletedItem] <DataLakeS
 
 ## DESCRIPTION
 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.
+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. 
+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.
 
 ## EXAMPLES