Skip to content

Commit 0b6b83c

Browse files
authored
Update description of -NoServiceRestart for all versions (#11294)
1 parent 5fd7a3d commit 0b6b83c

File tree

4 files changed

+87
-69
lines changed

4 files changed

+87
-69
lines changed

reference/5.1/Microsoft.PowerShell.Core/Register-PSSessionConfiguration.md

Lines changed: 31 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: System.Management.Automation.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Core
5-
ms.date: 06/05/2024
5+
ms.date: 07/24/2024
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/register-pssessionconfiguration?view=powershell-5.1&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Register-PSSessionConfiguration
@@ -60,7 +60,7 @@ users.
6060

6161
Every PowerShell session (**PSSession**) uses a session configuration, also known as an endpoint.
6262
When users create a session that connects to the computer, they can select a session configuration
63-
or use the default session configuration that is registered when you enable PowerShell remoting.
63+
or use the default session configuration that's registered when you enable PowerShell remoting.
6464
Users can also set the $PSSessionConfigurationName preference variable, which specifies a default
6565
configuration for remote sessions created in the current session.
6666

@@ -74,8 +74,10 @@ You can define the elements of configuration by using an assembly that implement
7474
configuration class and by using a script that runs in the session. Beginning in PowerShell
7575
3.0, you can also use a session configuration file to define the session configuration.
7676

77-
For information about session configurations, see [about_Session_Configurations](About/about_Session_Configurations.md).
78-
For information about session configuration files, see [about_Session_Configuration_Files](About/about_Session_Configuration_Files.md).
77+
For information about session configurations, see
78+
[about_Session_Configurations](About/about_Session_Configurations.md). For information about session
79+
configuration files, see
80+
[about_Session_Configuration_Files](About/about_Session_Configuration_Files.md).
7981

8082
## EXAMPLES
8183

@@ -189,7 +191,7 @@ information about dot sourcing, see [about_Scopes](./About/about_Scopes.md).
189191
Enables and disables the session configuration and determines whether it can be used for remote or
190192
local sessions on the computer. The acceptable values for this parameter are:
191193

192-
- Disabled. Disables the session configuration. It cannot be used for remote or local access to the
194+
- Disabled. Disables the session configuration. It can't be used for remote or local access to the
193195
computer.
194196
- Local. Allows users of the local computer to use the session configuration to create a local
195197
loopback session on the same computer, but denies access to remote users.
@@ -220,9 +222,9 @@ Accept wildcard characters: False
220222
221223
### -ApplicationBase
222224
223-
Specifies the path of the assembly file (\*.dll) that is specified in the value of the
224-
**AssemblyName** parameter. Use this parameter when the value of the **AssemblyName** parameter does
225-
not include a path. The default is the current directory.
225+
Specifies the path of the assembly file (`*.dll`) that's specified in the value of the
226+
**AssemblyName** parameter. Use this parameter when the value of the **AssemblyName** parameter
227+
doesn't include a path. The default is the current directory.
226228

227229
```yaml
228230
Type: System.String
@@ -257,15 +259,15 @@ Accept wildcard characters: False
257259

258260
### -ConfigurationTypeName
259261

260-
Specifies the fully qualified name of the Microsoft .NET Framework type that is used for this
262+
Specifies the fully qualified name of the Microsoft .NET Framework type that's used for this
261263
configuration. The type that you specify must implement the
262264
**System.Management.Automation.Remoting.PSSessionConfiguration** class.
263265

264-
To specify the assembly file (\*.dll) that implements the configuration type, specify the
266+
To specify the assembly file (`*.dll`) that implements the configuration type, specify the
265267
**AssemblyName** and **ApplicationBase** parameters.
266268

267269
Creating a type lets you control more aspects of the session configuration, such as exposing or
268-
hiding certain parameters of cmdlets, or setting data size and object size limits that users cannot
270+
hiding certain parameters of cmdlets, or setting data size and object size limits that users can't
269271
override.
270272

271273
If you omit this parameter, the **DefaultRemotePowerShellConfiguration** class is used for the
@@ -307,7 +309,7 @@ Accept wildcard characters: False
307309
Specifies a limit for the amount of data that can be sent to this computer in any single remote
308310
command. Enter the data size in megabytes (MB). The default is 50 MB.
309311

310-
If a data size limit is defined in the configuration type that is specified in the
312+
If a data size limit is defined in the configuration type that's specified in the
311313
**ConfigurationTypeName** parameter, the limit in the configuration type is used and the value of
312314
this parameter is ignored.
313315

@@ -318,7 +320,7 @@ Aliases:
318320

319321
Required: False
320322
Position: Named
321-
Default value: 50
323+
Default value: None
322324
Accept pipeline input: False
323325
Accept wildcard characters: False
324326
```
@@ -328,7 +330,7 @@ Accept wildcard characters: False
328330
Specifies a limit for the amount of data that can be sent to this computer in any single object.
329331
Enter the data size in megabytes. The default is 10 MB.
330332
331-
If an object size limit is defined in the configuration type that is specified in the
333+
If an object size limit is defined in the configuration type that's specified in the
332334
**ConfigurationTypeName** parameter, the limit in the configuration type is used and the value of
333335
this parameter is ignored.
334336
@@ -390,8 +392,10 @@ Accept wildcard characters: False
390392
### -NoServiceRestart
391393

392394
The intent of this parameter is to prevent the restart the **WinRM** service. This functionality
393-
isn't implemented. This will be fixed in PowerShell 7.5, but there is no plan to back port this
394-
change to Windows PowerShell 5.1.
395+
isn't implemented.
396+
397+
This functionality was implemented in PowerShell 7.5.0-preview.4, but there's no plan to back
398+
port this change to Windows PowerShell 5.1.
395399

396400
```yaml
397401
Type: System.Management.Automation.SwitchParameter
@@ -496,7 +500,7 @@ use a session configuration in a session, users must have at least Execute (Invo
496500
the configuration.
497501

498502
If the security descriptor is complex, consider using the **ShowSecurityDescriptorUI** parameter
499-
instead of this parameter. You cannot use both parameters in the same command.
503+
instead of this parameter. You can't use both parameters in the same command.
500504

501505
If you omit this parameter, the root SDDL for the **WinRM** service is used for this configuration.
502506
To view or change the root SDDL, use the WSMan provider. For example
@@ -558,7 +562,7 @@ returns.
558562
The options of sessions that use the session configuration are determined by the values of session
559563
options and the session configuration options. Unless specified, options set in the session, such as
560564
by using the `New-PSSessionOption` cmdlet, take precedence over options set in the session
561-
configuration. However, session option values cannot exceed maximum values set in the session
565+
configuration. However, session option values can't exceed maximum values set in the session
562566
configuration.
563567

564568
This parameter was introduced in PowerShell 3.0.
@@ -584,7 +588,7 @@ command and then restart the **WinRM** service.
584588
When setting the permissions for the configuration, remember that users must have at least Execute
585589
(Invoke) permission to use the session configuration in a session.
586590

587-
You cannot use the **SecurityDescriptorSDDL** parameter and this parameter in the same command.
591+
You can't use the **SecurityDescriptorSDDL** parameter and this parameter in the same command.
588592

589593
```yaml
590594
Type: System.Management.Automation.SwitchParameter
@@ -604,7 +608,7 @@ Specifies the fully qualified path of a PowerShell script. The specified script
604608
session that uses the session configuration.
605609

606610
You can use the script to additionally configure the session. If the script generates an error, even
607-
a non-terminating error, the session is not created and the `New-PSSession` command fails.
611+
a non-terminating error, the session isn't created and the `New-PSSession` command fails.
608612

609613
```yaml
610614
Type: System.String
@@ -619,9 +623,12 @@ Accept wildcard characters: False
619623
```
620624

621625
### -ThreadApartmentState
622-
Specifies the apartment state of the threads in the session.
623-
The acceptable values for this parameter are: STA, MTA, and Unknown.
624-
The default value is Unknown.
626+
627+
Specifies the apartment state of the threading module to be used. Acceptable values are:
628+
629+
- Unknown
630+
- MTA
631+
- STA
625632

626633
```yaml
627634
Type: System.Threading.ApartmentState
@@ -718,7 +725,7 @@ Accept wildcard characters: False
718725

719726
### -WhatIf
720727

721-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
728+
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
722729

723730
```yaml
724731
Type: System.Management.Automation.SwitchParameter

reference/7.2/Microsoft.PowerShell.Core/Register-PSSessionConfiguration.md

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: System.Management.Automation.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Core
5-
ms.date: 06/05/2024
5+
ms.date: 07/24/2024
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/register-pssessionconfiguration?view=powershell-7.2&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Register-PSSessionConfiguration
@@ -60,7 +60,7 @@ users.
6060

6161
Every PowerShell session (**PSSession**) uses a session configuration, also known as an endpoint.
6262
When users create a session that connects to the computer, they can select a session configuration
63-
or use the default session configuration that is registered when you enable PowerShell remoting.
63+
or use the default session configuration that's registered when you enable PowerShell remoting.
6464
Users can also set the $PSSessionConfigurationName preference variable, which specifies a default
6565
configuration for remote sessions created in the current session.
6666

@@ -74,8 +74,10 @@ You can define the elements of configuration by using an assembly that implement
7474
configuration class and by using a script that runs in the session. Beginning in PowerShell
7575
3.0, you can also use a session configuration file to define the session configuration.
7676

77-
For information about session configurations, see [about_Session_Configurations](About/about_Session_Configurations.md).
78-
For information about session configuration files, see [about_Session_Configuration_Files](About/about_Session_Configuration_Files.md).
77+
For information about session configurations, see
78+
[about_Session_Configurations](About/about_Session_Configurations.md). For information about session
79+
configuration files, see
80+
[about_Session_Configuration_Files](About/about_Session_Configuration_Files.md).
7981

8082
## EXAMPLES
8183

@@ -189,7 +191,7 @@ information about dot sourcing, see [about_Scopes](./About/about_Scopes.md).
189191
Enables and disables the session configuration and determines whether it can be used for remote or
190192
local sessions on the computer. The acceptable values for this parameter are:
191193

192-
- Disabled. Disables the session configuration. It cannot be used for remote or local access to the
194+
- Disabled. Disables the session configuration. It can't be used for remote or local access to the
193195
computer.
194196
- Local. Allows users of the local computer to use the session configuration to create a local
195197
loopback session on the same computer, but denies access to remote users.
@@ -220,9 +222,9 @@ Accept wildcard characters: False
220222
221223
### -ApplicationBase
222224
223-
Specifies the path of the assembly file (\*.dll) that is specified in the value of the
224-
**AssemblyName** parameter. Use this parameter when the value of the **AssemblyName** parameter does
225-
not include a path. The default is the current directory.
225+
Specifies the path of the assembly file (`*.dll`) that's specified in the value of the
226+
**AssemblyName** parameter. Use this parameter when the value of the **AssemblyName** parameter
227+
doesn't include a path. The default is the current directory.
226228

227229
```yaml
228230
Type: System.String
@@ -257,15 +259,15 @@ Accept wildcard characters: False
257259

258260
### -ConfigurationTypeName
259261

260-
Specifies the fully qualified name of the Microsoft .NET Framework type that is used for this
262+
Specifies the fully qualified name of the Microsoft .NET Framework type that's used for this
261263
configuration. The type that you specify must implement the
262264
**System.Management.Automation.Remoting.PSSessionConfiguration** class.
263265

264-
To specify the assembly file (\*.dll) that implements the configuration type, specify the
266+
To specify the assembly file (`*.dll`) that implements the configuration type, specify the
265267
**AssemblyName** and **ApplicationBase** parameters.
266268

267269
Creating a type lets you control more aspects of the session configuration, such as exposing or
268-
hiding certain parameters of cmdlets, or setting data size and object size limits that users cannot
270+
hiding certain parameters of cmdlets, or setting data size and object size limits that users can't
269271
override.
270272

271273
If you omit this parameter, the **DefaultRemotePowerShellConfiguration** class is used for the
@@ -307,7 +309,7 @@ Accept wildcard characters: False
307309
Specifies a limit for the amount of data that can be sent to this computer in any single remote
308310
command. Enter the data size in megabytes (MB). The default is 50 MB.
309311

310-
If a data size limit is defined in the configuration type that is specified in the
312+
If a data size limit is defined in the configuration type that's specified in the
311313
**ConfigurationTypeName** parameter, the limit in the configuration type is used and the value of
312314
this parameter is ignored.
313315

@@ -328,7 +330,7 @@ Accept wildcard characters: False
328330
Specifies a limit for the amount of data that can be sent to this computer in any single object.
329331
Enter the data size in megabytes. The default is 10 MB.
330332
331-
If an object size limit is defined in the configuration type that is specified in the
333+
If an object size limit is defined in the configuration type that's specified in the
332334
**ConfigurationTypeName** parameter, the limit in the configuration type is used and the value of
333335
this parameter is ignored.
334336
@@ -390,7 +392,9 @@ Accept wildcard characters: False
390392
### -NoServiceRestart
391393

392394
The intent of this parameter is to prevent the restart the **WinRM** service. This functionality
393-
isn't implemented yet. This will be fixed in PowerShell 7.5.
395+
isn't implemented yet.
396+
397+
This functionality was implemented in PowerShell 7.5.0-preview.4.
394398

395399
```yaml
396400
Type: System.Management.Automation.SwitchParameter
@@ -495,7 +499,7 @@ use a session configuration in a session, users must have at least Execute (Invo
495499
the configuration.
496500

497501
If the security descriptor is complex, consider using the **ShowSecurityDescriptorUI** parameter
498-
instead of this parameter. You cannot use both parameters in the same command.
502+
instead of this parameter. You can't use both parameters in the same command.
499503

500504
If you omit this parameter, the root SDDL for the **WinRM** service is used for this configuration.
501505
To view or change the root SDDL, use the WSMan provider. For example
@@ -523,7 +527,7 @@ returns.
523527
The options of sessions that use the session configuration are determined by the values of session
524528
options and the session configuration options. Unless specified, options set in the session, such as
525529
by using the `New-PSSessionOption` cmdlet, take precedence over options set in the session
526-
configuration. However, session option values cannot exceed maximum values set in the session
530+
configuration. However, session option values can't exceed maximum values set in the session
527531
configuration.
528532

529533
This parameter was introduced in PowerShell 3.0.
@@ -549,7 +553,7 @@ command and then restart the **WinRM** service.
549553
When setting the permissions for the configuration, remember that users must have at least Execute
550554
(Invoke) permission to use the session configuration in a session.
551555

552-
You cannot use the **SecurityDescriptorSDDL** parameter and this parameter in the same command.
556+
You can't use the **SecurityDescriptorSDDL** parameter and this parameter in the same command.
553557

554558
```yaml
555559
Type: System.Management.Automation.SwitchParameter
@@ -569,7 +573,7 @@ Specifies the fully qualified path of a PowerShell script. The specified script
569573
session that uses the session configuration.
570574

571575
You can use the script to additionally configure the session. If the script generates an error, even
572-
a non-terminating error, the session is not created and the `New-PSSession` command fails.
576+
a non-terminating error, the session isn't created and the `New-PSSession` command fails.
573577

574578
```yaml
575579
Type: System.String
@@ -595,6 +599,7 @@ Specifies the apartment state of the threading module to be used. Acceptable val
595599
Type: System.Threading.ApartmentState
596600
Parameter Sets: (All)
597601
Aliases:
602+
Accepted values: STA, MTA, Unknown
598603
599604
Required: False
600605
Position: Named
@@ -685,7 +690,7 @@ Accept wildcard characters: False
685690

686691
### -WhatIf
687692

688-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
693+
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
689694

690695
```yaml
691696
Type: System.Management.Automation.SwitchParameter

reference/7.4/Microsoft.PowerShell.Core/Register-PSSessionConfiguration.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: System.Management.Automation.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Core
5-
ms.date: 06/05/2024
5+
ms.date: 07/24/2024
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/register-pssessionconfiguration?view=powershell-7.4&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Register-PSSessionConfiguration
@@ -226,9 +226,9 @@ Accept wildcard characters: False
226226
227227
### -ApplicationBase
228228
229-
Specifies the path of the assembly file (\*.dll) that's specified in the value of the
230-
**AssemblyName** parameter. Use this parameter when the value of the **AssemblyName** parameter does
231-
not include a path. The default is the current directory.
229+
Specifies the path of the assembly file (`*.dll`) that's specified in the value of the
230+
**AssemblyName** parameter. Use this parameter when the value of the **AssemblyName** parameter
231+
doesn't include a path. The default is the current directory.
232232

233233
```yaml
234234
Type: System.String
@@ -267,7 +267,7 @@ Specifies the fully qualified name of the Microsoft .NET Framework type that's u
267267
configuration. The type that you specify must implement the
268268
**System.Management.Automation.Remoting.PSSessionConfiguration** class.
269269

270-
To specify the assembly file (\*.dll) that implements the configuration type, specify the
270+
To specify the assembly file (`*.dll`) that implements the configuration type, specify the
271271
**AssemblyName** and **ApplicationBase** parameters.
272272

273273
Creating a type lets you control more aspects of the session configuration, such as exposing or
@@ -396,7 +396,9 @@ Accept wildcard characters: False
396396
### -NoServiceRestart
397397

398398
The intent of this parameter is to prevent the restart the **WinRM** service. This functionality
399-
isn't implemented yet. This will be fixed in PowerShell 7.5.
399+
isn't implemented yet.
400+
401+
This functionality was implemented in PowerShell 7.5.0-preview.4.
400402

401403
```yaml
402404
Type: System.Management.Automation.SwitchParameter
@@ -601,6 +603,7 @@ Specifies the apartment state of the threading module to be used. Acceptable val
601603
Type: System.Threading.ApartmentState
602604
Parameter Sets: (All)
603605
Aliases:
606+
Accepted values: STA, MTA, Unknown
604607
605608
Required: False
606609
Position: Named

0 commit comments

Comments
 (0)