Skip to content

Commit b88fb54

Browse files
ArieHeinsdwheeler
andauthored
Markdown and PS Styles (#11758)
* Markdown and PS Styles * Minor edits and rebase --------- Co-authored-by: Sean Wheeler <[email protected]>
1 parent a474ee9 commit b88fb54

18 files changed

+160
-123
lines changed

reference/7.5/Microsoft.PowerShell.Management/Remove-Item.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ it in single quotation marks. Single quotation marks tell PowerShell not to inte
354354
as escape sequences.
355355

356356
For more information, see
357-
[about_Quoting_Rules](../Microsoft.Powershell.Core/About/about_Quoting_Rules.md).
357+
[about_Quoting_Rules](../Microsoft.PowerShell.Core/About/about_Quoting_Rules.md).
358358

359359
```yaml
360360
Type: System.String[]
@@ -440,8 +440,8 @@ Accept wildcard characters: True
440440
Prompts you for confirmation before running the cmdlet. For more information, see the following
441441
articles:
442442

443-
- [about_Preference_Variables](../microsoft.powershell.core/about/about_preference_variables.md#confirmpreference)
444-
- [about_Functions_CmdletBindingAttribute](../microsoft.powershell.core/about/about_functions_cmdletbindingattribute.md?#confirmimpact)
443+
- [about_Preference_Variables](../Microsoft.PowerShell.Core/About/about_Preference_Variables.md#confirmpreference)
444+
- [about_Functions_CmdletBindingAttribute](../Microsoft.PowerShell.Core/About/about_Functions_CmdletBindingAttribute.md#confirmimpact)
445445

446446
```yaml
447447
Type: System.Management.Automation.SwitchParameter
@@ -533,6 +533,6 @@ design.
533533

534534
[about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md)
535535

536-
[about_Preference_Variables](../microsoft.powershell.core/about/about_preference_variables.md#confirmpreference)
536+
[about_Preference_Variables](../Microsoft.PowerShell.Core/About/about_Preference_Variables.md#confirmpreference)
537537

538-
[about_Functions_CmdletBindingAttribute](../microsoft.powershell.core/about/about_functions_cmdletbindingattribute.md?#confirmimpact)
538+
[about_Functions_CmdletBindingAttribute](../Microsoft.PowerShell.Core/About/about_Functions_CmdletBindingAttribute.md#confirmimpact)

reference/7.5/Microsoft.PowerShell.Management/Remove-ItemProperty.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ Deletes the property and its value from an item.
1818
### Path (Default)
1919

2020
```
21-
Remove-ItemProperty [-Path] <String[]> [-Name] <String[]> [-Force] [-Filter <String>] [-Include <String[]>]
22-
[-Exclude <String[]>] [-Credential <PSCredential>] [-InformationAction <ActionPreference>]
23-
[-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
21+
Remove-ItemProperty [-Path] <String[]> [-Name] <String[]> [-Force] [-Filter <String>]
22+
[-Include <String[]>] [-Exclude <String[]>] [-Credential <PSCredential>]
23+
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm]
24+
[<CommonParameters>]
2425
```
2526

2627
### LiteralPath
@@ -55,7 +56,7 @@ path of the "SmpApplication" subkey, including the drive, `HKLM:`, and the "Soft
5556
These commands delete the "Options" registry value, and its data, from the "MyApp" subkey of
5657
"HKEY_CURRENT_USER\Software\MyCompany".
5758

58-
```
59+
```powershell
5960
PS C:\> Set-Location HKCU:\Software\MyCompany\MyApp
6061
PS HKCU:\Software\MyCompany\MyApp> Remove-ItemProperty -Path . -Name "Options" -Confirm
6162
```
@@ -124,11 +125,13 @@ Accept wildcard characters: True
124125

125126
### -Filter
126127

127-
Specifies a filter to qualify the **Path** parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)
128-
provider is the only installed PowerShell provider that supports the use of filters. You can find
129-
the syntax for the **FileSystem** filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md).
130-
Filters are more efficient than other parameters, because the provider applies them when the cmdlet
131-
gets the objects rather than having PowerShell filter the objects after they are retrieved.
128+
Specifies a filter to qualify the **Path** parameter. The
129+
[FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the only
130+
installed PowerShell provider that supports the use of filters. You can find the syntax for the
131+
**FileSystem** filter language in
132+
[about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient
133+
than other parameters, because the provider applies them when the cmdlet gets the objects rather
134+
than having PowerShell filter the objects after they are retrieved.
132135

133136
```yaml
134137
Type: System.String
@@ -187,7 +190,8 @@ typed. No characters are interpreted as wildcards. If the path includes escape c
187190
it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters
188191
as escape sequences.
189192

190-
For more information, see [about_Quoting_Rules](../Microsoft.Powershell.Core/About/about_Quoting_Rules.md).
193+
For more information, see
194+
[about_Quoting_Rules](../Microsoft.Powershell.Core/About/about_Quoting_Rules.md).
191195

192196
```yaml
193197
Type: System.String[]
@@ -270,10 +274,10 @@ Accept wildcard characters: False
270274

271275
### CommonParameters
272276

273-
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`,
274-
`-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`,
275-
`-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see
276-
[about_CommonParameters](../Microsoft.PowerShell.Core/About/about_CommonParameters.md).
277+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
278+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
279+
-WarningAction, and -WarningVariable. For more information, see
280+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
277281

278282
## INPUTS
279283

reference/7.5/Microsoft.PowerShell.Management/Rename-Computer.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,16 @@ Renames a computer.
1717

1818
```
1919
Rename-Computer [-ComputerName <String>] [-PassThru] [-DomainCredential <PSCredential>]
20-
[-LocalCredential <PSCredential>] [-NewName] <String> [-Force] [-Restart] [-WsmanAuthentication <String>]
21-
[-WhatIf] [-Confirm] [<CommonParameters>]
20+
[-LocalCredential <PSCredential>] [-NewName] <String> [-Force] [-Restart]
21+
[-WsmanAuthentication <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
2222
```
2323

2424
## DESCRIPTION
2525

2626
> **This cmdlet is only available on the Windows platform.**
2727
28-
The `Rename-Computer` cmdlet renames the local computer or a remote computer.
29-
It renames one computer in each command.
28+
The `Rename-Computer` cmdlet renames the local computer or a remote computer. It renames one
29+
computer in each command.
3030

3131
This cmdlet was introduced in Windows PowerShell 3.0.
3232

@@ -51,7 +51,13 @@ computers in the domain.
5151
The **Force** parameter suppresses the confirmation prompt.
5252

5353
```powershell
54-
Rename-Computer -ComputerName "Srv01" -NewName "Server001" -DomainCredential Domain01\Admin01 -Force
54+
$renameParams = @{
55+
ComputerName = "Srv01"
56+
NewName = "Server001"
57+
DomainCredential = "Domain01\Admin01"
58+
Force = $true
59+
}
60+
Rename-Computer @renameParams
5561
```
5662

5763
## PARAMETERS
@@ -215,7 +221,8 @@ WSMan protocol. The acceptable values for this parameter are:
215221

216222
The default value is **Default**.
217223

218-
For more information about the values of this parameter, see [AuthenticationMechanism Enumeration](/dotnet/api/system.management.automation.runspaces.authenticationmechanism).
224+
For more information about the values of this parameter, see
225+
[AuthenticationMechanism Enumeration](xref:System.Management.Automation.Runspaces.AuthenticationMechanism).
219226

220227
> [!WARNING]
221228
> Credential Security Service Provider (CredSSP) authentication, in which the user
@@ -278,7 +285,7 @@ Accept wildcard characters: False
278285
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
279286
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
280287
-WarningAction, and -WarningVariable. For more information, see
281-
[about_CommonParameters](../Microsoft.PowerShell.Core/About/about_CommonParameters.md).
288+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
282289

283290
## INPUTS
284291

reference/7.5/Microsoft.PowerShell.Management/Rename-Item.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ Use the `Move-Item` cmdlet, instead.
7272

7373
### Example 3: Rename a registry key
7474

75-
This example renames a registry key from **Advertising** to **Marketing**. When the command is complete,
76-
the key is renamed, but the registry entries in the key are unchanged.
75+
This example renames a registry key from **Advertising** to **Marketing**. When the command is
76+
complete, the key is renamed, but the registry entries in the key are unchanged.
7777

7878
```powershell
7979
Rename-Item -Path "HKLM:\Software\MyCompany\Advertising" -NewName "Marketing"
@@ -127,7 +127,8 @@ sensitive.
127127

128128
> [!NOTE]
129129
> This parameter is not supported by any providers installed with PowerShell. To impersonate another
130-
> user, or elevate your credentials when running this cmdlet, use [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md).
130+
> user, or elevate your credentials when running this cmdlet, use
131+
> [Invoke-Command](../Microsoft.PowerShell.Core/Invoke-Command.md).
131132
132133
```yaml
133134
Type: System.Management.Automation.PSCredential
@@ -145,7 +146,8 @@ Accept wildcard characters: False
145146
146147
Forces the cmdlet to rename items that can't otherwise be changed, such as hidden or read-only files
147148
or read-only aliases or variables. The cmdlet can't change constant aliases or variables.
148-
Implementation varies from provider to provider. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md).
149+
Implementation varies from provider to provider. For more information, see
150+
[about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md).
149151
150152
Even using the **Force** parameter, the cmdlet can't override security restrictions.
151153
@@ -168,7 +170,8 @@ typed. No characters are interpreted as wildcards. If the path includes escape c
168170
it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters
169171
as escape sequences.
170172
171-
For more information, see [about_Quoting_Rules](../Microsoft.Powershell.Core/About/about_Quoting_Rules.md).
173+
For more information, see
174+
[about_Quoting_Rules](../Microsoft.Powershell.Core/About/about_Quoting_Rules.md).
172175
173176
```yaml
174177
Type: System.String
@@ -190,7 +193,8 @@ To rename and move an item, use `Move-Item`.
190193

191194
You can't use wildcard characters in the value of the **NewName** parameter. To specify a name for
192195
multiple files, use the **Replace** operator in a regular expression. For more information about the
193-
Replace operator, see [about_Comparison_Operators](../Microsoft.PowerShell.Core/About/about_Comparison_Operators.md).
196+
Replace operator, see
197+
[about_Comparison_Operators](../Microsoft.PowerShell.Core/About/about_Comparison_Operators.md).
194198

195199
```yaml
196200
Type: System.String
@@ -274,7 +278,8 @@ Accept wildcard characters: False
274278

275279
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
276280
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
277-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](../Microsoft.PowerShell.Core/About/about_CommonParameters.md).
281+
-WarningAction, and -WarningVariable. For more information, see
282+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
278283

279284
## INPUTS
280285

@@ -302,7 +307,8 @@ PowerShell includes the following aliases for `Rename-Item`:
302307
- `rni`
303308

304309
`Rename-Item` is designed to work with the data exposed by any provider. To list the providers
305-
available in your session, type `Get-PsProvider`. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md).
310+
available in your session, type `Get-PsProvider`. For more information, see
311+
[about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md).
306312

307313
## RELATED LINKS
308314

reference/7.5/Microsoft.PowerShell.Management/Rename-ItemProperty.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,13 @@ Accept wildcard characters: True
9191

9292
### -Filter
9393

94-
Specifies a filter to qualify the **Path** parameter. The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md)
95-
provider is the only installed PowerShell provider that supports the use of filters. You can find
96-
the syntax for the **FileSystem** filter language in [about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md).
97-
Filters are more efficient than other parameters, because the provider applies them when the cmdlet
98-
gets the objects rather than having PowerShell filter the objects after they are retrieved.
94+
Specifies a filter to qualify the **Path** parameter.
95+
The [FileSystem](../Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md) provider is the
96+
only installed PowerShell provider that supports the use of filters. You can find the syntax for the
97+
**FileSystem** filter language in
98+
[about_Wildcards](../Microsoft.PowerShell.Core/About/about_Wildcards.md). Filters are more efficient
99+
than other parameters, because the provider applies them when the cmdlet gets the objects rather
100+
than having PowerShell filter the objects after they are retrieved.
99101

100102
```yaml
101103
Type: System.String
@@ -154,7 +156,8 @@ typed. No characters are interpreted as wildcards. If the path includes escape c
154156
it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters
155157
as escape sequences.
156158

157-
For more information, see [about_Quoting_Rules](../Microsoft.Powershell.Core/About/about_Quoting_Rules.md).
159+
For more information, see
160+
[about_Quoting_Rules](../Microsoft.Powershell.Core/About/about_Quoting_Rules.md).
158161

159162
```yaml
160163
Type: System.String
@@ -269,10 +272,10 @@ Accept wildcard characters: False
269272

270273
### CommonParameters
271274

272-
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`,
273-
`-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`,
274-
`-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see
275-
[about_CommonParameters](../Microsoft.PowerShell.Core/About/about_CommonParameters.md).
275+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
276+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
277+
-WarningAction, and -WarningVariable. For more information, see
278+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
276279

277280
## INPUTS
278281

reference/7.5/Microsoft.PowerShell.Management/Resolve-Path.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ Accept wildcard characters: False
287287
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
288288
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
289289
-WarningAction, and -WarningVariable. For more information, see
290-
[about_CommonParameters](../Microsoft.PowerShell.Core/About/about_CommonParameters.md).
290+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
291291
292292
## INPUTS
293293
@@ -316,7 +316,7 @@ The `*-Path` cmdlets work with the **FileSystem**, **Registry**, and **Certifica
316316
317317
`Resolve-Path` is designed to work with any provider. To list the providers available in your
318318
session, type `Get-PSProvider`. For more information, see
319-
[about_providers](../microsoft.powershell.core/about/about_providers.md).
319+
[about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md).
320320
321321
`Resolve-Path` only resolves existing paths. It cannot be used to resolve a location that does not
322322
exist yet.

reference/7.5/Microsoft.PowerShell.Management/Restart-Computer.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ queries the remote computer every two seconds to determine whether it's restarte
108108
`Restart-Computer` restarts the remote computer using the **WsmanAuthentication** mechanism.
109109
Kerberos authentication determines whether the current user has permission to restart the remote
110110
computer. For more information, see
111-
[AuthenticationMechanism](/dotnet/api/system.management.automation.runspaces.authenticationmechanism).
111+
[AuthenticationMechanism](xref:System.Management.Automation.Runspaces.AuthenticationMechanism).
112112

113113
```powershell
114114
Restart-Computer -ComputerName Server01 -WsmanAuthentication Kerberos
@@ -152,12 +152,12 @@ Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCred
152152
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
153153
password.
154154

155-
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
156-
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).
155+
Credentials are stored in a [PSCredential](xref:System.Management.Automation.PSCredential)
156+
object and the password is stored as a [SecureString](xref:System.Security.SecureString).
157157

158158
> [!NOTE]
159159
> For more information about **SecureString** data protection, see
160-
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).
160+
> [How secure is SecureString?](xref:System.Security.SecureString#how-secure-is-securestring).
161161

162162
```yaml
163163
Type: System.Management.Automation.PSCredential
@@ -297,7 +297,7 @@ The acceptable values for this parameter are: **Basic**, **CredSSP**, **Default*
297297
**Kerberos**, and **Negotiate**.
298298

299299
For more information, see
300-
[AuthenticationMechanism](/dotnet/api/system.management.automation.runspaces.authenticationmechanism).
300+
[AuthenticationMechanism](xref:System.Management.Automation.Runspaces.AuthenticationMechanism).
301301

302302
> [!WARNING]
303303
> Credential Security Service Provider (CredSSP) authentication, in which the user credentials are
@@ -355,7 +355,8 @@ Accept wildcard characters: False
355355

356356
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
357357
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
358-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
358+
-WarningAction, and -WarningVariable. For more information, see
359+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
359360

360361
## INPUTS
361362

@@ -371,10 +372,12 @@ This cmdlet returns no output.
371372

372373
## NOTES
373374

374-
- In Windows, `Restart-Computer` uses the [Win32Shutdown method](/windows/desktop/CIMWin32Prov/win32shutdown-method-in-class-win32-operatingsystem)
375-
of the Windows Management Instrumentation (WMI) [Win32_OperatingSystem](/windows/desktop/CIMWin32Prov/win32-operatingsystem)
376-
class. This method requires the **SeShutdownPrivilege** privilege be enabled for the user account
377-
used to restart the machine.
375+
- In Windows, `Restart-Computer` uses the
376+
[Win32Shutdown method](/windows/desktop/CIMWin32Prov/win32shutdown-method-in-class-win32-operatingsystem)
377+
of the Windows Management Instrumentation (WMI)
378+
[Win32_OperatingSystem](/windows/desktop/CIMWin32Prov/win32-operatingsystem) class. This method
379+
requires the **SeShutdownPrivilege** privilege be enabled for the user account used to restart
380+
the machine.
378381
- On Linux and Mac OS, `Restart-Computer` uses the `/sbin/shutdown` bash tool.
379382

380383
## RELATED LINKS

reference/7.5/Microsoft.PowerShell.Management/Set-Clipboard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ $PSDefaultParameterValues['Set-Clipboard:AsOSC52'] = $env:SSH_TTY
6868
```
6969

7070
For more information about `$PSDefaultParameterValues`, see
71-
[about_Parameters_Default_Values](/powershell/module/microsoft.powershell.core/about/about_parameters_default_values).
71+
[about_Parameters_Default_Values](../Microsoft.PowerShell.Core/About/about_Parameters_Default_Values.md).
7272

7373
## PARAMETERS
7474

0 commit comments

Comments
 (0)