Skip to content

Updated Credential parameter description with SecureString information (part 1) #5034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 30, 2019
Merged

Updated Credential parameter description with SecureString information (part 1) #5034

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4a5651
updated credential parameter
davidsmatlak Oct 30, 2019
38e4c01
Merge branch 'staging' of https://github.com/MicrosoftDocs/PowerShell…
davidsmatlak Oct 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions reference/5.1/Microsoft.PowerShell.Core/Connect-PSSession.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ started by using the Enter-PSSession cmdlet.
Also you cannot connect sessions to sessions started by other users, unless you can provide the
credentials of the user who created the session.

For more information about the Disconnected Sessions feature, see
For more information about the Disconnected Sessions feature, see
[about_Remote_Disconnected_Sessions](About/about_Remote_Disconnected_Sessions.md).

This cmdlet was introduced in Windows PowerShell 3.0.
Expand Down Expand Up @@ -425,9 +425,16 @@ Accept wildcard characters: False
Specifies a user account that has permission to connect to the disconnected session.
The default is the current user.

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

Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Type: PSCredential
Expand All @@ -436,7 +443,7 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down Expand Up @@ -493,7 +500,7 @@ Accept wildcard characters: False
Parameter Sets: Name, ComputerName, ConnectionUri
Required: True (Name), False (ComputerName, ConnectionUri)
Default value: None
Aliases:
Aliases:
Type: String[]
```

Expand Down Expand Up @@ -694,10 +701,10 @@ session, use the **Availability** property.
A value of Busy indicates that you cannot connect to the **PSSession** because it is connected to
another session.

For more information about the values of the **State** property of sessions, see
For more information about the values of the **State** property of sessions, see
[RunspaceState Enumeration](https://msdn.microsoft.com/library/system.management.automation.runspaces.runspacestate) in the MSDN library.

For more information about the values of the **Availability** property of sessions, see
For more information about the values of the **Availability** property of sessions, see
[RunspaceAvailability Enumeration](https://msdn.microsoft.com/library/system.management.automation.runspaces.runspaceavailability) in the MSDN library.

* You cannot change the idle time-out value of a **PSSession** when you connect to the
Expand Down
22 changes: 14 additions & 8 deletions reference/5.1/Microsoft.PowerShell.Core/Enter-PSSession.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,22 +403,28 @@ Accept wildcard characters: False

### -Credential

Specifies a user account that has permission to perform this action.
The default is the current user.
Specifies a user account that has permission to perform this action. The default is the current
user.

Type a user name, such as `User01`, `Domain01\User01`, or `User@Domain.com`, or enter a
**PSCredential** object, such as one returned by the Get-Credential cmdlet.
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
password.

When you type a user name, this cmdlet prompts you for a password.
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Accept pipeline input: True (ByPropertyName)
Position: Named
Position: 1
Accept wildcard characters: False
Parameter Sets: ComputerName, Uri, VMId, VMName
Required: True (VMId, VMName), False (ComputerName, Uri)
Default value: None
Aliases:
Default value: Current user
Aliases:
Type: PSCredential
```

Expand Down
27 changes: 17 additions & 10 deletions reference/5.1/Microsoft.PowerShell.Core/Get-PSSession.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,16 +520,23 @@ Accept wildcard characters: False

### -Credential

Specifies a user credential.
This cmdlet runs the command with the permissions of the specified user.
Specify a user account that has permission to connect to the remote computer and run a
**Get-PSSession** command. The default is the current user.
Type a user name, such as `User01`, `Domain01\User01`, or `User@Domain.com`, or enter a
**PSCredential** object, such as one returned by the Get-Credential cmdlet.
When you type a user name, this cmdlet prompts you for a password.
Specifies a user credential. This cmdlet runs the command with the permissions of the specified
user. Specify a user account that has permission to connect to the remote computer and run a
`Get-PSSession` command. The default is the current user.

This parameter configures to the temporary connection that is created to run a **Get-PSSession**
command with the *ComputerName* or *ConnectionUri* parameter.
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
password.

Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

This parameter configures to the temporary connection that is created to run a `Get-PSSession`
command with the **ComputerName** or **ConnectionUri** parameter.

This parameter was introduced in Windows PowerShell 3.0.

Expand Down Expand Up @@ -604,7 +611,7 @@ Accept wildcard characters: True
Parameter Sets: Name, ComputerName, ConnectionUri, ContainerId, VMId, VMName
Required: False
Default value: All sessions
Aliases:
Aliases:
Type: String[]
```

Expand Down
19 changes: 12 additions & 7 deletions reference/5.1/Microsoft.PowerShell.Core/New-PSSession.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,22 +478,27 @@ Accept wildcard characters: False

### -Credential

Specifies a user account that has permission to perform this action.
The default is the current user.
Specifies a user account that has permission to do this action. The default is the current user.

Type a user name, such as User01, Domain01\User01, or User@Domain.com, or enter a **PSCredential**
object, such as one returned by the Get-Credential cmdlet.
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
password.

When you type a user name, this cmdlet prompts you for a password.
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Accept pipeline input: True (ByPropertyName)
Position: Named
Accept wildcard characters: False
Parameter Sets: ComputerName, Uri, VMId, VMName
Required: True (VMId, VMName), False (ComputerName, Uri)
Default value: None
Aliases:
Default value: Current user
Aliases:
Type: PSCredential
```

Expand Down
13 changes: 10 additions & 3 deletions reference/5.1/Microsoft.PowerShell.Core/Receive-PSSession.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,18 +465,25 @@ Accept wildcard characters: False
Specifies a user account that has permission to connect to the disconnected session. The default is
the current user.

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

Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Type: PSCredential
Parameter Sets: ComputerSessionName, ComputerInstanceId, ConnectionUriSessionName, ConnectionUriInstanceId
Aliases:

Required: False
Position: Named
Default value: None
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
15 changes: 11 additions & 4 deletions reference/6/Microsoft.PowerShell.Core/Connect-PSSession.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,9 +424,16 @@ Accept wildcard characters: False
Specifies a user account that has permission to connect to the disconnected session.
The default is the current user.

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

Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Type: PSCredential
Expand All @@ -435,7 +442,7 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
18 changes: 12 additions & 6 deletions reference/6/Microsoft.PowerShell.Core/Enter-PSSession.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,21 +439,27 @@ Accept wildcard characters: False

### -Credential

Specifies a user account that has permission to perform this action.
The default is the current user.
Specifies a user account that has permission to perform this action. The default is the current
user.

Type a user name, such as `User01`, `Domain01\User01`, or `User@Domain.com`, or enter a
**PSCredential** object, such as one returned by the Get-Credential cmdlet.
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
password.

Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

When you type a user name, this cmdlet prompts you for a password.
> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Accept pipeline input: True (ByPropertyName)
Position: 1
Accept wildcard characters: False
Parameter Sets: ComputerName, Uri, VMId, VMName
Required: True (VMId, VMName), False (ComputerName, Uri)
Default value: None
Default value: Current user
Aliases:
Type: PSCredential
```
Expand Down
27 changes: 17 additions & 10 deletions reference/6/Microsoft.PowerShell.Core/Get-PSSession.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,16 +520,23 @@ Accept wildcard characters: False

### -Credential

Specifies a user credential.
This cmdlet runs the command with the permissions of the specified user.
Specify a user account that has permission to connect to the remote computer and run a
**Get-PSSession** command. The default is the current user.
Type a user name, such as `User01`, `Domain01\User01`, or `User@Domain.com`, or enter a
**PSCredential** object, such as one returned by the Get-Credential cmdlet.
When you type a user name, this cmdlet prompts you for a password.
Specifies a user credential. This cmdlet runs the command with the permissions of the specified
user. Specify a user account that has permission to connect to the remote computer and run a
`Get-PSSession` command. The default is the current user.

This parameter configures to the temporary connection that is created to run a **Get-PSSession**
command with the *ComputerName* or *ConnectionUri* parameter.
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
password.

Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

This parameter configures to the temporary connection that is created to run a `Get-PSSession`
command with the **ComputerName** or **ConnectionUri** parameter.

This parameter was introduced in Windows PowerShell 3.0.

Expand All @@ -540,7 +547,7 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
17 changes: 11 additions & 6 deletions reference/6/Microsoft.PowerShell.Core/New-PSSession.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,21 +540,26 @@ Accept wildcard characters: False

### -Credential

Specifies a user account that has permission to perform this action.
The default is the current user.
Specifies a user account that has permission to do this action. The default is the current user.

Type a user name, such as User01, Domain01\User01, or User@Domain.com, or enter a **PSCredential**
object, such as one returned by the Get-Credential cmdlet.
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
generated by the `Get-Credential` cmdlet. If you type a user name, you're prompted to enter the
password.

Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

When you type a user name, this cmdlet prompts you for a password.
> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Accept pipeline input: True (ByPropertyName)
Position: Named
Accept wildcard characters: False
Parameter Sets: ComputerName, Uri, VMName, VMId
Required: True (VMName, VMId), False (ComputerName, Uri)
Default value: None
Default value: Current user
Aliases:
Type: PSCredential
```
Expand Down
19 changes: 13 additions & 6 deletions reference/6/Microsoft.PowerShell.Core/Receive-PSSession.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,12 +495,19 @@ Accept wildcard characters: False

### -Credential

Specifies a user account that has permission to connect to the disconnected session.
The default is the current user.
Specifies a user account that has permission to connect to the disconnected session. The default is
the current user.

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

Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Type: PSCredential
Expand All @@ -509,7 +516,7 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
Loading