Skip to content

Commit 7bb75bf

Browse files
author
Sean Wheeler
authored
Merging latest updates into Live (#1908)
* Update the example of `Where-Object -IsNot` (#1841) * Update Example 5 in Group-Object.md (#1845) * removing @{Text=} tags * fixing UTF8 characters * removed empty H3 * added H3 for input and output types * removed mangled UTF8 character * updating Out-* commands with -NoNewLine per Issue 1739 * Fix the example of `Format-Table -DisplayError` (#1848) The example is a `-DisplayError` parameter example. But it uses `-ShowError` parameter. * Fix the example of `Format-Wide -DisplayError` (#1850) * Fix the example of `Format-Custom -DisplayError` (#1849) The example is a -DisplayError parameter example. But it uses -ShowError parameter. * updating set-acl docs per PR#901 * using semantic link breaks * Fix the example of `Format-Wide -ShowError` (#1851) * Fixed Test-ScriptFileInfo example (#1852) * fixing issue 1768 * Formatting, example fix for Body parameter (#1847) 1. Replaced variable names with PascalCase convention and for consistency 2. Removed directory information [c:\] in the examples 3. Put powershell keyword for formatting examples 4. Replaced Invoke-RestMethod with Invoke-WebRequest in the Body example, added method Post 5. Removed InformationAction and InformationVariable parameters, which were mistakenly a copy of Body, included already in CommonVariables part * fixing style consistency across articles * Fix example numbers in Resume-Job.md (#1857) Example 4 is duplicated. * Fixes typo $WebSiteName in separatingEnvData.md (#1856) - Adds the website name to common node property inside configuration data. - Also, it is now referenced (e.g. $Node.WebSiteName) in the DSC configuration document in MyWebApp.ps1. * Updates configurations.md (#1855) Two set of changes made. - Example scripts e.g. MyDscConfiguration.ps1 define the configuration inside them and call the configuration at the end line. Removed the call to the configuration at the end. Since the article demonstrates dot-sourcing the file and calling the configuration explicitly. - Fixed typo in the file name (TEST-PC1.mof to localhost.mof ), since the ComputerName was not specified it should default to using 'localhost' as the default argument for it. P.S. - There is a comment on the web-page regarding the fixes made * Fix typo in comment (#1854) * Updating the help content for v6. (#1853) * Updating the help content for v6. * Address code review comments * Fix broken links * Fix example numbers in about_Transactions.md (#1859) Example number '7' is duplicated. * Update Alias-Provider.md (#1831) 1. Removed statement that an alias is to an executable, the definition cotnains the path. It may - but does not need to be. For example: Try Set-Alias np Notepad then look at the definition. 2. Clarified that an alias can also be to a powershell script (ps1 file). 3. Tidied up the language removing multiple 'And,' clauses to improve readability. * Add documentation of new -AsHashtable switch for ConvertFrom-Json introduced by PR #5043 (#1858) * add documentation of new -AsHashTable switch for ConvertFrom-Json and also document the behaviour in case of duplicate strings. * correct casing of -AsHashtable switch. * Address PR comments about -AsHashtable switch for ConvertFrom-Json.md * Accept pipeline input: False for -AsHashtable switch in ConvertFrom-Json.md * Revert "Accept pipeline input: False for -AsHashtable switch in ConvertFrom-Json.md" Accidentally change the wrong field. This reverts commit 6e76191. * Accept pipeline input: False for -AsHashtable switch in ConvertFrom-Json.md * Fix example numbers in Invoke-WebRequest.md (#1862) Example number '4' is duplicated. * reformatting and integrating changes from PR#1831 (#1860) * Fix example numbers in Get-Help.md (#1869) Example number 12 and 13 are missing. * Fix example numbers in Import-Module.md (#1868) Example number '10' is duplicated. * Fix example number in ConvertTo-Html.html (#1867) Example number '10' is duplicated. * Update dscCiCd.md (#1865) Missing a period on line 378. Should be `$(Build.ArtifactStagingDirectory)\` not `$(BuildArtifactStagingDirectory)\`. * Web Cmdlets 6.0.0 Documentation Refresh (#1870) * Web Cmdlets 6.0.0 Documentation Refresh * Address PR Feedback * Merge Example 4 and 5 in Get-Member.md (#1874) Example 4 and 5 in Get-Member.md v3.0 and v4.0 are almost the same. They should be merged as with v5.0. * Remove hash algorithms unsupported in v6.0 (#1873) MACTripleDES and RIPEMD160 are no longer supported in v6.0. * Update outputs of Get-Verb (#1872) Since v6.0, `Get-Verb` returns not MemberDefinition but VerbInfo that has Verb and Group properties. * Fix typo in ConvertTo-Html.md (UTF-x) (#1879) * Fix "Accept wildcard characters" in Get-Service.md v6 (#1878) * Fixed "False" -> "True" (`DisplayName`, `Exclude`, `Include`, and `Name`) * Removed `InformationAction` and `InformationVariable` * Fixed Get-WindowsFeature cmdlet HyperLink (#1877) * Fixed Get-WindowsFeature cmdlet HyperLink Minor edit. Update Get-WindowsFeature cmdlet HyperLink to https://technet.microsoft.com/library/jj205469(v=wps.630).aspx * Changed URL to new docs.microsoft.com location The TechNet URL did not work. TechNet and MSDN are being retired. * Update Get-WinEvent.md (#1876) Removed future tense in a couple of places to improve readability. Minor edit. * Update Example 8 in Get-Process.md (find the owner of a process) (#1875) * Update Example 8 in Get-Process.md (Find the owner of a process) * Update to attempt to avoid build errors It seems that the build system does not accept multiple script blocks per one Example header. * updated localmachine\Root to LocalMachine\My (#1880) The example where we import the PFX on the target node should import the cert into Personal store and not root. * Update Group property example in Get-Verb.md (#1881) * adding missing space (#1885) * removing stray character (#1886) * Update Example 9 in Get-Process.md (#1888) * powershell -> pwsh (only v6.0) * Windows PowerShell -> PowerShell * Remove "About ISE" files of v6.0 (#1891) * Remove "About ISE" files of v6.0 ISE is no longer bundled with PowerShell 6.0. * Remove links for "About ISE" files of v6.0 * Update Get-Process.md (#1890) Fixed name parameter details to show it accepts wildcards in the name * Update productincompat.md (#1892) The list of compatible systems should include Skype For Business Server 2015 and Lync Server 2013. * Update unapproved verbs examples in Get-Verb.md (#1896) * Updated Example 4 * Removed Example 5 * Removing extra space in the Example 5A script (#1894) It was highlighting as string in the documentation, I was trying to remove all the extra space. * fixing merge conflict * updates to style and contrib * tweak format * tweak format 2 * fix typo * fix number list example * adding review feedback * fix broken links * incorporating feedback from zach * reformatting About_* for 80 columns - part 1 * reformat about_* * reformatting About_* topics - Part 2 * fixing broken links * fixing more broken links * more broken links fixed * Fix parameter's position in Get-Random.md (#1901) * Fix parameter's position in Measure-Command.md (#1905) * Fix parameter's position in Trace-Command.md (#1904) * Actually call the configuration in the example (#1906) On line 74, it says... "The last line of the example containing only the name of the configuration, calls the configuration." This change actually makes that call. * reformatting About_* for 80 columns - part 3 (#1902) * reformatting About_* * reformatting About_* part 3 * fixing broken links * fixing more broken links * one more time with the links
1 parent 93c647a commit 7bb75bf

File tree

56 files changed

+4738
-4474
lines changed

Some content is hidden

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

56 files changed

+4738
-4474
lines changed

‎dsc/configurations.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ Configuration MyDscConfiguration {
2626
Name = "Bitlocker"
2727
}
2828
}
29-
}
29+
}
30+
MyDscConfiguration
3031
3132
```
3233

@@ -60,6 +61,7 @@ Configuration MyDscConfiguration {
6061
}
6162
}
6263
}
64+
MyDscConfiguration
6365
6466
```
6567

‎reference/3.0/Microsoft.PowerShell.Core/About/about_Functions_CmdletBindingAttribute.md‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
11
---
2-
ms.date: 2017-06-09
2+
ms.date: 2017-11-28
33
schema: 2.0.0
44
locale: en-us
55
keywords: powershell,cmdlet
66
title: about_Functions_CmdletBindingAttribute
77
---
88

99
# About Functions CmdletBindingAttribute
10-
## about_Functions_CmdletBindingAttribute
11-
1210

1311
# SHORT DESCRIPTION
1412

15-
Describes the attribute that makes a function work like a
16-
compiled cmdlet.
13+
Describes the attribute that makes a function work like a compiled cmdlet.
1714

1815
# LONG DESCRIPTION
1916

@@ -124,13 +121,15 @@ to an advanced function.
124121
function Get-Numbers {
125122
[CmdletBinding(SupportsPaging = $true)]
126123
param()
127-
124+
128125
$FirstNumber = [Math]::Min($PSCmdlet.PagingParameters.Skip, 100)
129-
$LastNumber = [Math]::Min($PSCmdlet.PagingParameters.First + $FirstNumber - 1, 100)
130-
126+
$LastNumber = [Math]::Min($PSCmdlet.PagingParameters.First +
127+
$FirstNumber - 1, 100)
128+
131129
if ($PSCmdlet.PagingParameters.IncludeTotalCount) {
132130
$TotalCountAccuracy = 1.0
133-
$TotalCount = $PSCmdlet.PagingParameters.NewTotalCount(100, $TotalCountAccuracy)
131+
$TotalCount = $PSCmdlet.PagingParameters.NewTotalCount(100,
132+
$TotalCountAccuracy)
134133
Write-Output $TotalCount
135134
}
136135
$FirstNumber .. $LastNumber | Write-Output
@@ -173,8 +172,7 @@ must be included when the parameter is used in a function.
173172
The Position argument of the Parameter attribute takes precedence over the
174173
PositionalBinding default value. You can use the Position argument to specify
175174
a position value for a parameter. For more information about the Position
176-
argument, see about_Functions_Advanced_Parameters
177-
(http://go.microsoft.com/fwlink/?LinkID=135173).
175+
argument, see [about_Functions_Advanced_Parameters](about_Functions_Advanced_Parameters.md).
178176

179177
# NOTES
180178

‎reference/3.0/Microsoft.PowerShell.Core/About/about_Group_Policy_Settings.md‎

Lines changed: 62 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,45 @@
11
---
2-
ms.date: 2017-06-09
2+
ms.date: 2017-11-28
33
schema: 2.0.0
44
locale: en-us
55
keywords: powershell,cmdlet
66
title: about_Group_Policy_Settings
77
---
88

99
# About Group Policy Settings
10-
## about_Group_Policy_Settings
11-
1210

1311
# SHORT DESCRIPTION
1412

1513
Describes the Group Policy settings for Windows PowerShell
1614

1715
# LONG DESCRIPTION
1816

19-
2017
Windows PowerShell includes Group Policy settings to help you define
2118
consistent option values for servers in an enterprise environment.
2219

2320
The Windows PowerShell Group Policy settings are in the following
2421
Group Policy paths:
2522

26-
Computer Configuration\Administrative Templates\Windows Components\Windows PowerShell
27-
User Configuration\Administrative Templates\Windows Components\Windows PowerShell
23+
Computer Configuration\
24+
Administrative Templates\
25+
Windows Components\
26+
Windows PowerShell
27+
28+
User Configuration\
29+
Administrative Templates\
30+
Windows Components\
31+
Windows PowerShell
2832

2933
Group policy settings in the User Configuration path take precedence
3034
over Group Policy settings in the Computer Configuration path.
3135

3236
The policies are as follows:
3337

34-
Turn on Script Execution: Sets the Windows PowerShell execution
35-
policy.
36-
Turn on Module Logging: Sets the LogPipelineExecutionDetails
37-
property of modules.
38-
Set the default source path for Update-Help:
39-
Sets the source for UpdatableHelp to
40-
a directory, not the Internet.
38+
- Turn on Script Execution: Sets the Windows PowerShell execution policy.
39+
- Turn on Module Logging: Sets the LogPipelineExecutionDetails property of
40+
modules.
41+
- Set the default source path for Update-Help: Sets the source for
42+
UpdatableHelp to a directory, not the Internet.
4143

4244
To download spreadsheets that list all of the Group Policy settings for
4345
each version of Windows, see "Group Policy Settings Reference for Windows
@@ -53,28 +55,27 @@ run.
5355
If you enable the policy setting, you can select from among the following
5456
policy settings.
5557

56-
-- "Allow only signed scripts" allows scripts to execute only if they
57-
are signed by a trusted publisher. This policy setting is equivalent
58-
to the AllSigned execution policy.
58+
- "Allow only signed scripts" allows scripts to execute only if they are
59+
signed by a trusted publisher. This policy setting is equivalent to the
60+
AllSigned execution policy.
5961

60-
-- "Allow local scripts and remote signed scripts" allows all local
61-
scripts to run. Scripts that originate from the Internet must be
62-
signed by a trusted publisher. This policy setting is equivalent
63-
to the RemoteSigned execution policy.
62+
- "Allow local scripts and remote signed scripts" allows all local scripts to
63+
run. Scripts that originate from the Internet must be signed by a trusted
64+
publisher. This policy setting is equivalent to the RemoteSigned execution
65+
policy.
6466

65-
-- "Allow all scripts" allows all scripts to run. This policy
66-
setting is equivalent to the Unrestricted execution policy.
67+
- "Allow all scripts" allows all scripts to run. This policy setting is
68+
equivalent to the Unrestricted execution policy.
6769

68-
If you disable this policy setting, no scripts are allowed to run.
69-
This policy setting is equivalent to the Restricted execution policy.
70+
If you disable this policy setting, no scripts are allowed to run. This policy
71+
setting is equivalent to the Restricted execution policy.
7072

71-
If you disable or do not configure this policy setting, the execution
72-
policy that is set for the computer or user by the Set-ExecutionPolicy
73-
cmdlet determines whether scripts are permitted to run. The default
74-
value is Restricted.
73+
If you disable or do not configure this policy setting, the execution policy
74+
that is set for the computer or user by the Set-ExecutionPolicy cmdlet
75+
determines whether scripts are permitted to run. The default value is
76+
Restricted.
7577

76-
For more information, see about_Execution_Policies
77-
(http://go.microsoft.com/fwlink/?LinkID=135170).
78+
For more information, see [about_Execution_Policies](about_Execution_Policies.md).
7879

7980
# TURN ON MODULE LOGGING
8081

@@ -99,56 +100,54 @@ To turn on module logging for a module, use the following command format.
99100
The module must be imported into the session and the setting is effective
100101
only in the current session.
101102

103+
```powershell
102104
PS C:> Import-Module <Module-Name>
103105
PS C:> (Get-Module <Module-Name>).LogPipelineExecutionDetails = $true
106+
```
104107

105108
To turn on module logging for all sessions on a particular computer,
106109
add the previous commands to the all-users Windows PowerShell profile
107110
($Profile.AllUsers.AllHosts).
108111

109-
For more information about module logging, see about_Modules
110-
(http://go.microsoft.com/fwlink/?LinkID=144311).
112+
For more information about module logging, see [about_Modules](about_Modules.md).
111113

112114
# SET THE DEFAULT SOURCE PATH FOR UPDATE-HELP
113115

114116
The "Set the Default Source Path for Update-Help" policy setting sets a
115-
default value for the SourcePath parameter of the Update-Help cmdlet.
116-
This setting prevents users from using the Update-Help cmdlet to download
117-
help files from the Internet.
117+
default value for the SourcePath parameter of the Update-Help cmdlet. This
118+
setting prevents users from using the Update-Help cmdlet to download help
119+
files from the Internet.
118120

119-
NOTE: The "Set the default source path for Update-Help" Group
120-
Policy setting appears under Computer Configuration and
121-
User Configuration. However, only the Group Policy setting
122-
under Computer Configuration is effective. The Group Policy
123-
setting under User Configuration is ignored.
121+
NOTE: The "Set the default source path for Update-Help" Group Policy setting
122+
appears under Computer Configuration and User Configuration. However, only the
123+
Group Policy setting under Computer Configuration is effective. The Group
124+
Policy setting under User Configuration is ignored.
124125

125126
The Update-Help cmdlet downloads and installs the newest help files for
126127
Windows PowerShell modules and installs them on the computer. By default,
127-
Update-Help downloads new help files from an Internet location specified
128-
by the module.
128+
Update-Help downloads new help files from an Internet location specified by
129+
the module.
129130

130-
However, you can use the Save-Help cmdlet to download the newest help
131-
files to a file system location, such as a network share, and then use
132-
the Update-Help cmdlet to get the help files from the file system
133-
location and install them on the computer. The SourcePath parameter of
134-
the Update-Help cmdlet specifies the file system location.
131+
However, you can use the Save-Help cmdlet to download the newest help files to
132+
a file system location, such as a network share, and then use the Update-Help
133+
cmdlet to get the help files from the file system location and install them on
134+
the computer. The SourcePath parameter of the Update-Help cmdlet specifies the
135+
file system location.
135136

136-
By providing a default value for the SourcePath parameter, this Group
137-
Policy setting implicitly adds the SourcePath parameter to all Update-Help
138-
commands. Users can override the particular file system location specified
139-
as the default value by entering a different file system location. But they
140-
cannot remove the SourcePath parameter from the Update-Help command.
137+
By providing a default value for the SourcePath parameter, this Group Policy
138+
setting implicitly adds the SourcePath parameter to all Update-Help commands.
139+
Users can override the particular file system location specified as the
140+
default value by entering a different file system location. But they cannot
141+
remove the SourcePath parameter from the Update-Help command.
141142

142143
If you enable this policy setting, you can specify a default value for the
143144
SourcePath parameter. Enter a file system location.
144145

145-
If this policy setting is disabled or not configured, there is no
146-
default value for the SourcePath parameter of the Update-Help cmdlet.
147-
Users can download help from the Internet or from any file system
148-
location.
146+
If this policy setting is disabled or not configured, there is no default
147+
value for the SourcePath parameter of the `Update-Help` cmdlet. Users can
148+
download help from the Internet or from any file system location.
149149

150-
For more information, see about_Updatable_Help
151-
(http://go.microsoft.com/fwlink/?LinkID=235801).
150+
For more information, see [about_Updatable_Help](about_Updatable_Help.md).
152151

153152
# KEYWORDS
154153

@@ -163,13 +162,12 @@ about_GroupPolicy
163162

164163
[about_Updatable_Help](about_Updatable_Help.md)
165164

166-
Get-ExecutionPolicy
167-
168-
Set-ExecutionPolicy
165+
[Get-ExecutionPolicy](../../Microsoft.PowerShell.Security/Get-ExecutionPolicy.md)
169166

170-
Get-Module
167+
[Set-ExecutionPolicy](../../Microsoft.PowerShell.Security/Set-ExecutionPolicy.md)
171168

172-
Update-Help
169+
[Get-Module](../Get-Module.md)
173170

174-
Save-Help
171+
[Update-Help](../Update-Help.md)
175172

173+
[Save-Help](../Save-Help.md)

0 commit comments

Comments
 (0)