Skip to content

Commit 94e4f49

Browse files
Apply suggestions from code review
Co-authored-by: JohanFreelancer9 <[email protected]>
1 parent fc1ee71 commit 94e4f49

13 files changed

+53
-53
lines changed

docset/winserver2022-ps/smbshare/Get-SmbShare.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ Accept wildcard characters: False
312312
```
313313
314314
### -LeasingMode
315-
Specifies SMB leasing and oplock behaviors
315+
Specifies SMB leasing and oplock behaviors.
316316
317317
```yaml
318318
Type: LeasingMode[]

docset/winserver2022-ps/smbshare/New-SmbGlobalMapping.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: New-SmbGlobalMapping
1111
# New-SmbGlobalMapping
1212

1313
## SYNOPSIS
14-
Specifies SMB leasing and oplock behaviors
14+
Specifies Server Message Block (SMB) leasing and oplock behaviors.
1515

1616
## SYNTAX
1717

@@ -23,7 +23,7 @@ New-SmbGlobalMapping [[-LocalPath] <String>] [-RemotePath] <String> -Credential
2323
```
2424

2525
## DESCRIPTION
26-
The New-SmbGlobalMapping cmdlet creates a Server Message Block (SMB) global mapping on the SMB client to an SMB share. Global mappings allow all users to use the same mapping. Its primary use is for Windows Containers.
26+
The New-SmbGlobalMapping cmdlet creates an SMB global mapping on the SMB client to an SMB share. Global mappings allow all users to use the same mapping. Its primary use is for Windows Containers.
2727

2828
## EXAMPLES
2929

@@ -55,7 +55,7 @@ Accept wildcard characters: False
5555
```
5656
5757
### -CimSession
58-
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a [New-CimSession](https://docs.microsoft.com/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the current session on the local computer.
58+
Runs the cmdlet in a remote session or on a remote computer. 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. The default is the current session on the local computer.
5959
6060
```yaml
6161
Type: CimSession[]
@@ -85,7 +85,7 @@ Accept wildcard characters: False
8585
```
8686
8787
### -DenyAccess
88-
Specifies which accounts are denied access to the SMB mapping. Multiple accounts can be specified by supplying a comma-separated list. For example: -NoAccess "NT AUTHORITY\SYSTEM", "contoso\ned"
88+
Specifies which accounts are denied access to the SMB mapping. Multiple accounts can be specified by supplying a comma-separated list. For example: -NoAccess "NT AUTHORITY\SYSTEM", "contoso\ned".
8989
9090
```yaml
9191
Type: String[]
@@ -100,7 +100,7 @@ Accept wildcard characters: False
100100
```
101101
102102
### -FullAccess
103-
Specifies which accounts are granted full permission to access the SMB mapping. Use a comma-separated list to specify multiple accounts. For example: -FullAccess "NT AUTHORITY\SYSTEM", "contoso\ned"
103+
Specifies which accounts are granted full permission to access the SMB mapping. Use a comma-separated list to specify multiple accounts. For example: -FullAccess "NT AUTHORITY\SYSTEM", "contoso\ned".
104104
105105
```yaml
106106
Type: String[]
@@ -190,7 +190,7 @@ Accept wildcard characters: False
190190
```
191191
192192
### -ThrottleLimit
193-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
193+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
194194
195195
```yaml
196196
Type: Int32
@@ -251,7 +251,7 @@ Accept wildcard characters: False
251251
```
252252
253253
### CommonParameters
254-
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).
254+
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).
255255
256256
## INPUTS
257257

docset/winserver2022-ps/smbshare/New-SmbMapping.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -257,9 +257,9 @@ Accept wildcard characters: False
257257
### -TransportType
258258
Specifies the network transport used by SMB. The acceptable values for this parameter are:
259259

260-
- **TCP** Use TCP network transport
261-
- **QUIC** Use QUIC network transport
262-
- **None** Use default transport behavior (first try TCP then try QUIC)
260+
- **TCP** Use TCP network transport.
261+
- **QUIC** Use QUIC network transport.
262+
- **None** Use default transport behavior (first try TCP then try QUIC).
263263

264264
```yaml
265265
Type: TransportType

docset/winserver2022-ps/smbshare/New-SmbServerCertificateMapping.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Accept wildcard characters: False
5757
```
5858
5959
### -CimSession
60-
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a [New-CimSession](https://docs.microsoft.com/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the current session on the local computer.
60+
Runs the cmdlet in a remote session or on a remote computer. 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. The default is the current session on the local computer.
6161
6262
```yaml
6363
Type: CimSession[]
@@ -89,9 +89,9 @@ Accept wildcard characters: False
8989
### -Flags
9090
Specifies if Named Pipes are enabled for SMB over QUIC. The acceptable values for this parameter are:
9191
92-
- `None` Remove all flags
93-
- `AllowNamedPipe` Enable use of named pipes in SMB over QUIC connections for this mapping (off by default, overrides value of RestrictNamedPipeAccessOverQuic)
94-
- `DefaultCert` Not used
92+
- `None` Remove all flags.
93+
- `AllowNamedPipe` Enable use of named pipes in SMB over QUIC connections for this mapping (off by default, overrides the value of RestrictNamedPipeAccessOverQuic).
94+
- `DefaultCert` Not used.
9595

9696
```yaml
9797
Type: Flags
@@ -137,7 +137,7 @@ Accept wildcard characters: False
137137
```
138138

139139
### -StoreName
140-
Specifies the path to the certificate store for the certificate. The recommended value is “My” for the localmachine personal store.
140+
Specifies the path to the certificate store for the certificate. The recommended value is “My” for the local machine personal store.
141141

142142
```yaml
143143
Type: String
@@ -167,7 +167,7 @@ Accept wildcard characters: False
167167
```
168168

169169
### -ThrottleLimit
170-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
170+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
171171

172172
```yaml
173173
Type: Int32

docset/winserver2022-ps/smbshare/New-SmbShare.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -297,9 +297,9 @@ Accept wildcard characters: False
297297
298298
Specifies SMB leasing and oplock behaviors for application compatibility. The acceptable values for this parameter are:
299299
300-
- **Full** Use default lease and oplock behaviors from SMB3
301-
- **Shared** Grant read-caching lease but not write or handle-caching
302-
- **None** = No oplocks or leases, behave like SMB1 (not recommended)
300+
- **Full** Use default lease and oplock behaviors from SMB3.
301+
- **Shared** Grant read-caching lease but not write or handle-caching.
302+
- **None** = No oplocks or leases, behave like SMB1 (not recommended).
303303
304304
```yaml
305305
Type: LeasingMode

docset/winserver2022-ps/smbshare/Remove-SmbComponent.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Remove-SmbComponent [-Name] <String[]> [-CimSession <CimSession[]>] [-ThrottleLi
2121
```
2222

2323
## DESCRIPTION
24-
The Remove-SmbComponent cmdlet removes SMB1 components. SMB1 is a deprecated and unsafe protocol that’s no longer installed by default in most versions of Windows and Windows Server. For more information, review SMBv1 is not installed by default in Windows 10 version 1709, Windows Server version 1709 and later versions.
24+
The Remove-SmbComponent cmdlet removes SMB1 components. SMB1 is a deprecated and unsafe protocol that’s no longer installed by default in most versions of Windows and Windows Server. For more information, review [SMBv1 is not installed by default in Windows 10 version 1709, Windows Server version 1709, and later versions](windows-server/storage/file-server/troubleshoot/smbv1-not-installed-by-default-in-windows).
2525

2626
## EXAMPLES
2727

@@ -52,7 +52,7 @@ Accept wildcard characters: False
5252
```
5353
5454
### -CimSession
55-
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a [New-CimSession](https://docs.microsoft.com/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the current session on the local computer.
55+
Runs the cmdlet in a remote session or on a remote computer. 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. The default is the current session on the local computer.
5656
5757
```yaml
5858
Type: CimSession[]
@@ -69,10 +69,10 @@ Accept wildcard characters: False
6969
### -Name
7070
Specifies the SMB1 component to remove. The acceptable values for this parameter are:
7171
72-
- `SMB1Protocol` Remove all SMB1 components
73-
- `SMB1Protocol-Client` Remove the SMB1 client components
74-
- `SMB1Protocol-Server` Remove the SMB1 server components
75-
- `SMB1Protocol-Deprecation` Remove the SMB1 automatic removal service component (only applies to Windows, not Windows Server)
72+
- `SMB1Protocol` Remove all SMB1 components.
73+
- `SMB1Protocol-Client` Remove the SMB1 client components.
74+
- `SMB1Protocol-Server` Remove the SMB1 server components.
75+
- `SMB1Protocol-Deprecation` Remove the SMB1 automatic removal service component (only applies to Windows, not Windows Server).
7676

7777
```yaml
7878
Type: String[]
@@ -87,7 +87,7 @@ Accept wildcard characters: False
8787
```
8888

8989
### -ThrottleLimit
90-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
90+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
9191

9292
```yaml
9393
Type: Int32
@@ -133,7 +133,7 @@ Accept wildcard characters: False
133133
```
134134

135135
### CommonParameters
136-
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).
136+
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).
137137

138138
## INPUTS
139139

docset/winserver2022-ps/smbshare/Remove-SmbGlobalMapping.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: Remove-SmbGlobalMapping
1111
# Remove-SmbGlobalMapping
1212

1313
## SYNOPSIS
14-
Removes an SMB global mapping to an SMB share.
14+
Removes a Server Message Block (SMB) global mapping to an SMB share.
1515

1616
## SYNTAX
1717

@@ -29,7 +29,7 @@ Remove-SmbGlobalMapping -InputObject <CimInstance[]> [-Force] [-CimSession <CimS
2929
```
3030

3131
## DESCRIPTION
32-
The Remove-SmbGlobalMapping cmdlet removes the Server Message Block (SMB)global mapping to an SMB share.
32+
The Remove-SmbGlobalMapping cmdlet removes the SMB global mapping to an SMB share.
3333

3434
## EXAMPLES
3535

@@ -65,7 +65,7 @@ Accept wildcard characters: False
6565
```
6666
6767
### -CimSession
68-
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a [`New-CimSession`](https://docs.microsoft.com/powershell/module/cimcmdlets/new-cimsession) or [`Get-CimSession`](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the current session on the local computer.
68+
Runs the cmdlet in a remote session or on a remote computer. 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. The default is the current session on the local computer.
6969

7070
```yaml
7171
Type: CimSession[]
@@ -110,7 +110,7 @@ Accept wildcard characters: False
110110
```
111111

112112
### -LocalPath
113-
Specifies the local driver letter to which the remote path is mapped.
113+
Specifies the local drive letter to which the remote path is mapped.
114114

115115
```yaml
116116
Type: String[]
@@ -155,7 +155,7 @@ Accept wildcard characters: False
155155
```
156156

157157
### -ThrottleLimit
158-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
158+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
159159

160160
```yaml
161161
Type: Int32
@@ -201,7 +201,7 @@ Accept wildcard characters: False
201201
```
202202

203203
### CommonParameters
204-
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).
204+
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).
205205

206206
## INPUTS
207207

docset/winserver2022-ps/smbshare/Remove-SmbServerCertificateMapping.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Accept wildcard characters: False
8080
```
8181
8282
### -CimSession
83-
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
83+
Runs the cmdlet in a remote session or on a remote computer. 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. The default is the current session on the local computer.
8484

8585
```yaml
8686
Type: CimSession[]
@@ -112,9 +112,9 @@ Accept wildcard characters: False
112112
### -Flags
113113
Specifies if Named Pipes are enabled for SMB over QUIC. The acceptable values for this parameter are:
114114

115-
- `None` Remove all flags
116-
- `AllowNamedPipe` Enable use of named pipes in SMB over QUIC connections for this mapping (off by default, overrides value of RestrictNamedPipeAccessOverQuic)
117-
- `DefaultCert` Not used
115+
- `None` Remove all flags.
116+
- `AllowNamedPipe` Enable use of named pipes in SMB over QUIC connections for this mapping (off by default, overrides the value of RestrictNamedPipeAccessOverQuic).
117+
- `DefaultCert` Not used.
118118

119119
```yaml
120120
Type: Flags[]
@@ -205,7 +205,7 @@ Accept wildcard characters: False
205205
```
206206

207207
### -StoreName
208-
Specifies the path to the certificate store for the certificate. The recommended value is “My” for the localmachine personal store.
208+
Specifies the path to the certificate store for the certificate. The recommended value is “My” for the local machine personal store.
209209

210210
```yaml
211211
Type: String[]
@@ -235,7 +235,7 @@ Accept wildcard characters: False
235235
```
236236

237237
### -ThrottleLimit
238-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
238+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
239239

240240
```yaml
241241
Type: Int32

docset/winserver2022-ps/smbshare/Set-SmbBandwidthLimit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Accept wildcard characters: False
115115
116116
### -ThrottleLimit
117117
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
118-
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.
118+
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.
119119
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
120120

121121
```yaml

docset/winserver2022-ps/smbshare/Set-SmbClientConfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -494,7 +494,7 @@ Accept wildcard characters: False
494494
495495
### -ThrottleLimit
496496
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
497-
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.
497+
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.
498498
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
499499

500500
```yaml

0 commit comments

Comments
 (0)