Skip to content

Commit 3fb52a1

Browse files
RobBiddlemichaeltlombardi
authored andcommitted
Style guide fixes
1 parent 91fa9ff commit 3fb52a1

File tree

1 file changed

+54
-34
lines changed

1 file changed

+54
-34
lines changed

docset/winserver2022-ps/deduplication/Get-DedupStatus.md

Lines changed: 54 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -16,39 +16,46 @@ Returns deduplication status for volumes that have data deduplication metadata.
1616
## SYNTAX
1717

1818
```
19-
Get-DedupStatus [[-Volume] <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
20-
[<CommonParameters>]
19+
Get-DedupStatus [[-Volume] <String[]>] [-CimSession <CimSession[]>]
20+
[-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
24-
The **Get-DedupStatus** cmdlet returns a deduplication status object for every volume that has data deduplication metadata.
25-
A **DeduplicationStatus** object includes read-only properties that describe capacity, free or used space and optimization savings and status on the volume, times, and completion status for the last jobs on the volume.
24+
25+
The `Get-DedupStatus` cmdlet returns a deduplication status object for every volume that has data
26+
deduplication metadata. A **DeduplicationStatus** object includes read-only properties that describe
27+
capacity, free or used space and optimization savings and status on the volume, times, and
28+
completion status for the last jobs on the volume.
2629

2730
To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option.
2831

2932
## EXAMPLES
3033

3134
### Example 1: Get status for specified volumes
32-
```
33-
PS C:\> Get-DedupStatus -Volume "D:","F:"
35+
36+
```powershell
37+
Get-DedupStatus -Volume "D:","F:"
3438
```
3539

36-
This command gets deduplication status for the D: and F: volumes.
40+
This command gets deduplication status for the `D:` and `F:` volumes.
3741

3842
## PARAMETERS
3943

40-
### -AsJob
41-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
44+
### -AsJob\
4245

43-
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
44-
You can continue to work in the session while the job completes.
45-
To manage the job, use the `*-Job` cmdlets.
46-
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
46+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
47+
complete.
4748

48-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
49+
The cmdlet immediately returns an object that represents the job and then displays the command
50+
prompt. You can continue to work in the session while the job completes. To manage the job, use the
51+
`*-Job` cmdlets. To get the job results, use the
52+
[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
53+
54+
For more information about Windows PowerShell background jobs, see
55+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
4956

5057
```yaml
51-
Type: SwitchParameter
58+
Type: System.Management.Automation.SwitchParameter
5259
Parameter Sets: (All)
5360
Aliases:
5461

@@ -60,12 +67,14 @@ Accept wildcard characters: False
6067
```
6168
6269
### -CimSession
63-
Runs the cmdlet in a remote session or on a remote computer.
64-
Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
65-
The default is the current session on the local computer.
70+
71+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
72+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
73+
[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
74+
current session on the local computer.
6675
6776
```yaml
68-
Type: CimSession[]
77+
Type: Microsoft.Management.Infrastructure.CimSession[]
6978
Parameter Sets: (All)
7079
Aliases: Session
7180

@@ -77,12 +86,15 @@ Accept wildcard characters: False
7786
```
7887
7988
### -ThrottleLimit
80-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
81-
If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
82-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
89+
90+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
91+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
92+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
93+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
94+
computer.
8395

8496
```yaml
85-
Type: Int32
97+
Type: System.Int32
8698
Parameter Sets: (All)
8799
Aliases:
88100
@@ -94,14 +106,14 @@ Accept wildcard characters: False
94106
```
95107

96108
### -Volume
97-
Specifies one or more file system volumes for which to return a DeduplicationStatus object.
98-
Enter one or more volume IDs, drive letters, or volume GUID paths.
99-
For drive letters, use the format D:.
100-
For volume GUID paths, use the format \\\\?\Volume{{GUID}}\.
101-
Separate multiple volumes with a comma.
109+
110+
Specifies one or more file system volumes for which to return a DeduplicationStatus object. Enter
111+
one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`.
112+
For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple volumes with a
113+
comma.
102114

103115
```yaml
104-
Type: String[]
116+
Type: System.String[]
105117
Parameter Sets: (All)
106118
Aliases: Path, Name, DeviceId
107119
@@ -113,7 +125,11 @@ Accept wildcard characters: False
113125
```
114126

115127
### CommonParameters
116-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
128+
129+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
130+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
131+
-WarningAction, and -WarningVariable. For more information, see
132+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
117133

118134
## INPUTS
119135

@@ -122,12 +138,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
122138
## OUTPUTS
123139

124140
### Microsoft.Management.Infrastructure.CimInstance
125-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
126-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
141+
142+
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays
143+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
144+
namespace and class name for the underlying WMI object.
127145

128146
### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupVolumeStatus
129-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
130-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
147+
148+
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays
149+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
150+
namespace and class name for the underlying WMI object.
131151

132152
## NOTES
133153

0 commit comments

Comments
 (0)