Skip to content

Commit 0166a5c

Browse files
davidsmatlaksdwheeler
davidsmatlak
authored and
sdwheeler
committed
updated credential parameter (#5035)
1 parent 29380c9 commit 0166a5c

File tree

12 files changed

+153
-33
lines changed

12 files changed

+153
-33
lines changed

‎reference/5.1/Microsoft.PowerShell.Core/Invoke-Command.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -908,10 +908,17 @@ Accept wildcard characters: False
908908
Specifies a user account that has permission to perform this action. The default is the current
909909
user.
910910

911-
Type a user name, such as User01 or Domain01\User01. Or, enter a **PSCredential** object, such as
912-
one generated by the `Get-Credential` cmdlet. If you type a user name, this cmdlet prompts you for a
911+
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
912+
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
913913
password.
914914

915+
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
916+
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).
917+
918+
> [!NOTE]
919+
> For more information about **SecureString** data protection, see
920+
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).
921+
915922
```yaml
916923
Accept pipeline input: True (ByPropertyName)
917924
Position: Named

‎reference/5.1/Microsoft.PowerShell.Core/Save-Help.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -174,12 +174,26 @@ The *Force* parameter is required when you have to run a **Save-Help** command m
174174

175175
### -Credential
176176

177-
Specifies a user credential.
178-
This cmdlet runs the command by using credentials of a user who has permission to access the file system location specified by the *DestinationPath* parameter.
179-
This parameter is valid only when the *DestinationPath* or *LiteralPath* parameter is used in the command.
180-
181-
This parameter enables you to run **Save-Help** commands that use the *DestinationPath* parameter on remote computers.
182-
By providing explicit credentials, you can run the command on a remote computer and access a file share on a third computer without encountering an access denied error or using CredSSP authentication to delegate credentials.
177+
Specifies a user credential. This cmdlet runs the command by using credentials of a user who has
178+
permission to access the file system location specified by the **DestinationPath** parameter. This
179+
parameter is valid only when the **DestinationPath** or **LiteralPath** parameter is used in the
180+
command.
181+
182+
This parameter enables you to run `Save-Help` commands that use the **DestinationPath** parameter on
183+
remote computers. By providing explicit credentials, you can run the command on a remote computer
184+
and access a file share on a third computer without encountering an access denied error or using
185+
CredSSP authentication to delegate credentials.
186+
187+
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
188+
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
189+
password.
190+
191+
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
192+
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).
193+
194+
> [!NOTE]
195+
> For more information about **SecureString** data protection, see
196+
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).
183197
184198
```yaml
185199
Type: PSCredential

‎reference/5.1/Microsoft.PowerShell.Core/Start-Job.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -275,8 +275,16 @@ Accept wildcard characters: False
275275
Specifies a user account that has permission to perform this action. If the **Credential** parameter
276276
isn't specified, the command uses the current user's credentials.
277277
278-
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object,
279-
such as one from the `Get-Credential` cmdlet.
278+
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
279+
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
280+
password.
281+
282+
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
283+
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).
284+
285+
> [!NOTE]
286+
> For more information about **SecureString** data protection, see
287+
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).
280288

281289
```yaml
282290
Type: PSCredential

‎reference/5.1/Microsoft.PowerShell.Core/Update-Help.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,14 +287,25 @@ parameter on remote computers. By providing explicit credentials, you can run th
287287
remote computer and access a file share on a third computer without encountering an access denied
288288
error or using CredSSP authentication to delegate credentials.
289289

290+
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
291+
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
292+
password.
293+
294+
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
295+
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).
296+
297+
> [!NOTE]
298+
> For more information about **SecureString** data protection, see
299+
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).
300+
290301
```yaml
291302
Type: PSCredential
292303
Parameter Sets: (All)
293304
Aliases:
294305

295306
Required: False
296307
Position: Named
297-
Default value: None
308+
Default value: Current user
298309
Accept pipeline input: False
299310
Accept wildcard characters: False
300311
```

‎reference/6/Microsoft.PowerShell.Core/Invoke-Command.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -986,10 +986,17 @@ Accept wildcard characters: False
986986
Specifies a user account that has permission to perform this action. The default is the current
987987
user.
988988

989-
Type a user name, such as User01 or Domain01\User01. Or, enter a **PSCredential** object, such as
990-
one generated by the `Get-Credential` cmdlet. If you type a user name, this cmdlet prompts you for a
989+
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
990+
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
991991
password.
992992

993+
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
994+
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).
995+
996+
> [!NOTE]
997+
> For more information about **SecureString** data protection, see
998+
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).
999+
9931000
```yaml
9941001
Accept pipeline input: True (ByPropertyName)
9951002
Position: Named

‎reference/6/Microsoft.PowerShell.Core/Save-Help.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -174,12 +174,26 @@ The *Force* parameter is required when you have to run a **Save-Help** command m
174174

175175
### -Credential
176176

177-
Specifies a user credential.
178-
This cmdlet runs the command by using credentials of a user who has permission to access the file system location specified by the *DestinationPath* parameter.
179-
This parameter is valid only when the *DestinationPath* or *LiteralPath* parameter is used in the command.
180-
181-
This parameter enables you to run **Save-Help** commands that use the *DestinationPath* parameter on remote computers.
182-
By providing explicit credentials, you can run the command on a remote computer and access a file share on a third computer without encountering an access denied error or using CredSSP authentication to delegate credentials.
177+
Specifies a user credential. This cmdlet runs the command by using credentials of a user who has
178+
permission to access the file system location specified by the **DestinationPath** parameter. This
179+
parameter is valid only when the **DestinationPath** or **LiteralPath** parameter is used in the
180+
command.
181+
182+
This parameter enables you to run `Save-Help` commands that use the **DestinationPath** parameter on
183+
remote computers. By providing explicit credentials, you can run the command on a remote computer
184+
and access a file share on a third computer without encountering an access denied error or using
185+
CredSSP authentication to delegate credentials.
186+
187+
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
188+
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
189+
password.
190+
191+
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
192+
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).
193+
194+
> [!NOTE]
195+
> For more information about **SecureString** data protection, see
196+
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).
183197
184198
```yaml
185199
Type: PSCredential

‎reference/6/Microsoft.PowerShell.Core/Start-Job.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -315,8 +315,16 @@ Accept wildcard characters: False
315315
Specifies a user account that has permission to perform this action. If the **Credential** parameter
316316
isn't specified, the command uses the current user's credentials.
317317
318-
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object,
319-
such as one from the `Get-Credential` cmdlet.
318+
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
319+
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
320+
password.
321+
322+
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
323+
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).
324+
325+
> [!NOTE]
326+
> For more information about **SecureString** data protection, see
327+
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).
320328

321329
```yaml
322330
Type: PSCredential

‎reference/6/Microsoft.PowerShell.Core/Update-Help.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,14 +247,25 @@ parameter on remote computers. By providing explicit credentials, you can run th
247247
remote computer and access a file share on a third computer without encountering an access denied
248248
error or using CredSSP authentication to delegate credentials.
249249

250+
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
251+
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
252+
password.
253+
254+
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
255+
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).
256+
257+
> [!NOTE]
258+
> For more information about **SecureString** data protection, see
259+
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).
260+
250261
```yaml
251262
Type: PSCredential
252263
Parameter Sets: (All)
253264
Aliases:
254265

255266
Required: False
256267
Position: Named
257-
Default value: None
268+
Default value: Current user
258269
Accept pipeline input: False
259270
Accept wildcard characters: False
260271
```

‎reference/7/Microsoft.PowerShell.Core/Invoke-Command.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -986,10 +986,17 @@ Accept wildcard characters: False
986986
Specifies a user account that has permission to perform this action. The default is the current
987987
user.
988988

989-
Type a user name, such as User01 or Domain01\User01. Or, enter a **PSCredential** object, such as
990-
one generated by the `Get-Credential` cmdlet. If you type a user name, this cmdlet prompts you for a
989+
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
990+
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
991991
password.
992992

993+
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
994+
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).
995+
996+
> [!NOTE]
997+
> For more information about **SecureString** data protection, see
998+
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).
999+
9931000
```yaml
9941001
Accept pipeline input: True (ByPropertyName)
9951002
Position: Named

‎reference/7/Microsoft.PowerShell.Core/Save-Help.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -174,12 +174,26 @@ The *Force* parameter is required when you have to run a **Save-Help** command m
174174

175175
### -Credential
176176

177-
Specifies a user credential.
178-
This cmdlet runs the command by using credentials of a user who has permission to access the file system location specified by the *DestinationPath* parameter.
179-
This parameter is valid only when the *DestinationPath* or *LiteralPath* parameter is used in the command.
180-
181-
This parameter enables you to run **Save-Help** commands that use the *DestinationPath* parameter on remote computers.
182-
By providing explicit credentials, you can run the command on a remote computer and access a file share on a third computer without encountering an access denied error or using CredSSP authentication to delegate credentials.
177+
Specifies a user credential. This cmdlet runs the command by using credentials of a user who has
178+
permission to access the file system location specified by the **DestinationPath** parameter. This
179+
parameter is valid only when the **DestinationPath** or **LiteralPath** parameter is used in the
180+
command.
181+
182+
This parameter enables you to run `Save-Help` commands that use the **DestinationPath** parameter on
183+
remote computers. By providing explicit credentials, you can run the command on a remote computer
184+
and access a file share on a third computer without encountering an access denied error or using
185+
CredSSP authentication to delegate credentials.
186+
187+
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
188+
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
189+
password.
190+
191+
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
192+
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).
193+
194+
> [!NOTE]
195+
> For more information about **SecureString** data protection, see
196+
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).
183197
184198
```yaml
185199
Type: PSCredential

‎reference/7/Microsoft.PowerShell.Core/Start-Job.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -340,8 +340,16 @@ Accept wildcard characters: False
340340
Specifies a user account that has permission to perform this action. If the **Credential** parameter
341341
isn't specified, the command uses the current user's credentials.
342342
343-
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object,
344-
such as one from the `Get-Credential` cmdlet.
343+
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
344+
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
345+
password.
346+
347+
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
348+
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).
349+
350+
> [!NOTE]
351+
> For more information about **SecureString** data protection, see
352+
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).
345353

346354
```yaml
347355
Type: PSCredential

‎reference/7/Microsoft.PowerShell.Core/Update-Help.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,14 +247,25 @@ parameter on remote computers. By providing explicit credentials, you can run th
247247
remote computer and access a file share on a third computer without encountering an access denied
248248
error or using CredSSP authentication to delegate credentials.
249249

250+
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
251+
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
252+
password.
253+
254+
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
255+
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).
256+
257+
> [!NOTE]
258+
> For more information about **SecureString** data protection, see
259+
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).
260+
250261
```yaml
251262
Type: PSCredential
252263
Parameter Sets: (All)
253264
Aliases:
254265

255266
Required: False
256267
Position: Named
257-
Default value: None
268+
Default value: Current user
258269
Accept pipeline input: False
259270
Accept wildcard characters: False
260271
```

0 commit comments

Comments
 (0)