Skip to content

Commit 73d6b1d

Browse files
sdwheelersdwheeler
committed
Formatting and PS Style cleanup
- Cmdlet names in backticks - File paths in backticks - Parameter values in backticks - Parameter names in bold - No blank line after SYNOPSIS header - List items must be bulleted or numbered
1 parent d920e0e commit 73d6b1d

12 files changed

+65
-72
lines changed

‎docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ title: Find-LapsADExtendedRights
1212
# Find-LapsADExtendedRights
1313

1414
## SYNOPSIS
15-
1615
Queries Active Directory to find principals that have been granted permission to read Windows Local
1716
Administrator Password Solution (LAPS) password attributes.
1817

@@ -25,7 +24,7 @@ Find-LapsADExtendedRights [-Credential <PSCredential>] -Identity <String[]> [-Do
2524

2625
## DESCRIPTION
2726

28-
The **Find-LapsADExtendedRights** cmdlet is used by administrators to query which principals have
27+
The `Find-LapsADExtendedRights` cmdlet is used by administrators to query which principals have
2928
been granted permissions to read the LAPS password attributes.
3029

3130
## EXAMPLES
@@ -100,8 +99,8 @@ Specifies which Active Directory Organizational Unit to query.
10099
This parameter accepts several different name formats which influence the criteria used in the
101100
resultant Active Directory search. The supported name formats are as follows:
102101
103-
distinguishedName (begins with a "CN=")
104-
name (for all other inputs)
102+
- distinguishedName (begins with a "CN=")
103+
- name (for all other inputs)
105104
106105
```yaml
107106
Type: System.String[]

‎docset/winserver2022-ps/laps/Get-LapsAADPassword.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,23 @@ title: Get-LapsAADPassword
1212
# Get-LapsAADPassword
1313

1414
## SYNOPSIS
15-
1615
Queries Azure Active Directory for the Windows Local Administrator Password Solution (LAPS)
1716
credentials on a specified Azure AD device.
1817

1918
## SYNTAX
2019

21-
```s
20+
```
2221
Get-LapsAADPassword -DeviceIds <String[]> [-IncludePasswords] [-IncludeHistory] [-AsPlainText]
2322
[<CommonParameters>]
2423
```
2524

2625
## DESCRIPTION
2726

28-
The **Get-LapsAADPassword** cmdlet allows administrators to retrieve LAPS passwords and password
27+
The `Get-LapsAADPassword` cmdlet allows administrators to retrieve LAPS passwords and password
2928
history for an Azure Active Directory-joined device. This is implemented by sending queries to
3029
Microsoft Graph over the deviceLocalCredentials collection.
3130

32-
The **Get-LapsAADPassword** cmdlet supports two basic modes when querying LAPS passwords:
31+
The `Get-LapsAADPassword` cmdlet supports two basic modes when querying LAPS passwords:
3332

3433
The first mode queries for non-sensitive metadata, for example time the password was backed up to
3534
Azure and the expected expiration time of a password. This mode requires that the client be granted
@@ -39,7 +38,7 @@ The second mode queries for all password information including both the metadata
3938
described above and the clear-text form of the password(s). This mode requires that the client be
4039
granted the Microsoft Graph `DeviceLocalCredential.Read.All` permission.
4140

42-
The '-DeviceIds' parameter accepts either device names or device IDs, but the underlying Microsoft
41+
The **DeviceIds** parameter accepts either device names or device IDs, but the underlying Microsoft
4342
Graph queries only supports querying by device ID. To support this the cmdlet will map a device name
4443
input to its corresponding device ID by issuing a separate Microsoft Graph query. This extra query
4544
requires the `Device.Read.All` permission. If the target is a Microsoft Managed Desktop device, the
@@ -50,14 +49,14 @@ requires the `Device.Read.All` permission. If the target is a Microsoft Managed
5049
> workaround is to input the device ID directly.
5150
5251
> [!IMPORTANT]
53-
> The **Get-LapsAADPassword** cmdlet is implemented as a wrapper around the Microsoft Graph
54-
> PowerShell library which must be manually installed on the device before **Get-LapsAADPassword**
52+
> The `Get-LapsAADPassword` cmdlet is implemented as a wrapper around the Microsoft Graph
53+
> PowerShell library which must be manually installed on the device before `Get-LapsAADPassword`
5554
> can work. Additional configuration steps are required in your Azure Active Directory tenant to
5655
> enable authentication to Microsoft Graph and to grant the necessary Microsoft Graph permissions as
5756
> described above. See the following topic for more information:
5857
> [Get started with Windows LAPS and Azure Active Directory](https://go.microsoft.com/fwlink/?linkid=2233704)
5958
60-
The -Verbose parameter may be used to get additional information about the cmdlet's operation.
59+
The **Verbose** may be used to get additional information about the cmdlet's operation.
6160

6261
## EXAMPLES
6362

@@ -171,7 +170,7 @@ Accept wildcard characters: False
171170
172171
### -DeviceIds
173172
174-
Specifies the device name or device ID to query LAPS credentials.
173+
Specifies the device name or device ID to query LAPS credentials.
175174
176175
```yaml
177176
Type: System.String[]

‎docset/winserver2022-ps/laps/Get-LapsADPassword.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ title: Get-LapsADPassword
1212
# Get-LapsADPassword
1313

1414
## SYNOPSIS
15-
1615
Queries Windows Local Administrator Password Solution (LAPS) credentials from Active Directory on a
1716
specified AD computer or domain controller object.
1817

@@ -21,15 +20,15 @@ specified AD computer or domain controller object.
2120
### NormalMode (Default)
2221

2322
```
24-
Get-LapsADPassword [-Credential <PSCredential>] [-DecryptionCredential <PSCredential>] [-IncludeHistory]
25-
[-AsPlainText] [-Identity] <String[]> [<CommonParameters>]
23+
Get-LapsADPassword [-Credential <PSCredential>] [-DecryptionCredential <PSCredential>]
24+
[-IncludeHistory] [-AsPlainText] [-Identity] <String[]> [<CommonParameters>]
2625
```
2726

2827
### DomainMode
2928

3029
```
31-
Get-LapsADPassword [-Credential <PSCredential>] [-DecryptionCredential <PSCredential>] [-IncludeHistory]
32-
[-AsPlainText] [-Identity] <String[]> -Domain <String> [<CommonParameters>]
30+
Get-LapsADPassword [-Credential <PSCredential>] [-DecryptionCredential <PSCredential>]
31+
[-IncludeHistory] [-AsPlainText] [-Identity] <String[]> -Domain <String> [<CommonParameters>]
3332
```
3433

3534
### DomainControllerMode
@@ -42,33 +41,35 @@ Get-LapsADPassword [-Credential <PSCredential>] [-DecryptionCredential <PSCreden
4241
### SnapshotBrowserMode
4342

4443
```
45-
Get-LapsADPassword [-Credential <PSCredential>] [-DecryptionCredential <PSCredential>] [-IncludeHistory]
46-
[-AsPlainText] -Port <Int32> [-Identity] <String[]> [-DomainController <String>] [<CommonParameters>]
44+
Get-LapsADPassword [-Credential <PSCredential>] [-DecryptionCredential <PSCredential>]
45+
[-IncludeHistory] [-AsPlainText] -Port <Int32> [-Identity] <String[]> [-DomainController <String>]
46+
[<CommonParameters>]
4747
```
4848

4949
### RecoveryMode
5050

5151
```
52-
Get-LapsADPassword [-IncludeHistory] [-AsPlainText] [-RecoveryMode] [-Identity] <String[]> [<CommonParameters>]
52+
Get-LapsADPassword [-IncludeHistory] [-AsPlainText] [-RecoveryMode] [-Identity] <String[]>
53+
[<CommonParameters>]
5354
```
5455

5556
### SnapshotBrowserRecoveryMode
5657

5758
```
58-
Get-LapsADPassword [-IncludeHistory] [-AsPlainText] [-RecoveryMode] -Port <Int32> [-Identity] <String[]>
59-
[<CommonParameters>]
59+
Get-LapsADPassword [-IncludeHistory] [-AsPlainText] [-RecoveryMode] -Port <Int32>
60+
[-Identity] <String[]> [<CommonParameters>]
6061
```
6162

6263
## DESCRIPTION
6364

64-
The **Get-LapsADPassword** cmdlet allows administrators to retrieve LAPS passwords and password
65+
The `Get-LapsADPassword` cmdlet allows administrators to retrieve LAPS passwords and password
6566
history for an Active Directory computer or domain controller object. Depending on policy
6667
configuration, LAPS passwords may be stored in either clear-text form or encrypted form. The
67-
**Get-LapsADPassword** cmdlet will automatically perform decryption of encrypted passwords.
68+
`Get-LapsADPassword` cmdlet will automatically perform decryption of encrypted passwords.
6869

69-
The **Get-LapsADPassword** cmdlet may also be used to connected to a mounted Active Directory snapshot.
70+
The `Get-LapsADPassword` cmdlet may also be used to connected to a mounted Active Directory snapshot.
7071

71-
The -Verbose parameter may be used to get additional information about the cmdlet's operation.
72+
The **Verbose** may be used to get additional information about the cmdlet's operation.
7273

7374
## EXAMPLES
7475

‎docset/winserver2022-ps/laps/Get-LapsDiagnostics.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,23 @@ title: Get-LapsDiagnostics
1212
# Get-LapsDiagnostics
1313

1414
## SYNOPSIS
15-
1615
Collects Windows Local Administrator Password Solution (LAPS) logs and tracing from the local
1716
machine.
1817

1918
## SYNTAX
2019

2120
```
22-
Get-LapsDiagnostics [[-OutputFolder] <String>] [-CollectNetworkTrace] [-ResetPassword] [<CommonParameters>]
21+
Get-LapsDiagnostics [[-OutputFolder] <String>] [-CollectNetworkTrace] [-ResetPassword]
22+
[<CommonParameters>]
2323
```
2424

2525
## DESCRIPTION
2626

27-
The **Get-LapsDiagnostics** cmdlet collects LAPS logs and tracing from the local machine, and copies
28-
them into a .zip file. This cmdlet is primarily intended for support and testing scenarios but of
29-
course may be used at any time. The name of the resultant .zip file includes the machine name and
30-
current timestamp, and by default is written under the %TEMP%\LapsDiagnostics folder. The output
31-
folder may be customized using the -OutputFolder parameter.
27+
The `Get-LapsDiagnostics` cmdlet collects LAPS logs and tracing from the local machine, and copies
28+
them into a `.zip` file. This cmdlet is primarily intended for support and testing scenarios but of
29+
course may be used at any time. The name of the resultant `.zip` file includes the machine name and
30+
current timestamp, and by default is written under the `$env:TEMP\LapsDiagnostics` folder. The
31+
output folder may be customized using the **OutputFolder**.
3232

3333
## EXAMPLES
3434

@@ -82,7 +82,7 @@ tracing.
8282

8383
### -CollectNetworkTrace
8484

85-
Specifies that network tracing should also be collected and included in the resultant .zip file.
85+
Specifies that network tracing should also be collected and included in the resultant `.zip` file.
8686

8787
```yaml
8888
Type: System.Management.Automation.SwitchParameter
@@ -98,7 +98,7 @@ Accept wildcard characters: False
9898
9999
### -OutputFolder
100100
101-
Specifies that the resultant .zip file should be placed under the specified folder.
101+
Specifies that the resultant `.zip` file should be placed under the specified folder.
102102

103103
```yaml
104104
Type: System.String
@@ -116,10 +116,10 @@ Accept wildcard characters: False
116116

117117
Specifies that logs and tracing should be collected across a forced password reset for the currently
118118
managed local account. In this mode the cmdlet collects tracing across a call to the
119-
**Reset-LapsPassword** cmdlet.
119+
`Reset-LapsPassword` cmdlet.
120120

121121
If this parameter is not specified, the cmdlet collects tracing across a call to the
122-
**Invoke-LapsProcessingCycle** cmdlet.
122+
`Invoke-LapsProcessingCycle` cmdlet.
123123

124124
```yaml
125125
Type: System.Management.Automation.SwitchParameter

‎docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ title: Invoke-LapsPolicyProcessing
1212
# Invoke-LapsPolicyProcessing
1313

1414
## SYNOPSIS
15-
16-
Causes Windows Local Administrator Password Solution (LAPS) to process the currently configured LAPS policy.
15+
Causes Windows Local Administrator Password Solution (LAPS) to process the currently configured LAPS
16+
policy.
1717

1818
## SYNTAX
1919

@@ -23,7 +23,7 @@ Invoke-LapsPolicyProcessing [<CommonParameters>]
2323

2424
## DESCRIPTION
2525

26-
The **Invoke-LapsPolicyProcessing** cmdlet tells Windows Local Administrator Password Solution
26+
The `Invoke-LapsPolicyProcessing` cmdlet tells Windows Local Administrator Password Solution
2727
(LAPS) to process the currently configured LAPS policy.
2828

2929
The cmdlet does not return detailed information about the results of the operation. See

‎docset/winserver2022-ps/laps/Reset-LapsPassword.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ title: Reset-LapsPassword
1212
# Reset-LapsPassword
1313

1414
## SYNOPSIS
15-
1615
Causes Windows Local Administrator Password Solution (LAPS) to immediately rotate the password for
1716
the currently managed local account.
1817

@@ -24,7 +23,7 @@ Reset-LapsPassword [<CommonParameters>]
2423

2524
## DESCRIPTION
2625

27-
The **Reset-LapsPassword** cmdlet tells Windows Local Administrator Password Solution (LAPS) to
26+
The `Reset-LapsPassword` cmdlet tells Windows Local Administrator Password Solution (LAPS) to
2827
immediately rotate the password for the currently managed local account. This operation is performed
2928
regardless of the state of the current password, for example it does not matter whether the current
3029
password is considered expired or not.

‎docset/winserver2022-ps/laps/Set-LapsADAuditing.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ title: Set-LapsADAuditing
1212
# Set-LapsADAuditing
1313

1414
## SYNOPSIS
15-
1615
Configures an Active Directory Organizational Unit to enable auditing on the Windows Local
1716
Administrator Password Solution (LAPS) password schema attributes.
1817

@@ -140,8 +139,8 @@ Specifies which Active Directory Organizational Unit to update.
140139
This parameter accepts several different name formats which influence the criteria used in the
141140
resultant Active Directory search. The supported name formats are as follows:
142141
143-
distinguishedName (begins with a "CN=")
144-
name (for all other inputs)
142+
- distinguishedName (begins with a "CN=")
143+
- name (for all other inputs)
145144
146145
```yaml
147146
Type: System.String[]

‎docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,20 @@ title: Set-LapsADComputerSelfPermission
1212
# Set-LapsADComputerSelfPermission
1313

1414
## SYNOPSIS
15-
1615
Configures permissions on an Active Directory Organizational Unit to enable computers in that OU to
1716
update their Windows Local Administrator Password Solution (LAPS) passwords.
1817

1918
## SYNTAX
2019

2120
```
22-
Set-LapsADComputerSelfPermission -Identity <String[]> [-Domain <String>] [-DomainController <String>]
23-
[-Credential <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]
21+
Set-LapsADComputerSelfPermission -Identity <String[]> [-Domain <String>]
22+
[-DomainController <String>] [-Credential <PSCredential>] [-WhatIf] [-Confirm]
23+
[<CommonParameters>]
2424
```
2525

2626
## DESCRIPTION
2727

28-
The **Set-LapsADComputerSelfPermission** cmdlet is used by administrators to configure security
28+
The `Set-LapsADComputerSelfPermission` cmdlet is used by administrators to configure security
2929
permissions on an Active Directory Organizational Unit (OU) to allow computers in that OU to update
3030
their LAPS passwords.
3131

@@ -101,8 +101,8 @@ Specifies which Active Directory Organizational Unit to update.
101101
This parameter accepts several different name formats which influence the criteria used in the
102102
resultant Active Directory search. The supported name formats are as follows:
103103
104-
distinguishedName (begins with a "CN=")
105-
name (for all other inputs)
104+
- distinguishedName (begins with a "CN=")
105+
- name (for all other inputs)
106106
107107
```yaml
108108
Type: System.String[]

‎docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,19 @@ title: Set-LapsADPasswordExpirationTime
1212
# Set-LapsADPasswordExpirationTime
1313

1414
## SYNOPSIS
15-
1615
Sets the Windows Local Administrator Password Solution (LAPS) password expiration timestamp on an
1716
Active Directory computer or domain controller object.
1817

1918
## SYNTAX
2019

2120
```
22-
Set-LapsADPasswordExpirationTime [-Credential <PSCredential>] -Identity <String[]> [-WhenEffective <DateTime>]
23-
[-Domain <String>] [-DomainController <String>] [<CommonParameters>]
21+
Set-LapsADPasswordExpirationTime [-Credential <PSCredential>] -Identity <String[]>
22+
[-WhenEffective <DateTime>] [-Domain <String>] [-DomainController <String>] [<CommonParameters>]
2423
```
2524

2625
## DESCRIPTION
2726

28-
The **Set-LapsADPasswordExpirationTime** cmdlet is used by administrators to configure the LAPS
27+
The `Set-LapsADPasswordExpirationTime` cmdlet is used by administrators to configure the LAPS
2928
password expiration time on an Active Directory computer or domain controller object.
3029

3130
> [!TIP]

‎docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ title: Set-LapsADReadPasswordPermission
1212
# Set-LapsADReadPasswordPermission
1313

1414
## SYNOPSIS
15-
1615
Configures security on an Active Directory Organizational Unit to grant specific users or groups
1716
permission to query Windows Local Administrator Password Solution (LAPS) passwords.
1817

@@ -26,11 +25,11 @@ Set-LapsADReadPasswordPermission [-Credential <PSCredential>] -Identity <String[
2625

2726
## DESCRIPTION
2827

29-
The **Set-LapsADReadPasswordPermission** cmdlet is used by administrators to configure security
28+
The `Set-LapsADReadPasswordPermission` cmdlet is used by administrators to configure security
3029
permissions on an Active Directory Organizational Unit (OU) to allow specific users or groups to
3130
query LAPS passwords on computers in that OU. Users and groups must be fully qualified with both
32-
domain and user name components; the only exception to this is when the specified name resolves to a
33-
built-in principal (for example "Domain Admins").
31+
domain and user name components. The only exception to this is when the specified name resolves to a
32+
built-in principal, such as `Domain Admins`.
3433

3534
## EXAMPLES
3635

@@ -69,8 +68,8 @@ Name DistinguishedName
6968
LapsTestOU OU=LapsTestOU,DC=laps,DC=com
7069
```
7170

72-
This example shows how to run the cmdlet specifying two fully qualified user names (in different
73-
formats) as input.
71+
This example shows how to run the cmdlet specifying two fully qualified user names in different
72+
formats.
7473

7574
### Example 4
7675

@@ -87,7 +86,7 @@ At line:1 char:1
8786

8887
This example shows a failure caused by specifying an isolated name that did not resolve to a
8988
well-known or built-in account. The fix for this error would be to add a domain name qualifier to
90-
the input name, for example "LapsAdministratorsGroup@laps.com".
89+
the input name, for example `LapsAdministratorsGroup@laps.com`.
9190

9291
## PARAMETERS
9392

@@ -165,8 +164,8 @@ Specifies which Active Directory Organizational Unit to update.
165164
This parameter accepts several different name formats which influence the criteria used in the
166165
resultant Active Directory search. The supported name formats are as follows:
167166
168-
distinguishedName (begins with a "CN=")
169-
name (for all other inputs)
167+
- distinguishedName (begins with a "CN=")
168+
- name (for all other inputs)
170169
171170
```yaml
172171
Type: System.String[]

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy