Skip to content

Commit 7bbbc0c

Browse files
authored
Fix INPUTS and OUTPUTS formatting (#4002)
1 parent 020dd4c commit 7bbbc0c

File tree

168 files changed

+1867
-1310
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

168 files changed

+1867
-1310
lines changed

docset/winserver2016-ps/ADFS/Get-AdfsRelyingPartyWebContent.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,19 @@ Accept wildcard characters: False
8282
```
8383
8484
### CommonParameters
85-
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).
85+
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).
8686
8787
## INPUTS
8888
8989
## OUTPUTS
9090
91-
### Microsoft.IdentityServer.Management.Resources.AdfsRelyingPartyWebContent, Microsoft.IdentityServer.Management.Resources.AdfsRelyingPartyWebContent[]
92-
This cmdlet generates a **System.IdentityServer.Management.Resources.AdfsRelyingPartyWebContent** object that represents web content of a relying party, or an array of such objects.
93-
The object includes the following properties:
91+
### Microsoft.IdentityServer.Management.Resources.AdfsRelyingPartyWebContent
92+
93+
### Microsoft.IdentityServer.Management.Resources.AdfsRelyingPartyWebContent[]
94+
95+
This cmdlet generates a **System.IdentityServer.Management.Resources.AdfsRelyingPartyWebContent**
96+
object that represents web content of a relying party, or an array of such objects. The object
97+
includes the following properties:
9498
9599
- Locale: **System.Globalization.CultureInfo**
96100
- Name: **System.String**
@@ -105,4 +109,3 @@ The object includes the following properties:
105109
[Remove-AdfsRelyingPartyWebContent](./Remove-AdfsRelyingPartyWebContent.md)
106110
107111
[Set-AdfsRelyingPartyWebContent](./Set-AdfsRelyingPartyWebContent.md)
108-

docset/winserver2016-ps/ADFS/Set-AdfsDeviceRegistration.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -306,11 +306,15 @@ Accept wildcard characters: False
306306
```
307307
308308
### CommonParameters
309-
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).
309+
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).
310310
311311
## INPUTS
312312
313-
### uint, string, switch
313+
### uint
314+
315+
### string
316+
317+
### SwitchParameter
314318
315319
## OUTPUTS
316320

docset/winserver2016-ps/ADRMS/Install-ADRMS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
150150
151151
## INPUTS
152152
153-
### string, PSCredential
153+
### PSCredential
154+
155+
### string
154156
155157
## OUTPUTS
156158

docset/winserver2016-ps/ADRMS/Uninstall-ADRMS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
125125
126126
## INPUTS
127127
128-
### SwitchParameter, PSCredential
128+
### SwitchParameter
129+
130+
### PSCredential
129131
130132
## OUTPUTS
131133

docset/winserver2016-ps/ADRMS/Update-ADRMS.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
180180
181181
## INPUTS
182182
183-
### SwitchParameter, string, PSCredential, SecureString
183+
### SwitchParameter
184+
185+
### string
186+
187+
### PSCredential
188+
189+
### SecureString
184190
185191
## OUTPUTS
186192

docset/winserver2016-ps/ActiveDirectory/Add-ADFineGrainedPasswordPolicySubject.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -290,28 +290,36 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
290290
291291
## INPUTS
292292
293-
### Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy, Microsoft.ActiveDirectory.Management.ADPrincipal
294-
A fine-grained password policy object is received by the *Identity* parameter.
295-
One or more principal objects that represent users and security group objects are received by the *Subjects* parameter.
296-
Derived principal types, such as the following, are also accepted by the *Subjects* parameter:
293+
### Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy
294+
295+
A fine-grained password policy object is received by the **Identity** parameter.
296+
297+
### Microsoft.ActiveDirectory.Management.ADPrincipal
298+
299+
One or more principal objects that represent users and security group objects are received by the
300+
**Subjects** parameter. Derived principal types, such as the following, are also accepted by the
301+
**Subjects** parameter:
297302
298303
- **Microsoft.ActiveDirectory.Management.ADGroup**
299304
- **Microsoft.ActiveDirectory.Management.ADUser**
300305
301306
## OUTPUTS
302307
303-
### None or Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy
304-
Returns the modified fine-grained password policy object when the *PassThru* parameter is specified.
305-
By default, this cmdlet does not generate any output.
308+
### None
309+
310+
### Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy
311+
312+
Returns the modified fine-grained password policy object when the **PassThru** parameter is
313+
specified. By default, this cmdlet does not generate any output.
306314
307315
## NOTES
308-
* This cmdlet does not work with AD LDS.
309-
* This cmdlet does not work with a read-only domain controller.
310-
* This cmdlet does not work with an Active Directory snapshot.
316+
317+
- This cmdlet does not work with AD LDS.
318+
- This cmdlet does not work with a read-only domain controller.
319+
- This cmdlet does not work with an Active Directory snapshot.
311320
312321
## RELATED LINKS
313322
314323
[Get-ADFineGrainedPasswordPolicySubject](./Get-ADFineGrainedPasswordPolicySubject.md)
315324
316325
[Remove-ADFineGrainedPasswordPolicySubject](./Remove-ADFineGrainedPasswordPolicySubject.md)
317-

docset/winserver2016-ps/ActiveDirectory/Grant-ADAuthenticationPolicySiloAccess.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ The output is then passed to the **Grant-ADAuthenticationPolicySiloAccess** cmdl
4545

4646
### -Account
4747
Specifies the account to which to grant access to the authentication policy silo.
48-
Specify the account in one of the following formats:
48+
Specify the account in one of the following formats:
4949

5050
- A distinguished name
51-
- A GUID
52-
- A security identifier
51+
- A GUID
52+
- A security identifier
5353
- A SAM account name
5454

5555
The cmdlet searches the default naming context or partition to find the object.
@@ -60,7 +60,7 @@ You can also use this parameter to specify a variable that contains user, comput
6060
```yaml
6161
Type: ADAccount
6262
Parameter Sets: (All)
63-
Aliases:
63+
Aliases:
6464

6565
Required: True
6666
Position: 1
@@ -82,7 +82,7 @@ A Secure Sockets Layer (SSL) connection is required for the Basic authentication
8282
```yaml
8383
Type: ADAuthType
8484
Parameter Sets: (All)
85-
Aliases:
85+
Aliases:
8686
Accepted values: Negotiate, Basic
8787

8888
Required: False
@@ -120,7 +120,7 @@ If you specify credentials that do not have permission to perform the task, the
120120
```yaml
121121
Type: PSCredential
122122
Parameter Sets: (All)
123-
Aliases:
123+
Aliases:
124124

125125
Required: False
126126
Position: Named
@@ -131,7 +131,7 @@ Accept wildcard characters: False
131131
132132
### -Identity
133133
Specifies an **ADAuthenticationPolicySilo** object.
134-
Specify the authentication policy silo object in one of the following formats:
134+
Specify the authentication policy silo object in one of the following formats:
135135
136136
- A distinguished name
137137
- A GUID
@@ -145,7 +145,7 @@ If the cmdlet finds two or more objects, the cmdlet returns a non-terminating er
145145
```yaml
146146
Type: ADAuthenticationPolicySilo
147147
Parameter Sets: (All)
148-
Aliases:
148+
Aliases:
149149

150150
Required: True
151151
Position: 0
@@ -161,7 +161,7 @@ By default, this cmdlet does not generate any output.
161161
```yaml
162162
Type: SwitchParameter
163163
Parameter Sets: (All)
164-
Aliases:
164+
Aliases:
165165

166166
Required: False
167167
Position: Named
@@ -174,13 +174,13 @@ Accept wildcard characters: False
174174
Specifies the Active Directory Domain Services instance to which to connect, by providing one of the following values for a corresponding domain name or directory server.
175175
The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance.
176176
177-
Specify the Active Directory Domain Services instance in one of the following ways:
177+
Specify the Active Directory Domain Services instance in one of the following ways:
178178
179-
Domain name values:
179+
Domain name values:
180180
- A Fully qualified domain name
181181
- A NetBIOS name
182182
183-
Directory server values:
183+
Directory server values:
184184
- A Fully qualified directory server name
185185
- A NetBIOS name
186186
- A Fully qualified directory server name and port
@@ -194,7 +194,7 @@ The default value for this parameter is determined by one of the following metho
194194
```yaml
195195
Type: String
196196
Parameter Sets: (All)
197-
Aliases:
197+
Aliases:
198198

199199
Required: False
200200
Position: Named
@@ -224,7 +224,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
224224
225225
## INPUTS
226226
227-
### Microsoft.ActiveDirectory.Management.ADAccount, Microsoft.ActiveDirectory.Management.ADAuthenticationPolicySilo
227+
### Microsoft.ActiveDirectory.Management.ADAccount
228+
229+
### Microsoft.ActiveDirectory.Management.ADAuthenticationPolicySilo
228230
229231
## OUTPUTS
230232
@@ -237,4 +239,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
237239
[Revoke-ADAuthenticationPolicySiloAccess](./Revoke-ADAuthenticationPolicySiloAccess.md)
238240
239241
[AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md)
240-

docset/winserver2016-ps/ActiveDirectory/New-ADAuthenticationPolicySilo.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ A Secure Sockets Layer (SSL) connection is required for the Basic authentication
5858
```yaml
5959
Type: ADAuthType
6060
Parameter Sets: (All)
61-
Aliases:
61+
Aliases:
6262
Accepted values: Negotiate, Basic
6363

6464
Required: False
@@ -74,7 +74,7 @@ Specifies the authentication policy that applies to computer accounts.
7474
```yaml
7575
Type: ADAuthenticationPolicy
7676
Parameter Sets: (All)
77-
Aliases:
77+
Aliases:
7878

7979
Required: False
8080
Position: Named
@@ -111,7 +111,7 @@ If you specify credentials that do not have permission to perform the task, the
111111
```yaml
112112
Type: PSCredential
113113
Parameter Sets: (All)
114-
Aliases:
114+
Aliases:
115115

116116
Required: False
117117
Position: Named
@@ -128,7 +128,7 @@ The Lightweight Directory Access Protocol (LDAP) display name (**ldapDisplayName
128128
```yaml
129129
Type: String
130130
Parameter Sets: (All)
131-
Aliases:
131+
Aliases:
132132

133133
Required: False
134134
Position: Named
@@ -143,7 +143,7 @@ Indicates that the authentication policy silo is enforced.
143143
```yaml
144144
Type: SwitchParameter
145145
Parameter Sets: (All)
146-
Aliases:
146+
Aliases:
147147

148148
Required: False
149149
Position: Named
@@ -159,7 +159,7 @@ To get the **ADAuthenticationPolicySilo** object to use as a template, use the G
159159
```yaml
160160
Type: ADAuthenticationPolicySilo
161161
Parameter Sets: (All)
162-
Aliases:
162+
Aliases:
163163

164164
Required: False
165165
Position: Named
@@ -176,7 +176,7 @@ The LDAP display name (**ldapDisplayName**) of this property is name.
176176
```yaml
177177
Type: String
178178
Parameter Sets: (All)
179-
Aliases:
179+
Aliases:
180180

181181
Required: True
182182
Position: 1
@@ -198,7 +198,7 @@ You can specify values for more than one attribute by using semicolons to separa
198198
```yaml
199199
Type: Hashtable
200200
Parameter Sets: (All)
201-
Aliases:
201+
Aliases:
202202

203203
Required: False
204204
Position: Named
@@ -214,7 +214,7 @@ By default, this cmdlet does not generate any output.
214214
```yaml
215215
Type: SwitchParameter
216216
Parameter Sets: (All)
217-
Aliases:
217+
Aliases:
218218

219219
Required: False
220220
Position: Named
@@ -234,7 +234,7 @@ The acceptable values for this parameter are:
234234
```yaml
235235
Type: Boolean
236236
Parameter Sets: (All)
237-
Aliases:
237+
Aliases:
238238

239239
Required: False
240240
Position: Named
@@ -247,14 +247,14 @@ Accept wildcard characters: False
247247
Specifies the Active Directory Domain Services instance to which to connect, by providing one of the following values for a corresponding domain name or directory server.
248248
The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance.
249249
250-
Specify the Active Directory Domain Services instance in one of the following ways:
250+
Specify the Active Directory Domain Services instance in one of the following ways:
251251
252252
Domain name values:
253253
254254
- Fully qualified domain name
255255
- NetBIOS name
256256
257-
Directory server values:
257+
Directory server values:
258258
259259
- Fully qualified directory server name
260260
- NetBIOS name
@@ -269,7 +269,7 @@ The default value for this parameter is determined by one of the following metho
269269
```yaml
270270
Type: String
271271
Parameter Sets: (All)
272-
Aliases:
272+
Aliases:
273273

274274
Required: False
275275
Position: Named
@@ -284,7 +284,7 @@ Specifies the authentication policy that applies to managed service accounts.
284284
```yaml
285285
Type: ADAuthenticationPolicy
286286
Parameter Sets: (All)
287-
Aliases:
287+
Aliases:
288288

289289
Required: False
290290
Position: Named
@@ -299,7 +299,7 @@ Specifies the authentication policy that applies to user accounts.
299299
```yaml
300300
Type: ADAuthenticationPolicy
301301
Parameter Sets: (All)
302-
Aliases:
302+
Aliases:
303303

304304
Required: False
305305
Position: Named
@@ -329,7 +329,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
329329
330330
## INPUTS
331331
332-
### Microsoft.ActiveDirectory.Management.ADAuthenticationPolicy, System.String, System.Management.Automation.SwitchParameter: System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
332+
### Microsoft.ActiveDirectory.Management.ADAuthenticationPolicy
333+
334+
### System.String
335+
336+
### System.Management.Automation.SwitchParameter
333337
334338
## OUTPUTS
335339
@@ -346,4 +350,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
346350
[Set-ADAuthenticationPolicySilo](./Set-ADAuthenticationPolicySilo.md)
347351
348352
[AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md)
349-

0 commit comments

Comments
 (0)