Skip to content

Commit 2323ebc

Browse files
Merge pull request #13091 from MicrosoftDocs/main
Auto Publish – main to live - 2026-06-16 22:00 UTC
2 parents 8e10478 + 36d0824 commit 2323ebc

437 files changed

Lines changed: 4616 additions & 3254 deletions

File tree

Some content is hidden

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

reference/5.1/Microsoft.PowerShell.Core/About/about_Functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -436,7 +436,7 @@ Switch off
436436
## Use splatting to pass parameter values
437437

438438
You can use splatting to represent the parameters of a command. This feature is
439-
introduced in Windows PowerShell 3.0.
439+
introduced in Windows PowerShell 2.0.
440440

441441
Use this technique in functions that call commands in the session. You don't
442442
need to declare or enumerate the command parameters, or change the function

reference/5.1/Microsoft.PowerShell.Core/About/about_Intrinsic_Members.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Every PowerShell object includes the following properties.
4949

5050
- `psobject`
5151

52-
The `psobject` **MemberSet** a rich source of reflection for any object that
52+
The `psobject` **MemberSet** is a rich source of reflection for any object that
5353
includes methods, properties, and other information about the object.
5454

5555
### Examples

reference/5.1/Microsoft.PowerShell.Security/Protect-CmsMessage.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,22 @@ Encrypts content by using the Cryptographic Message Syntax format.
1717
### ByContent (Default)
1818

1919
```
20-
Protect-CmsMessage [-To] <CmsMessageRecipient[]> [-Content] <PSObject> [[-OutFile] <String>]
21-
[<CommonParameters>]
20+
Protect-CmsMessage [-To] <CmsMessageRecipient[]> [-Content] <PSObject>
21+
[[-OutFile] <String>] [<CommonParameters>]
2222
```
2323

2424
### ByPath
2525

2626
```
27-
Protect-CmsMessage [-To] <CmsMessageRecipient[]> [-Path] <String> [[-OutFile] <String>] [<CommonParameters>]
27+
Protect-CmsMessage [-To] <CmsMessageRecipient[]> [-Path] <String> [[-OutFile] <String>]
28+
[<CommonParameters>]
2829
```
2930

3031
### ByLiteralPath
3132

3233
```
33-
Protect-CmsMessage [-To] <CmsMessageRecipient[]> [-LiteralPath] <String> [[-OutFile] <String>]
34-
[<CommonParameters>]
34+
Protect-CmsMessage [-To] <CmsMessageRecipient[]> [-LiteralPath] <String>
35+
[[-OutFile] <String>] [<CommonParameters>]
3536
```
3637

3738
## DESCRIPTION

reference/5.1/Microsoft.PowerShell.Security/Set-Acl.md

Lines changed: 33 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,25 @@ Changes the security descriptor of a specified item, such as a file or a registr
1818
### ByPath (Default)
1919

2020
```
21-
Set-Acl [-Path] <String[]> [-AclObject] <Object> [[-CentralAccessPolicy] <String>] [-ClearCentralAccessPolicy]
22-
[-PassThru] [-Filter <String>] [-Include <String[]>] [-Exclude <String[]>] [-WhatIf] [-Confirm]
23-
[-UseTransaction] [<CommonParameters>]
21+
Set-Acl [-Path] <String[]> [-AclObject] <Object> [[-CentralAccessPolicy] <String>]
22+
[-ClearCentralAccessPolicy] [-PassThru] [-Filter <String>] [-Include <String[]>]
23+
[-Exclude <String[]>] [-WhatIf] [-Confirm] [-UseTransaction] [<CommonParameters>]
2424
```
2525

2626
### ByInputObject
2727

2828
```
29-
Set-Acl [-InputObject] <PSObject> [-AclObject] <Object> [-PassThru] [-Filter <String>] [-Include <String[]>]
30-
[-Exclude <String[]>] [-WhatIf] [-Confirm] [-UseTransaction] [<CommonParameters>]
29+
Set-Acl [-InputObject] <PSObject> [-AclObject] <Object> [-PassThru] [-Filter <String>]
30+
[-Include <String[]>] [-Exclude <String[]>] [-WhatIf] [-Confirm] [-UseTransaction]
31+
[<CommonParameters>]
3132
```
3233

3334
### ByLiteralPath
3435

3536
```
3637
Set-Acl -LiteralPath <String[]> [-AclObject] <Object> [[-CentralAccessPolicy] <String>]
37-
[-ClearCentralAccessPolicy] [-PassThru] [-Filter <String>] [-Include <String[]>] [-Exclude <String[]>]
38-
[-WhatIf] [-Confirm] [-UseTransaction] [<CommonParameters>]
38+
[-ClearCentralAccessPolicy] [-PassThru] [-Filter <String>] [-Include <String[]>]
39+
[-Exclude <String[]>] [-WhatIf] [-Confirm] [-UseTransaction] [<CommonParameters>]
3940
```
4041

4142
## DESCRIPTION
@@ -129,20 +130,20 @@ Set-Acl -Path "C:\Pets\Dog.txt" -AclObject $NewAcl
129130
These commands disable access inheritance from parent folders, while still preserving the existing
130131
inherited access rules.
131132

132-
The first command uses the `Get-Acl` cmdlet to get the security descriptor of the Dog.txt file.
133+
The first command uses the `Get-Acl` cmdlet to get the security descriptor of the `Dog.txt` file.
133134

134135
Next, variables are created to convert the inherited access rules to explicit access rules. To
135136
protect the access rules associated with this from inheritance, set the `$isProtected` variable to
136137
`$true`. To allow inheritance, set `$isProtected` to `$false`. For more information, see
137-
[set access rule protection](/dotnet/api/system.security.accesscontrol.objectsecurity.setaccessruleprotection).
138+
[set access rule protection](xref:System.Security.AccessControl.ObjectSecurity.SetAccessRuleProtection%2A).
138139

139140
Set the `$preserveInheritance` variable to `$true` to preserve inherited access rules or `$false` to
140141
remove inherited access rules. Then the access rule protection is updated using the
141142
**SetAccessRuleProtection()** method.
142143

143-
The last command uses `Set-Acl` to apply the security descriptor of to Dog.txt. When the command
144-
completes, the ACLs of the Dog.txt that were inherited from the Pets folder will be applied directly
145-
to Dog.txt, and new access policies added to Pets will not change the access to Dog.txt.
144+
The last command uses `Set-Acl` to apply the security descriptor to `Dog.txt`. When the command
145+
completes, the ACLs of the `Dog.txt` that were inherited from the Pets folder will be applied directly
146+
to `Dog.txt`, and new access policies added to Pets will not change the access to `Dog.txt`.
146147

147148
### Example 5: Grant Administrators Full Control of the file
148149

@@ -154,29 +155,33 @@ $fileSystemRights = "FullControl"
154155
$type = "Allow"
155156
# Create new rule
156157
$fileSystemAccessRuleArgumentList = $identity, $fileSystemRights, $type
157-
$fileSystemAccessRule = New-Object -TypeName System.Security.AccessControl.FileSystemAccessRule -ArgumentList $fileSystemAccessRuleArgumentList
158+
$newParams = @{
159+
TypeName = 'System.Security.AccessControl.FileSystemAccessRule'
160+
ArgumentList = $fileSystemAccessRuleArgumentList
161+
}
162+
$fileSystemAccessRule = New-Object @newParams
158163
# Apply new rule
159164
$NewAcl.SetAccessRule($fileSystemAccessRule)
160165
Set-Acl -Path "C:\Pets\Dog.txt" -AclObject $NewAcl
161166
```
162167

163-
This command will grant the **BUILTIN\Administrators** group Full control of the Dog.txt file.
168+
This command will grant the **BUILTIN\Administrators** group Full control of the `Dog.txt` file.
164169

165-
The first command uses the `Get-Acl` cmdlet to get the security descriptor of the Dog.txt file.
170+
The first command uses the `Get-Acl` cmdlet to get the security descriptor of the `Dog.txt` file.
166171

167-
Next variables are created to grant the **BUILTIN\Administrators** group full control of the Dog.txt
168-
file. The `$identity` variable set to the name of a
169-
[user account](/dotnet/api/system.security.accesscontrol.filesystemaccessrule.-ctor). The
172+
Next variables are created to grant the **BUILTIN\Administrators** group full control of the
173+
`Dog.txt` file. The `$identity` variable set to the name of a
174+
[user account](xref:System.Security.AccessControl.FileSystemAccessRule.%23ctor%2A). The
170175
`$fileSystemRights` variable set to FullControl, and can be any one of the
171-
[FileSystemRights](/dotnet/api/system.security.accesscontrol.filesystemrights) values that specifies
172-
the type of operation associated with the access rule. The `$type` variable set to "Allow" to
173-
specifies whether to allow or deny the operation. The `$fileSystemAccessRuleArgumentList` variable
174-
is an argument list is to be passed when making the new **FileSystemAccessRule** object. Then a new
176+
[FileSystemRights](xref:System.Security.AccessControl.FileSystemRights) values that specifies the
177+
type of operation associated with the access rule. The `$type` variable set to "Allow" to specifies
178+
whether to allow or deny the operation. The `$fileSystemAccessRuleArgumentList` variable is an
179+
argument list is to be passed when making the new **FileSystemAccessRule** object. Then a new
175180
**FileSystemAccessRule** object is created, and the **FileSystemAccessRule** object is passed to the
176181
**SetAccessRule()** method, adds the new access rule.
177182

178-
The last command uses `Set-Acl` to apply the security descriptor of to Dog.txt. When the command
179-
completes, the **BUILTIN\Administrators** group will have full control of the Dog.txt.
183+
The last command uses `Set-Acl` to apply the security descriptor of to `Dog.txt`. When the command
184+
completes, the **BUILTIN\Administrators** group will have full control of the `Dog.txt`.
180185

181186
## PARAMETERS
182187

@@ -364,7 +369,7 @@ Changes the security descriptor of the specified item. Enter the path to an item
364369
a file or registry key. Wildcards are permitted.
365370

366371
If you pass a security object to `Set-Acl` (either by using the **AclObject** or
367-
**SecurityDescriptor** parameters or by passing a security object from Get-Acl to `Set-Acl`), and
372+
**SecurityDescriptor** parameters or by passing a security object from `Get-Acl` to `Set-Acl`), and
368373
you omit the **Path** parameter (name and value), `Set-Acl` uses the path that is included in the
369374
security object.
370375

@@ -467,8 +472,8 @@ can use it to change the security descriptors of files, directories, and registr
467472

468473
[Get-Acl](Get-Acl.md)
469474

470-
[FileSystemAccessRule](/dotnet/api/system.security.accesscontrol.filesystemaccessrule.-ctor)
475+
[FileSystemAccessRule](xref:System.Security.AccessControl.FileSystemAccessRule.%23ctor%2A)
471476

472-
[ObjectSecurity.SetAccessRuleProtection](/dotnet/api/system.security.accesscontrol.objectsecurity.setaccessruleprotection)
477+
[ObjectSecurity.SetAccessRuleProtection](xref:System.Security.AccessControl.ObjectSecurity.SetAccessRuleProtection%2A)
473478

474-
[FileSystemRights](/dotnet/api/system.security.accesscontrol.filesystemrights)
479+
[FileSystemRights](xref:System.Security.AccessControl.FileSystemRights)

reference/5.1/Microsoft.PowerShell.Security/Set-ExecutionPolicy.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,15 @@ Sets the PowerShell execution policies for Windows computers.
1818
### All
1919

2020
```
21-
Set-ExecutionPolicy [-ExecutionPolicy] <ExecutionPolicy> [[-Scope] <ExecutionPolicyScope>] [-Force]
22-
[-WhatIf] [-Confirm] [<CommonParameters>]
21+
Set-ExecutionPolicy [-ExecutionPolicy] <ExecutionPolicy> [[-Scope] <ExecutionPolicyScope>]
22+
[-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
2323
```
2424

2525
## DESCRIPTION
2626

2727
The `Set-ExecutionPolicy` cmdlet changes PowerShell execution policies for Windows computers. For
28-
more information, see [about_Execution_Policies](../Microsoft.PowerShell.Core/about/about_Execution_Policies.md).
28+
more information, see
29+
[about_Execution_Policies](../Microsoft.PowerShell.Core/about/about_Execution_Policies.md).
2930

3031
An execution policy is part of the PowerShell security strategy. Execution policies determine
3132
whether you can load configuration files, such as your PowerShell profile, or run scripts. And,

reference/5.1/Microsoft.PowerShell.Security/Test-FileCatalog.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@ This cmdlet is only supported on Windows.
1919
## SYNTAX
2020

2121
```
22-
Test-FileCatalog [-Detailed] [-FilesToSkip <String[]>] [-CatalogFilePath] <String> [[-Path] <String[]>]
23-
[-WhatIf] [-Confirm] [<CommonParameters>]
22+
Test-FileCatalog [-Detailed] [-FilesToSkip <String[]>] [-CatalogFilePath] <String>
23+
[[-Path] <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
2424
```
2525

2626
## DESCRIPTION
2727

2828
`Test-FileCatalog` validates the authenticity of files by comparing the file hashes of a catalog
2929
file (.cat) with the hashes of actual files on disk. If it detects any mismatches, it returns the
3030
status as ValidationFailed. Users can retrieve all this information by using the -Detailed
31-
parameter. It also displays signing status of catalog in Signature property which is equivalent to
31+
parameter. It also displays signing status of catalog in Signature property, which is equivalent to
3232
calling `Get-AuthenticodeSignature` cmdlet on the catalog file. Users can also skip any file during
3333
validation by using the -FilesToSkip parameter.
3434

@@ -39,9 +39,18 @@ This cmdlet is only supported on Windows.
3939
### Example 1: Create and validate a file catalog
4040

4141
```powershell
42-
New-FileCatalog -Path $PSHOME\Modules\Microsoft.PowerShell.Utility -CatalogFilePath \temp\Microsoft.PowerShell.Utility.cat -CatalogVersion 2.0
43-
44-
Test-FileCatalog -CatalogFilePath \temp\Microsoft.PowerShell.Utility.cat -Path "$PSHOME\Modules\Microsoft.PowerShell.Utility\"
42+
$NewFileCatalogParams = @{
43+
Path = "$PSHOME\Modules\Microsoft.PowerShell.Utility"
44+
CatalogFilePath = "\temp\Microsoft.PowerShell.Utility.cat"
45+
CatalogVersion = 2.0
46+
}
47+
New-FileCatalog @NewFileCatalogParams
48+
49+
$TestFileCatalogParams = @{
50+
CatalogFilePath = "\temp\Microsoft.PowerShell.Utility.cat"
51+
Path = "$PSHOME\Modules\Microsoft.PowerShell.Utility\"
52+
}
53+
Test-FileCatalog @TestFileCatalogParams
4554
```
4655

4756
```Output
@@ -51,7 +60,12 @@ Valid
5160
### Example 2: Validate a file catalog with detailed output
5261

5362
```powershell
54-
Test-FileCatalog -Detailed -CatalogFilePath \temp\Microsoft.PowerShell.Utility.cat -Path "$PSHOME\Modules\Microsoft.PowerShell.Utility\"
63+
$TestFileCatalogParams = @{
64+
Detailed = $true
65+
CatalogFilePath = "\temp\Microsoft.PowerShell.Utility.cat"
66+
Path = "$PSHOME\Modules\Microsoft.PowerShell.Utility\"
67+
}
68+
Test-FileCatalog @TestFileCatalogParams
5569
```
5670

5771
```Output
@@ -70,7 +84,7 @@ Signature : System.Management.Automation.Signature
7084

7185
### -CatalogFilePath
7286

73-
A path to a catalog file (.cat) that contains the hashes to be used for validation.
87+
A path to a catalog file (`.cat`) that contains the hashes to be used for validation.
7488

7589
```yaml
7690
Type: System.String
@@ -167,9 +181,10 @@ Accept wildcard characters: False
167181

168182
### CommonParameters
169183

170-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction,
171-
-InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and
172-
-WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
184+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
185+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
186+
-WarningAction, and -WarningVariable. For more information, see
187+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
173188

174189
## INPUTS
175190

reference/5.1/Microsoft.PowerShell.Security/Unprotect-CmsMessage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ Unprotect-CmsMessage [-Path] <string> [[-To] <CmsMessageRecipient[]>] [-IncludeC
3939
### ByLiteralPath
4040

4141
```
42-
Unprotect-CmsMessage [-LiteralPath] <string> [[-To] <CmsMessageRecipient[]>] [-IncludeContext]
43-
[<CommonParameters>]
42+
Unprotect-CmsMessage [-LiteralPath] <string> [[-To] <CmsMessageRecipient[]>]
43+
[-IncludeContext] [<CommonParameters>]
4444
```
4545

4646
## DESCRIPTION

reference/5.1/Microsoft.PowerShell.Utility/Add-Type.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -731,7 +731,7 @@ Otherwise, the command fails.
731731
The **CodeDomProvider** class for some languages, such as IronPython and J#, doesn't generate
732732
output. As a result, types written in these languages can't be used with `Add-Type`.
733733

734-
This cmdlet is based on the Microsoft .NET Framework [CodeDomProvider Class](/dotnet/api/system.codedom.compiler.codedomprovider).
734+
This cmdlet is based on the Microsoft .NET Framework [CodeDomProvider Class](xref:System.CodeDom.Compiler.CodeDomProvider).
735735

736736
## RELATED LINKS
737737

reference/5.1/Microsoft.PowerShell.Utility/Clear-Variable.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Utility
5-
ms.date: 12/12/2022
5+
ms.date: 06/16/2026
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/clear-variable?view=powershell-5.1&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
aliases:
@@ -18,8 +18,8 @@ Deletes the value of a variable.
1818
## SYNTAX
1919

2020
```
21-
Clear-Variable [-Name] <String[]> [-Include <String[]>] [-Exclude <String[]>] [-Force] [-PassThru]
22-
[-Scope <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
21+
Clear-Variable [-Name] <String[]> [-Include <String[]>] [-Exclude <String[]>] [-Force]
22+
[-PassThru] [-Scope <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
2323
```
2424

2525
## DESCRIPTION
@@ -41,7 +41,7 @@ This command removes the value of global variables that have names that begin wi
4141
### Example 2: Clear a variable in a child scope but not the parent scope
4242

4343
```powershell
44-
$a=3
44+
$a = 3
4545
&{ Clear-Variable a }
4646
$a
4747
```
@@ -165,7 +165,8 @@ The acceptable values for this parameter are:
165165
- `Script`
166166

167167
You can also use a number relative to the current scope (0 through the number of scopes, where 0 is
168-
the current scope and 1 is its parent). Local is the default. For more information, see [about_Scopes](../Microsoft.PowerShell.Core/About/about_Scopes.md).
168+
the current scope and 1 is its parent). Local is the default. For more information, see
169+
[about_Scopes](../Microsoft.PowerShell.Core/About/about_Scopes.md).
169170

170171
```yaml
171172
Type: System.String
@@ -215,13 +216,14 @@ Accept wildcard characters: False
215216

216217
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
217218
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
218-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
219+
-WarningAction, and -WarningVariable. For more information, see
220+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
219221

220222
## INPUTS
221223

222-
### None
224+
### System.String
223225

224-
You can't pipe objects to this cmdlet.
226+
The **Name** parameter accepts string input from pipeline objects with a **Name** property.
225227

226228
## OUTPUTS
227229

@@ -236,7 +238,7 @@ the cleared variable.
236238

237239
## NOTES
238240

239-
Windows PowerShell includes the following aliases for `Clear-Variable`:
241+
PowerShell includes the following aliases for `Clear-Variable`:
240242

241243
- `clv`
242244

reference/5.1/Microsoft.PowerShell.Utility/ConvertFrom-Csv.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ ConvertFrom-Csv [-InputObject] <psobject[]> [[-Delimiter] <char>] [-Header <stri
2626
### UseCulture
2727

2828
```
29-
ConvertFrom-Csv [-InputObject] <psobject[]> -UseCulture [-Header <string[]>] [<CommonParameters>]
29+
ConvertFrom-Csv [-InputObject] <psobject[]> -UseCulture [-Header <string[]>]
30+
[<CommonParameters>]
3031
```
3132

3233
## DESCRIPTION

0 commit comments

Comments
 (0)