Skip to content

Commit 3cd5a66

Browse files
yifanz0BethanyZhou
andauthored
Update examples for Close-AzStorageFileHandle (#17513)
* update doc * Update src/Storage/Storage.Management/help/Close-AzStorageFileHandle.md * Update src/Storage/Storage.Management/help/Close-AzStorageFileHandle.md * Update src/Storage/Storage.Management/help/Close-AzStorageFileHandle.md * Update src/Storage/Storage.Management/help/Close-AzStorageFileHandle.md Co-authored-by: Beisi Zhou <[email protected]>
1 parent b2a172e commit 3cd5a66

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

src/Storage/Storage.Management/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+
* Updated examples in reference documentation for `Close-AzStorageFileHandle`
2122
* Supported create storage context with customized blob, queue, file, table service endpoint
2223
- `New-AzStorageContext`
2324
* Fixed copy blob failure on Premium Storage account, or account enabled hierarchical namespace

src/Storage/Storage.Management/help/Close-AzStorageFileHandle.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -65,34 +65,34 @@ The **Close-AzStorageFileHandle** cmdlet closes file handles of a file share, o
6565

6666
## EXAMPLES
6767

68-
### Example 1: Lists all file shares of current Storage Account, and close all file handles of the file shares recursively.
68+
### Example 1: Close all file handles on a file
6969
```
70-
PS C:\>Get-AzStorageShare | Close-AzStorageFileHandle -CloseAll -Recursive
70+
PS C:\> Close-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2/test.txt' -CloseAll
7171
```
7272

73-
This command lists all file shares of current Storage Account, and close all file handles of the file shares recursively..
73+
This command closes all file handles on a file.
7474

75-
### Example 2: Close all file handles on a file directory recursively and show the closed file handle count
75+
### Example 2: Close all file handles which is opened 1 day ago on a file directory
7676
```
77-
PS C:\>Close-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2' -Recursive -CloseAll -PassThru
78-
10
77+
PS C:\> Get-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2' -Recursive | ? {$_.OpenTime.DateTime.AddDays(1) -lt (Get-Date)} | Close-AzStorageFileHandle -ShareName "mysharename"
7978
```
8079

81-
This command closes all file handles on a file directory and show the closed file handle count.
80+
This command lists all file handles on a file directory recursively, filters out the handles which are opened 1 day ago, and then closes them.
8281

83-
### Example 3: Close all file handles which is opened 1 day ago on a file directory
82+
### Example 3: Close all file handles on a file directory recursively and show the closed file handle count
8483
```
85-
PS C:\>Get-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2' -Recursive | ? {$_.OpenTime.DateTime.AddDays(1) -lt (Get-Date)} | Close-AzStorageFileHandle -ShareName "mysharename"
84+
PS C:\> Close-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2' -Recursive -CloseAll -PassThru
85+
10
8686
```
8787

88-
This command lists all file handles on a file directory recursively, filters out the handles which are opened 1 day ago, and then close them.
88+
This command closes all file handles on a file directory and shows the closed file handle count.
8989

90-
### Example 4: Close all file handles on a file
90+
### Example 4: Close all file handles on a file share
9191
```
92-
PS C:\>Close-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2/test.txt' -CloseAll
92+
PS C:\> Close-AzStorageFileHandle -ShareName "mysharename" -CloseAll -Recursive
9393
```
9494

95-
This command closes all file handles on a file.
95+
This command closes all file handles on a specific file share recursively.
9696

9797
## PARAMETERS
9898

0 commit comments

Comments
 (0)