Skip to content

Updated Credential parameter description with SecureString information (part 3) #5037

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.

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 1 commit into from
Oct 31, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 9 additions & 6 deletions reference/5.1/Microsoft.PowerShell.Management/New-PSDrive.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,12 +142,8 @@ To view the contents from a PowerShell session: `Get-ChildItem -Path MyCompany:`
### Example 4: Create a persistent mapped network drive using credentials

This example maps a network drive that's authenticated with a domain service account's credentials.
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).
For more information about the **PSCredential** object that stores credentials and how passwords are
stored as a **SecureString**, see the **Credential** parameter's description.

```powershell
$cred = Get-Credential -Credential Contoso\ServiceAccount
Expand Down Expand Up @@ -277,6 +273,13 @@ Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCred
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: (All)
Expand Down
17 changes: 12 additions & 5 deletions reference/5.1/Microsoft.PowerShell.Management/Restart-Computer.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,11 +210,18 @@ Accept wildcard characters: False

### -Credential

Specifies a user account that has permission to do this action. Type a user name, such as User01,
Domain01\User01, or enter a **PSCredential** object generated by the `Get-Credential` cmdlet.
Specifies a user account that has permission to do this action. The default is the current user.

If the **Credential** parameter isn't specified, `Restart-Computer` uses the current user's
credentials.
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 @@ -223,7 +230,7 @@ Aliases:

Required: False
Position: 1
Default value: None
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
18 changes: 14 additions & 4 deletions reference/5.1/Microsoft.PowerShell.Management/Start-Process.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,19 @@ Accept wildcard characters: False

### -Credential

Specifies a user account that has permission to perform this action. Type a user name, such as
User01 or Domain01\User01, or enter a **PSCredential** object, such as one from the `Get-Credential`
cmdlet. By default, the cmdlet uses the credentials of the current user.
Specifies a user account that has permission to perform this action. By default, the cmdlet uses the
credentials of the current user.

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 @@ -152,7 +162,7 @@ Aliases: RunAs

Required: False
Position: Named
Default value: None
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
17 changes: 13 additions & 4 deletions reference/5.1/Microsoft.PowerShell.Management/Stop-Computer.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,10 +141,19 @@ Accept wildcard characters: False
```

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

Type a user name, such as User01 or Domain01\User01, or enter a **PSCredential** object, such as one from the Get-Credential cmdlet.
Specifies a user account that has permission to do this action. The default is the current user.

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 @@ -153,7 +162,7 @@ Aliases:

Required: False
Position: 1
Default value: None
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
15 changes: 9 additions & 6 deletions reference/6/Microsoft.PowerShell.Management/New-PSDrive.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,12 +142,8 @@ To view the contents from a PowerShell session: `Get-ChildItem -Path MyCompany:`
### Example 4: Create a persistent mapped network drive using credentials

This example maps a network drive that's authenticated with a domain service account's credentials.
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).
For more information about the **PSCredential** object that stores credentials and how passwords are
stored as a **SecureString**, see the **Credential** parameter's description.

```powershell
$cred = Get-Credential -Credential Contoso\ServiceAccount
Expand Down Expand Up @@ -277,6 +273,13 @@ Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCred
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: (All)
Expand Down
17 changes: 12 additions & 5 deletions reference/6/Microsoft.PowerShell.Management/Restart-Computer.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,11 +145,18 @@ Accept wildcard characters: False

### -Credential

Specifies a user account that has permission to do this action. Type a user name, such as User01,
Domain01\User01, or enter a **PSCredential** object generated by the `Get-Credential` cmdlet.
Specifies a user account that has permission to do this action. The default is the current user.

If the **Credential** parameter isn't specified, `Restart-Computer` uses the current user's
credentials.
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 @@ -158,7 +165,7 @@ Aliases:

Required: False
Position: 1
Default value: None
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
18 changes: 14 additions & 4 deletions reference/6/Microsoft.PowerShell.Management/Start-Process.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,19 @@ Accept wildcard characters: False

### -Credential

Specifies a user account that has permission to perform this action. Type a user name, such as
User01 or Domain01\User01, or enter a **PSCredential** object, such as one from the `Get-Credential`
cmdlet. By default, the cmdlet uses the credentials of the current user.
Specifies a user account that has permission to perform this action. By default, the cmdlet uses the
credentials of the current user.

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 @@ -152,7 +162,7 @@ Aliases: RunAs

Required: False
Position: Named
Default value: None
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
16 changes: 12 additions & 4 deletions reference/6/Microsoft.PowerShell.Management/Stop-Computer.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,18 @@ 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 or Domain01\User01, or enter a **PSCredential** object, such as one from 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).

> [!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 @@ -133,7 +141,7 @@ Aliases:

Required: False
Position: 1
Default value: None
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
15 changes: 9 additions & 6 deletions reference/7/Microsoft.PowerShell.Management/New-PSDrive.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,12 +142,8 @@ To view the contents from a PowerShell session: `Get-ChildItem -Path MyCompany:`
### Example 4: Create a persistent mapped network drive using credentials

This example maps a network drive that's authenticated with a domain service account's credentials.
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).
For more information about the **PSCredential** object that stores credentials and how passwords are
stored as a **SecureString**, see the **Credential** parameter's description.

```powershell
$cred = Get-Credential -Credential Contoso\ServiceAccount
Expand Down Expand Up @@ -277,6 +273,13 @@ Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCred
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: (All)
Expand Down
17 changes: 12 additions & 5 deletions reference/7/Microsoft.PowerShell.Management/Restart-Computer.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,11 +145,18 @@ Accept wildcard characters: False

### -Credential

Specifies a user account that has permission to do this action. Type a user name, such as User01,
Domain01\User01, or enter a **PSCredential** object generated by the `Get-Credential` cmdlet.
Specifies a user account that has permission to do this action. The default is the current user.

If the **Credential** parameter isn't specified, `Restart-Computer` uses the current user's
credentials.
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 @@ -158,7 +165,7 @@ Aliases:

Required: False
Position: 1
Default value: None
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
18 changes: 14 additions & 4 deletions reference/7/Microsoft.PowerShell.Management/Start-Process.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,19 @@ Accept wildcard characters: False

### -Credential

Specifies a user account that has permission to perform this action. Type a user name, such as
User01 or Domain01\User01, or enter a **PSCredential** object, such as one from the `Get-Credential`
cmdlet. By default, the cmdlet uses the credentials of the current user.
Specifies a user account that has permission to perform this action. By default, the cmdlet uses the
credentials of the current user.

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 @@ -152,7 +162,7 @@ Aliases: RunAs

Required: False
Position: Named
Default value: None
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
16 changes: 12 additions & 4 deletions reference/7/Microsoft.PowerShell.Management/Stop-Computer.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,18 @@ 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 or Domain01\User01, or enter a **PSCredential** object, such as one from 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).

> [!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 @@ -133,7 +141,7 @@ Aliases:

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