Skip to content

Commit 0daf3fa

Browse files
committed
Applied feedback
1 parent 54b0545 commit 0daf3fa

File tree

5 files changed

+117
-107
lines changed

5 files changed

+117
-107
lines changed

docset/winserver2025-ps/smbshare/Block-SmbClientAccessToServer.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,14 @@ Blocks SMB client access to a specified server.
1515

1616
## SYNTAX
1717

18+
### Query
1819
```
1920
Block-SmbClientAccessToServer [-Name] <String[]> -IdentifierType <IdentifierType>
20-
-Identifier <String> [-Description <String>] [-Force] [-CimSession <CimSession[]>]
21+
-Identifier <String> [-Description <String>] [-Force] [-CimSession <CimSession[]>]
2122
[-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
2223
```
2324

25+
### InputObject
2426
```
2527
Block-SmbClientAccessToServer -InputObject <CimInstance[]> -IdentifierType <IdentifierType>
2628
-Identifier <String> [-Description <String>] [-Force] [-CimSession <CimSession[]>]
@@ -49,7 +51,7 @@ Block-SmbClientAccessToServer @params
4951
```
5052

5153
This command blocks SMB client access to a server named "Server01" for the based on the client's
52-
certificate. This command runs without prompting for confirmation as the `-Force` parameter is set
54+
certificate. This command runs without prompting for confirmation as the **Force** parameter is set
5355
to `$true`.
5456

5557
## PARAMETERS
@@ -75,7 +77,7 @@ Accept wildcard characters: False
7577
7678
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
7779
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
78-
[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
80+
[Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
7981
current session on the local computer.
8082
8183
```yaml
@@ -90,22 +92,6 @@ Accept pipeline input: False
9092
Accept wildcard characters: False
9193
```
9294
93-
### -Confirm
94-
95-
Prompts you for confirmation before running the cmdlet.
96-
97-
```yaml
98-
Type: SwitchParameter
99-
Parameter Sets: (All)
100-
Aliases: cf
101-
102-
Required: False
103-
Position: Named
104-
Default value: False
105-
Accept pipeline input: False
106-
Accept wildcard characters: False
107-
```
108-
10995
### -Description
11096
11197
Used to provide a description of the rule being added to the server's firewall when you use the
@@ -145,7 +131,7 @@ Accept wildcard characters: False
145131

146132
Specifies the identity of the client that is being granted access to the SMB server. This parameter
147133
takes a string value that represents the identity of the client. The format of the string value
148-
will depend on the `-IdentifierType` parameter that you're using.
134+
will depend on the **IdentifierType** parameter that you're using.
149135

150136
```yaml
151137
Type: String
@@ -162,7 +148,7 @@ Accept wildcard characters: False
162148
### -IdentifierType
163149

164150
Specifies the type of identifier that you're using to identify a client. The valid values for the
165-
`-IdentifierType` parameter are:
151+
**IdentifierType** parameter are:
166152

167153
- SHA256
168154
- ISSUER
@@ -207,7 +193,7 @@ or an entry in the certificate's subject alternative names.
207193

208194
```yaml
209195
Type: String[]
210-
Parameter Sets: (All)
196+
Parameter Sets: Query
211197
Aliases:
212198
213199
Required: True
@@ -238,6 +224,22 @@ Accept pipeline input: False
238224
Accept wildcard characters: False
239225
```
240226

227+
### -Confirm
228+
229+
Prompts you for confirmation before running the cmdlet.
230+
231+
```yaml
232+
Type: SwitchParameter
233+
Parameter Sets: (All)
234+
Aliases: cf
235+
236+
Required: False
237+
Position: Named
238+
Default value: False
239+
Accept pipeline input: False
240+
Accept wildcard characters: False
241+
```
242+
241243
### -WhatIf
242244

243245
Shows what would happen if the cmdlet runs. The cmdlet isn't run.

docset/winserver2025-ps/smbshare/Get-SmbClientAccessToServer.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,13 @@ Gets information about SMB client access to a specified server.
1515

1616
## SYNTAX
1717

18+
### Query
1819
```
1920
Get-SmbClientAccessToServer [-Name] <String[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
2021
[-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
2122
```
2223

24+
### InputObject
2325
```
2426
Get-SmbClientAccessToServer -InputObject <CimInstance[]> [-CimSession <CimSession[]>]
2527
[-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
@@ -39,7 +41,7 @@ the specified server.
3941
Get-SmbClientAccessToServer -Name "Server01"
4042
```
4143

42-
This command retrieves the SMB client access information for a device named "Server01".
44+
This command retrieves the SMB client access information for a device named `Server01`.
4345

4446
## PARAMETERS
4547

@@ -64,7 +66,7 @@ Accept wildcard characters: False
6466
6567
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
6668
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
67-
[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
69+
[Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
6870
current session on the local computer.
6971
7072
```yaml
@@ -79,22 +81,6 @@ Accept pipeline input: False
7981
Accept wildcard characters: False
8082
```
8183
82-
### -Confirm
83-
84-
Prompts you for confirmation before running the cmdlet.
85-
86-
```yaml
87-
Type: SwitchParameter
88-
Parameter Sets: (All)
89-
Aliases: cf
90-
91-
Required: False
92-
Position: Named
93-
Default value: False
94-
Accept pipeline input: False
95-
Accept wildcard characters: False
96-
```
97-
9884
### -InputObject
9985
10086
Specifies the input object that's used in a pipeline command.
@@ -118,7 +104,7 @@ or an entry in the certificate's subject alternative names.
118104
119105
```yaml
120106
Type: String[]
121-
Parameter Sets: (All)
107+
Parameter Sets: Query
122108
Aliases:
123109

124110
Required: True
@@ -149,6 +135,22 @@ Accept pipeline input: False
149135
Accept wildcard characters: False
150136
```
151137

138+
### -Confirm
139+
140+
Prompts you for confirmation before running the cmdlet.
141+
142+
```yaml
143+
Type: SwitchParameter
144+
Parameter Sets: (All)
145+
Aliases: cf
146+
147+
Required: False
148+
Position: Named
149+
Default value: False
150+
Accept pipeline input: False
151+
Accept wildcard characters: False
152+
```
153+
152154
### -WhatIf
153155

154156
Shows what would happen if the cmdlet runs. The cmdlet isn't run.

docset/winserver2025-ps/smbshare/Grant-SmbClientAccessToServer.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,14 @@ Grants SMB client access to a specified server.
1515

1616
## SYNTAX
1717

18+
### Query
1819
```
1920
Grant-SmbClientAccessToServer [-Name] <String[]> -IdentifierType <IdentifierType>
2021
-Identifier <String> [-Description <String>] [-Force] [-CimSession <CimSession[]>]
2122
[-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
2223
```
2324

25+
### InputObject
2426
```
2527
Grant-SmbClientAccessToServer -InputObject <CimInstance[]> -IdentifierType <IdentifierType>
2628
-Identifier <String> [-Description <String>] [-Force] [-CimSession <CimSession[]>]
@@ -49,7 +51,7 @@ $params = @{
4951
Grant-SmbClientAccessToServer @params
5052
```
5153

52-
This example grants SMB client access to a server named "Server01" based on the client's
54+
This example grants SMB client access to a server named `Server01` based on the client's
5355
certificate. The **Description** parameter is used to provide a description of the rule being added
5456
to the server's firewall. This command runs without prompting for confirmation.
5557

@@ -76,7 +78,7 @@ Accept wildcard characters: False
7678
7779
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
7880
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
79-
[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
81+
[Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
8082
current session on the local computer.
8183
8284
```yaml
@@ -91,22 +93,6 @@ Accept pipeline input: False
9193
Accept wildcard characters: False
9294
```
9395
94-
### -Confirm
95-
96-
Prompts you for confirmation before running the cmdlet.
97-
98-
```yaml
99-
Type: SwitchParameter
100-
Parameter Sets: (All)
101-
Aliases: cf
102-
103-
Required: False
104-
Position: Named
105-
Default value: False
106-
Accept pipeline input: False
107-
Accept wildcard characters: False
108-
```
109-
11096
### -Description
11197
11298
Used to provide a description of the rule being added to the server's firewall when you use the
@@ -146,7 +132,7 @@ Accept wildcard characters: False
146132

147133
Specifies the identity of the client that is being granted access to the SMB server. This parameter
148134
takes a string value that represents the identity of the client. The format of the string value
149-
will depend on the `-IdentifierType` parameter that you're using.
135+
will depend on the **IdentifierType** parameter that you're using.
150136

151137
```yaml
152138
Type: String
@@ -163,7 +149,7 @@ Accept wildcard characters: False
163149
### -IdentifierType
164150

165151
Specifies the type of identifier that you're using to identify a client. The valid values for the
166-
`-IdentifierType` parameter are:
152+
**IdentifierType** parameter are:
167153

168154
- SHA256
169155
- ISSUER
@@ -208,7 +194,7 @@ or an entry in the certificate's subject alternative names.
208194

209195
```yaml
210196
Type: String
211-
Parameter Sets: (All)
197+
Parameter Sets: Query
212198
Aliases:
213199
214200
Required: True
@@ -239,6 +225,22 @@ Accept pipeline input: False
239225
Accept wildcard characters: False
240226
```
241227

228+
### -Confirm
229+
230+
Prompts you for confirmation before running the cmdlet.
231+
232+
```yaml
233+
Type: SwitchParameter
234+
Parameter Sets: (All)
235+
Aliases: cf
236+
237+
Required: False
238+
Position: Named
239+
Default value: False
240+
Accept pipeline input: False
241+
Accept wildcard characters: False
242+
```
243+
242244
### -WhatIf
243245

244246
Shows what would happen if the cmdlet runs. The cmdlet isn't run.

0 commit comments

Comments
 (0)