Skip to content

Commit af5706d

Browse files
akaguptamsakaguptams
committed
Fix help files
1 parent 217a27f commit af5706d

File tree

2 files changed

+115
-70
lines changed

2 files changed

+115
-70
lines changed

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

Lines changed: 40 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml
33
Module Name: Az.DataLakeStore
44
ms.assetid: BF0A5D64-AC93-48F5-AED2-C21CC8829053
@@ -14,12 +14,13 @@ Searches for deleted entries in trash which match the filter.
1414
## SYNTAX
1515

1616
```
17-
Get-AzDataLakeStoreDeletedItem [-Account] <String> [-Filter] <String> [-Count] <UInt32> [-AsJob]
17+
Get-AzDataLakeStoreDeletedItem [-Account] <String> [-Filter] <String> [-Count <Int32>] [-AsJob]
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1819
```
1920

2021
## DESCRIPTION
21-
The **Get-AzDataLakeStoreDeletedItem** cmdlet searches the deleted file or folder in Data Lake Store which match the given filter.
22-
Displays the following attributes of the deleted items - OriginalPath, TrashDirPath, Type, CreationTime.
22+
The **Get-AzDataLakeStoreDeletedItem** cmdlet searches the deleted files or folders in Data Lake Store which match the given filter.
23+
It displays the following attributes of the deleted items - OriginalPath, TrashDirPath, Type, CreationTime.
2324
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.
2425

2526
## EXAMPLES
@@ -60,47 +61,68 @@ Accept pipeline input: True (ByPropertyName)
6061
Accept wildcard characters: False
6162
```
6263
63-
### -Filter
64-
Specifies the search query. A more specific value gives more relevant results.
64+
### -AsJob
65+
Run cmdlet in the background.
6566
6667
```yaml
67-
Type: System.String
68+
Type: System.Management.Automation.SwitchParameter
6869
Parameter Sets: (All)
69-
Aliases:
70+
Aliases:
7071

71-
Required: True
72-
Position: 1
72+
Required: False
73+
Position: Named
7374
Default value: None
74-
Accept pipeline input: True (ByPropertyName)
75+
Accept pipeline input: False
7576
Accept wildcard characters: False
7677
```
7778
7879
### -Count
7980
Specifies the number of results the user wants to find. The query runs until it finds Count results or it searches through entire trash, whichever happens first.
8081
8182
```yaml
82-
Type: System.String
83+
Type: System.Int32
8384
Parameter Sets: (All)
84-
Aliases:
85+
Aliases:
8586

8687
Required: False
87-
Position:
88+
Position: Named
8889
Default value: 1
8990
Accept pipeline input: True (ByPropertyName)
9091
Accept wildcard characters: False
9192
```
92-
### -AsJob
93-
Run cmdlet in the background.
9493
95-
Type: System.Management.Automation.SwitchParameter
94+
### -DefaultProfile
95+
The credentials, account, tenant, and subscription used for communication with Azure.
96+
97+
```yaml
98+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
9699
Parameter Sets: (All)
97-
Aliases:
100+
Aliases: AzContext, AzureRmContext, AzureCredential
98101

99102
Required: False
100103
Position: Named
101104
Default value: None
102105
Accept pipeline input: False
103106
Accept wildcard characters: False
107+
```
108+
109+
### -Filter
110+
Specifies the search query. A more specific value gives more relevant results.
111+
112+
```yaml
113+
Type: System.String
114+
Parameter Sets: (All)
115+
Aliases:
116+
117+
Required: True
118+
Position: 1
119+
Default value: None
120+
Accept pipeline input: True (ByPropertyName)
121+
Accept wildcard characters: False
122+
```
123+
124+
### CommonParameters
125+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
104126
105127
## INPUTS
106128

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

Lines changed: 75 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml
33
Module Name: Az.DataLakeStore
44
ms.assetid: D231E9A0-DC1E-411B-A87A-56A8C767F6C5
@@ -9,17 +9,21 @@ schema: 2.0.0
99
# Restore-AzDataLakeStoreDeletedItem
1010

1111
## SYNOPSIS
12-
Restore a deleted file or folder in Azure Data Lake
12+
Restore a deleted file or folder in Azure Data Lake.
1313

1414
## SYNTAX
15-
### ByName (Default)
15+
16+
### Default (Default)
1617
```
17-
Restore-AzDataLakeStoreDeletedItem [-Account] <String> [-Path] <String> [-Destination] <String> [-Type] <String> [-RestoreAction] <String> [-Force] [-PassThru]
18+
Restore-AzDataLakeStoreDeletedItem [-Account] <String> [-Path] <String> [-Destination] <String>
19+
[-Type] <String> [-RestoreAction <String>] [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>]
20+
[<CommonParameters>]
1821
```
1922

20-
### ByInputObject
23+
### InputObject
2124
```
22-
Restore-AzDataLakeStoreDeletedItem [-Account] <String> [-DeletedItem] <DataLakeStoreDeletedItem> [-RestoreAction] <String> [-Force] [-PassThru]
25+
Restore-AzDataLakeStoreDeletedItem [-Account] <String> [-DeletedItem] <DataLakeStoreDeletedItem>
26+
[-RestoreAction <String>] [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2327
```
2428

2529
## DESCRIPTION
@@ -43,13 +47,11 @@ To - adl://ml1ptrashtest.azuredatalake.com/test4/file_1115
4347
Type - file
4448
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
4549
PS >
46-
47-
4850
```
4951

5052
## PARAMETERS
51-
### ByName (Default)
52-
#### -Account
53+
54+
### -Account
5355
Specifies the name of the Data Lake Store account.
5456

5557
```yaml
@@ -64,28 +66,44 @@ Accept pipeline input: True (ByPropertyName)
6466
Accept wildcard characters: False
6567
```
6668
67-
#### -Path
68-
The path of the deleted deleted file or folder in trash.
69+
### -DefaultProfile
70+
The credentials, account, tenant, and subscription used for communication with Azure.
6971
7072
```yaml
71-
Type: System.String
72-
Parameter Sets: DefaultParameterSet
73-
Aliases:
73+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
74+
Parameter Sets: (All)
75+
Aliases: AzContext, AzureRmContext, AzureCredential
76+
77+
Required: False
78+
Position: Named
79+
Default value: None
80+
Accept pipeline input: False
81+
Accept wildcard characters: False
82+
```
83+
84+
### -DeletedItem
85+
The deleted item object
86+
87+
88+
```yaml
89+
Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreDeletedItem
90+
Parameter Sets: InputObject
91+
Aliases:
7492

7593
Required: True
7694
Position: 1
7795
Default value: None
78-
Accept pipeline input: True (ByPropertyName)
96+
Accept pipeline input: True (ByValue)
7997
Accept wildcard characters: False
8098
```
8199
82-
#### -Destination
100+
### -Destination
83101
The destination path to where the deleted file or folder should be restored.
84102
85103
```yaml
86104
Type: System.String
87-
Parameter Sets: DefaultParameterSet
88-
Aliases:
105+
Parameter Sets: Default
106+
Aliases:
89107

90108
Required: True
91109
Position: 2
@@ -94,79 +112,84 @@ Accept pipeline input: True (ByPropertyName)
94112
Accept wildcard characters: False
95113
```
96114
97-
#### -Type
98-
The type of entry being restored - "file" or "folder"
115+
### -Force
116+
Forces the command to run without asking for user confirmation
99117
100118
```yaml
101-
Type: System.String
102-
Parameter Sets: DefaultParameterSet
103-
Aliases:
119+
Type: System.Management.Automation.SwitchParameter
120+
Parameter Sets: (All)
121+
Aliases:
104122

105-
Required: True
106-
Position: 3
123+
Required: False
124+
Position: Named
107125
Default value: None
108-
Accept pipeline input: True (ByPropertyName)
126+
Accept pipeline input: False
109127
Accept wildcard characters: False
110128
```
111129
130+
### -PassThru
131+
Return boolean true on success
112132
113-
#### DeletedItem
114-
The deleted item object
115133
```yaml
116-
Type: DataLakeStoreDeletedItem
117-
Parameter Sets: InputObjectParameterSet
118-
Aliases: Default
134+
Type: System.Management.Automation.SwitchParameter
135+
Parameter Sets: (All)
136+
Aliases:
119137

120-
Required: True
121-
Position: 1
138+
Required: False
139+
Position: Named
122140
Default value: None
123-
Accept pipeline input: True (ByPropertyName)
141+
Accept pipeline input: False
124142
Accept wildcard characters: False
125143
```
126144
127-
#### -RestoreAction
128-
Action to take on destination name conflicts - "copy" or "overwrite"
145+
### -Path
146+
The path of the deleted deleted file or folder in trash.
129147
130148
```yaml
131149
Type: System.String
132-
Parameter Sets: (All)
133-
Aliases:
150+
Parameter Sets: Default
151+
Aliases:
134152

135-
Required: False
136-
Position: Named
153+
Required: True
154+
Position: 1
137155
Default value: None
138156
Accept pipeline input: True (ByPropertyName)
139157
Accept wildcard characters: False
140158
```
141-
#### -PassThru
142-
Return boolean true on success
159+
160+
### -RestoreAction
161+
Action to take on destination name conflicts - "copy" or "overwrite"
143162
144163
```yaml
145-
Type: System.Management.Automation.SwitchParameter
164+
Type: System.String
146165
Parameter Sets: (All)
147166
Aliases:
148167

149168
Required: False
150169
Position: Named
151170
Default value: None
152-
Accept pipeline input: False
171+
Accept pipeline input: True (ByPropertyName)
153172
Accept wildcard characters: False
154173
```
155-
### -Force
156-
Forces the command to run without asking for user confirmation
174+
175+
### -Type
176+
The type of entry being restored - "file" or "folder"
157177
158178
```yaml
159-
Type: System.Management.Automation.SwitchParameter
160-
Parameter Sets: (All)
179+
Type: System.String
180+
Parameter Sets: Default
161181
Aliases:
162182

163-
Required: False
164-
Position: Named
183+
Required: True
184+
Position: 3
165185
Default value: None
166-
Accept pipeline input: False
186+
Accept pipeline input: True (ByPropertyName)
167187
Accept wildcard characters: False
168188
```
169189
190+
### CommonParameters
191+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
192+
170193
## INPUTS
171194
172195
### System.String

0 commit comments

Comments
 (0)