@@ -15,49 +15,49 @@ Closes file handles of a file share, a file directory or a file.
15
15
### ShareNameCloseAll (Default)
16
16
```
17
17
Close-AzStorageFileHandle [-ShareName] <String> [[-Path] <String>] [-Recursive] [-CloseAll]
18
- [-Context <IStorageContext> ] [-DisAllowTrailingDot ] [-PassThru ] [-AsJob ] [-ServerTimeoutPerRequest <Int32>]
18
+ [-DisAllowTrailingDot ] [-PassThru ] [-AsJob ] [-Context <IStorageContext> ] [-ServerTimeoutPerRequest <Int32>]
19
19
[-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>]
20
- [-ProgressAction <ActionPreference>] [- WhatIf] [-Confirm] [<CommonParameters>]
20
+ [-WhatIf] [-Confirm] [<CommonParameters>]
21
21
```
22
22
23
23
### ShareNameCloseSingle
24
24
```
25
- Close-AzStorageFileHandle [-ShareName] <String> -FileHandle <PSFileHandle> [-Context <IStorageContext> ]
26
- [-DisAllowTrailingDot ] [-PassThru ] [-AsJob ] [-ServerTimeoutPerRequest <Int32>]
27
- [-ClientTimeoutPerRequest <Int32 >] [-DefaultProfile <IAzureContextContainer >] [-ConcurrentTaskCount <Int32> ]
28
- [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [ <CommonParameters>]
25
+ Close-AzStorageFileHandle [-ShareName] <String> -FileHandle <PSFileHandle> [-DisAllowTrailingDot] [-PassThru ]
26
+ [-AsJob ] [-Context <IStorageContext> ] [-ServerTimeoutPerRequest <Int32> ] [-ClientTimeoutPerRequest <Int32>]
27
+ [-DefaultProfile <IAzureContextContainer >] [-ConcurrentTaskCount <Int32 >] [-WhatIf] [-Confirm ]
28
+ [<CommonParameters>]
29
29
```
30
30
31
31
### ShareCloseAll
32
32
```
33
- Close-AzStorageFileHandle [-Share ] <CloudFileShare > [-ShareClient <ShareClient >] [[-Path] <String> ]
34
- [-Recursive ] [-CloseAll] [-PassThru ] [-AsJob ] [-ServerTimeoutPerRequest <Int32>]
35
- [-ClientTimeoutPerRequest <Int32 >] [-DefaultProfile <IAzureContextContainer >] [-ConcurrentTaskCount <Int32> ]
36
- [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [ <CommonParameters>]
33
+ Close-AzStorageFileHandle [-ShareClient ] <ShareClient > [[-Path] <String >] [-Recursive] [-CloseAll] [-PassThru ]
34
+ [-AsJob ] [-Context <IStorageContext> ] [-ServerTimeoutPerRequest <Int32> ] [-ClientTimeoutPerRequest <Int32>]
35
+ [-DefaultProfile <IAzureContextContainer >] [-ConcurrentTaskCount <Int32 >] [-WhatIf] [-Confirm ]
36
+ [<CommonParameters>]
37
37
```
38
38
39
39
### ShareCloseSingle
40
40
```
41
- Close-AzStorageFileHandle [-Share ] <CloudFileShare> [- ShareClient <ShareClient>] -FileHandle <PSFileHandle>
42
- [-PassThru] [-AsJob ] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
43
- [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-ProgressAction <ActionPreference> ]
44
- [-WhatIf] [-Confirm] [ <CommonParameters>]
41
+ Close-AzStorageFileHandle [-ShareClient ] <ShareClient> -FileHandle <PSFileHandle> [-PassThru] [-AsJob]
42
+ [-Context <IStorageContext> ] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
43
+ [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm ]
44
+ [<CommonParameters>]
45
45
```
46
46
47
47
### DirectoryCloseAll
48
48
```
49
- Close-AzStorageFileHandle [-Directory ] <CloudFileDirectory > [-ShareDirectoryClient <ShareDirectoryClient> ]
50
- [[-Path] <String>] [-Recursive ] [-CloseAll ] [-PassThru] [-AsJob ] [-ServerTimeoutPerRequest <Int32>]
49
+ Close-AzStorageFileHandle [-ShareDirectoryClient ] <ShareDirectoryClient > [[-Path] <String>] [-Recursive ]
50
+ [-CloseAll] [-PassThru ] [-AsJob ] [-Context <IStorageContext> ] [-ServerTimeoutPerRequest <Int32>]
51
51
[-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>]
52
- [-ProgressAction <ActionPreference>] [- WhatIf] [-Confirm] [<CommonParameters>]
52
+ [-WhatIf] [-Confirm] [<CommonParameters>]
53
53
```
54
54
55
55
### FileCloseAll
56
56
```
57
- Close-AzStorageFileHandle [-File ] <CloudFile > [-ShareFileClient <ShareFileClient> ] [-CloseAll ] [-PassThru ]
58
- [-AsJob ] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
59
- [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-ProgressAction <ActionPreference> ]
60
- [-WhatIf] [-Confirm] [ <CommonParameters>]
57
+ Close-AzStorageFileHandle [-ShareFileClient ] <ShareFileClient > [-CloseAll ] [-PassThru ] [-AsJob ]
58
+ [-Context <IStorageContext> ] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
59
+ [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm ]
60
+ [<CommonParameters>]
61
61
```
62
62
63
63
## DESCRIPTION
@@ -165,7 +165,7 @@ Azure Storage Context Object
165
165
166
166
` ` ` yaml
167
167
Type : Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext
168
- Parameter Sets : ShareNameCloseAll, ShareNameCloseSingle
168
+ Parameter Sets : (All)
169
169
Aliases :
170
170
171
171
Required : False
@@ -190,21 +190,6 @@ Accept pipeline input: False
190
190
Accept wildcard characters : False
191
191
` ` `
192
192
193
- ### -Directory
194
- CloudFileDirectory object indicated the base folder where the files/directories would be listed.
195
-
196
- ` ` ` yaml
197
- Type : Microsoft.Azure.Storage.File.CloudFileDirectory
198
- Parameter Sets : DirectoryCloseAll
199
- Aliases : CloudFileDirectory
200
-
201
- Required : True
202
- Position : 0
203
- Default value : None
204
- Accept pipeline input : True (ByPropertyName, ByValue)
205
- Accept wildcard characters : False
206
- ` ` `
207
-
208
193
### -DisAllowTrailingDot
209
194
Disallow trailing dot (.) to suffix directory and file names.
210
195
@@ -220,21 +205,6 @@ Accept pipeline input: False
220
205
Accept wildcard characters : False
221
206
` ` `
222
207
223
- ### -File
224
- CloudFile object indicated the file to close handle.
225
-
226
- ` ` ` yaml
227
- Type : Microsoft.Azure.Storage.File.CloudFile
228
- Parameter Sets : FileCloseAll
229
- Aliases : CloudFile
230
-
231
- Required : True
232
- Position : 0
233
- Default value : None
234
- Accept pipeline input : True (ByPropertyName, ByValue)
235
- Accept wildcard characters : False
236
- ` ` `
237
-
238
208
### -FileHandle
239
209
The File Handle to close.
240
210
@@ -280,21 +250,6 @@ Accept pipeline input: False
280
250
Accept wildcard characters : False
281
251
` ` `
282
252
283
- ### -ProgressAction
284
- {{ Fill ProgressAction Description }}
285
-
286
- ` ` ` yaml
287
- Type : System.Management.Automation.ActionPreference
288
- Parameter Sets : (All)
289
- Aliases : proga
290
-
291
- Required : False
292
- Position : Named
293
- Default value : None
294
- Accept pipeline input : False
295
- Accept wildcard characters : False
296
- ` ` `
297
-
298
253
### -Recursive
299
254
List handles Recursively.
300
255
Only works on File Directory.
@@ -326,21 +281,6 @@ Accept pipeline input: False
326
281
Accept wildcard characters : False
327
282
` ` `
328
283
329
- ### -Share
330
- CloudFileShare object indicated the share where the files/directories would be listed.
331
-
332
- ` ` ` yaml
333
- Type : Microsoft.Azure.Storage.File.CloudFileShare
334
- Parameter Sets : ShareCloseAll, ShareCloseSingle
335
- Aliases : CloudFileShare
336
-
337
- Required : True
338
- Position : 0
339
- Default value : None
340
- Accept pipeline input : True (ByPropertyName, ByValue)
341
- Accept wildcard characters : False
342
- ` ` `
343
-
344
284
### -ShareClient
345
285
ShareClient object indicated the share which contains the files/directories to closed handle.
346
286
@@ -349,8 +289,8 @@ Type: Azure.Storage.Files.Shares.ShareClient
349
289
Parameter Sets : ShareCloseAll, ShareCloseSingle
350
290
Aliases :
351
291
352
- Required : False
353
- Position : Named
292
+ Required : True
293
+ Position : 0
354
294
Default value : None
355
295
Accept pipeline input : True (ByPropertyName, ByValue)
356
296
Accept wildcard characters : False
@@ -364,8 +304,8 @@ Type: Azure.Storage.Files.Shares.ShareDirectoryClient
364
304
Parameter Sets : DirectoryCloseAll
365
305
Aliases :
366
306
367
- Required : False
368
- Position : Named
307
+ Required : True
308
+ Position : 0
369
309
Default value : None
370
310
Accept pipeline input : True (ByPropertyName, ByValue)
371
311
Accept wildcard characters : False
@@ -379,8 +319,8 @@ Type: Azure.Storage.Files.Shares.ShareFileClient
379
319
Parameter Sets : FileCloseAll
380
320
Aliases :
381
321
382
- Required : False
383
- Position : Named
322
+ Required : True
323
+ Position : 0
384
324
Default value : None
385
325
Accept pipeline input : True (ByPropertyName, ByValue)
386
326
Accept wildcard characters : False
@@ -437,15 +377,19 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
437
377
438
378
## INPUTS
439
379
440
- ### Microsoft.Azure.Storage.File.CloudFileShare
380
+ ### Azure.Storage.Files.Shares.ShareClient
381
+
382
+ ### Azure.Storage.Files.Shares.ShareDirectoryClient
383
+
384
+ ### Azure.Storage.Files.Shares.ShareFileClient
441
385
442
- ### Microsoft.Azure. Storage.File.CloudFileDirectory
386
+ ### Microsoft.WindowsAzure.Commands. Storage.Model.ResourceModel.PSFileHandle
443
387
444
388
### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext
445
389
446
390
## OUTPUTS
447
391
448
- ### Microsoft.Azure.Storage.File.CloseFileHandleResultSegment
392
+ ### System.Int32
449
393
450
394
## NOTES
451
395
0 commit comments