diff --git a/reference/5.1/Microsoft.PowerShell.Security/Get-Credential.md b/reference/5.1/Microsoft.PowerShell.Security/Get-Credential.md index e305aa823134..f6ec2d786d6b 100644 --- a/reference/5.1/Microsoft.PowerShell.Security/Get-Credential.md +++ b/reference/5.1/Microsoft.PowerShell.Security/Get-Credential.md @@ -191,15 +191,21 @@ the remote security message that **Get-Credential** includes in the authenticati ### -Credential -Specifies a user name for the credential, such as "User01" or "Domain01\User01". -The parameter name ("Credential") is optional. +Specifies a user name for the credential, such as **User01** or **Domain01\User01**. The parameter +name, `-Credential`, is optional. -When you submit the command, you will be prompted for a password. +When you submit the command and specify a user name, you're prompted for a password. If you omit +this parameter, you're prompted for a user name and a password. -Starting in Windows PowerShell 3.0, if you enter a user name without a domain, Get-Credential no +Starting in Windows PowerShell 3.0, if you enter a user name without a domain, `Get-Credential` no longer inserts a backslash before the name. -If you omit this parameter, you will be prompted for a user name and 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 Type: PSCredential diff --git a/reference/5.1/Microsoft.PowerShell.Utility/Invoke-RestMethod.md b/reference/5.1/Microsoft.PowerShell.Utility/Invoke-RestMethod.md index a88a49111929..58d7463634e8 100644 --- a/reference/5.1/Microsoft.PowerShell.Utility/Invoke-RestMethod.md +++ b/reference/5.1/Microsoft.PowerShell.Utility/Invoke-RestMethod.md @@ -220,10 +220,17 @@ Accept wildcard characters: False ### -Credential -Specifies a user account that has permission to send the request. -The default is the current user. +Specifies a user account that has permission to send the request. 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. +Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object +generated by the `Get-Credential` cmdlet. + +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 diff --git a/reference/5.1/Microsoft.PowerShell.Utility/Invoke-WebRequest.md b/reference/5.1/Microsoft.PowerShell.Utility/Invoke-WebRequest.md index 5cdb062a98e5..0da87a53e230 100644 --- a/reference/5.1/Microsoft.PowerShell.Utility/Invoke-WebRequest.md +++ b/reference/5.1/Microsoft.PowerShell.Utility/Invoke-WebRequest.md @@ -250,11 +250,18 @@ Accept wildcard characters: False ### -Credential -Specifies a user account that has permission to send the request. -The default is the current user. +Specifies a user account that has permission to send the request. 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. + +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). -Type a user name, such as `User01` or `Domain01\User01`, or enter a **PSCredential** object, -such as one generated by the `Get-Credential` cmdlet. ```yaml Type: PSCredential diff --git a/reference/5.1/Microsoft.PowerShell.Utility/Send-MailMessage.md b/reference/5.1/Microsoft.PowerShell.Utility/Send-MailMessage.md index 77827cd70916..871883bed974 100644 --- a/reference/5.1/Microsoft.PowerShell.Utility/Send-MailMessage.md +++ b/reference/5.1/Microsoft.PowerShell.Utility/Send-MailMessage.md @@ -181,6 +181,13 @@ user. Type a user name, such as **User01** or **Domain01\User01**. Or, enter a **PSCredential** object, such as one from the `Get-Credential` cmdlet. +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) diff --git a/reference/6/Microsoft.PowerShell.Security/Get-Credential.md b/reference/6/Microsoft.PowerShell.Security/Get-Credential.md index afdbd918b693..a7abe2702ff5 100644 --- a/reference/6/Microsoft.PowerShell.Security/Get-Credential.md +++ b/reference/6/Microsoft.PowerShell.Security/Get-Credential.md @@ -190,15 +190,21 @@ the remote security message that **Get-Credential** includes in the authenticati ### -Credential -Specifies a user name for the credential, such as "User01" or "Domain01\User01". -The parameter name ("Credential") is optional. +Specifies a user name for the credential, such as **User01** or **Domain01\User01**. The parameter +name, `-Credential`, is optional. -When you submit the command, you will be prompted for a password. +When you submit the command and specify a user name, you're prompted for a password. If you omit +this parameter, you're prompted for a user name and a password. -Starting in Windows PowerShell 3.0, if you enter a user name without a domain, Get-Credential no +Starting in Windows PowerShell 3.0, if you enter a user name without a domain, `Get-Credential` no longer inserts a backslash before the name. -If you omit this parameter, you will be prompted for a user name and 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 Type: PSCredential diff --git a/reference/6/Microsoft.PowerShell.Utility/Invoke-RestMethod.md b/reference/6/Microsoft.PowerShell.Utility/Invoke-RestMethod.md index 98c1a6dd699f..538e5448267f 100644 --- a/reference/6/Microsoft.PowerShell.Utility/Invoke-RestMethod.md +++ b/reference/6/Microsoft.PowerShell.Utility/Invoke-RestMethod.md @@ -342,13 +342,22 @@ Accept wildcard characters: False ### -Credential -Specifies a user account that has permission to send the request. -The default is the current user. +Specifies a user account that has permission to send the request. 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. -Type a user name, such as "User01", "Domain01\User01", "User01@Domain.com", or enter a `PSCredential` object, such as one generated by the `Get-Credential` cmdlet. +**Credential** can be used alone or in conjunction with certain **Authentication** parameter +options. When used alone, it will only supply credentials to the remote server if the remote server +sends an authentication challenge request. When used with **Authentication** options, the +credentials will be explicitly sent. -**-Credential** can be used alone or in conjunction with certain **-Authentication** options. When used alone, it will only supply credentials to the remote server if the remote server -sends an authentication challenge request. When used with **-Authentication** options, the credentials will be explicitly sent. +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 @@ -357,7 +366,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: Current user Accept pipeline input: False Accept wildcard characters: False ``` @@ -408,10 +417,10 @@ Accept wildcard characters: False ### -FollowRelLink -Indicates the cmdlet should follow relation links. +Indicates the cmdlet should follow relation links. Some REST APIs support pagination via Relation Links per [RFC5988](https://tools.ietf.org/html/rfc5988#page-6). -Instead of parsing the header to get the URL for the next page, you can have the cmdlet do this for you. +Instead of parsing the header to get the URL for the next page, you can have the cmdlet do this for you. To set how many times to follow relation links, use the **MaximumFollowRelLink** parameter. When using this switch, the cmdlet returns a collection of pages of results. diff --git a/reference/6/Microsoft.PowerShell.Utility/Invoke-WebRequest.md b/reference/6/Microsoft.PowerShell.Utility/Invoke-WebRequest.md index eeaa7ae94ce4..b5e0e1f6dbff 100644 --- a/reference/6/Microsoft.PowerShell.Utility/Invoke-WebRequest.md +++ b/reference/6/Microsoft.PowerShell.Utility/Invoke-WebRequest.md @@ -426,13 +426,20 @@ Accept wildcard characters: False Specifies a user account that has permission to send the request. The default is the current user. -Type a user name, such as "User01", "Domain01\User01", "User01@Domain.com", or enter a -`PSCredential` object, such as one generated 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. + +**Credential** can be used alone or in conjunction with certain **Authentication** parameter +options. When used alone, it only supplies credentials to the remote server if the remote server +sends an authentication challenge request. When used with **Authentication** options, the +credentials are explicitly sent. -**Credential** can be used alone or in conjunction with certain **Authentication** options. When -used alone, it only supplies credentials to the remote server if the remote server sends an -authentication challenge request. When used with **Authentication** options, the credentials are -explicitly sent. +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 diff --git a/reference/6/Microsoft.PowerShell.Utility/Send-MailMessage.md b/reference/6/Microsoft.PowerShell.Utility/Send-MailMessage.md index 57254b4961ee..03d0e7aab086 100644 --- a/reference/6/Microsoft.PowerShell.Utility/Send-MailMessage.md +++ b/reference/6/Microsoft.PowerShell.Utility/Send-MailMessage.md @@ -198,6 +198,13 @@ user. Type a user name, such as **User01** or **Domain01\User01**. Or, enter a **PSCredential** object, such as one from the `Get-Credential` cmdlet. +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) diff --git a/reference/7/Microsoft.PowerShell.Security/Get-Credential.md b/reference/7/Microsoft.PowerShell.Security/Get-Credential.md index dec769487bd2..37278e7d3d2a 100644 --- a/reference/7/Microsoft.PowerShell.Security/Get-Credential.md +++ b/reference/7/Microsoft.PowerShell.Security/Get-Credential.md @@ -190,15 +190,21 @@ the remote security message that **Get-Credential** includes in the authenticati ### -Credential -Specifies a user name for the credential, such as "User01" or "Domain01\User01". -The parameter name ("Credential") is optional. +Specifies a user name for the credential, such as **User01** or **Domain01\User01**. The parameter +name, `-Credential`, is optional. -When you submit the command, you will be prompted for a password. +When you submit the command and specify a user name, you're prompted for a password. If you omit +this parameter, you're prompted for a user name and a password. -Starting in Windows PowerShell 3.0, if you enter a user name without a domain, Get-Credential no +Starting in Windows PowerShell 3.0, if you enter a user name without a domain, `Get-Credential` no longer inserts a backslash before the name. -If you omit this parameter, you will be prompted for a user name and 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 Type: PSCredential diff --git a/reference/7/Microsoft.PowerShell.Utility/Invoke-RestMethod.md b/reference/7/Microsoft.PowerShell.Utility/Invoke-RestMethod.md index ce39c44196ad..ed8c6b91f79c 100644 --- a/reference/7/Microsoft.PowerShell.Utility/Invoke-RestMethod.md +++ b/reference/7/Microsoft.PowerShell.Utility/Invoke-RestMethod.md @@ -342,13 +342,22 @@ Accept wildcard characters: False ### -Credential -Specifies a user account that has permission to send the request. -The default is the current user. +Specifies a user account that has permission to send the request. 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. -Type a user name, such as "User01", "Domain01\User01", "User01@Domain.com", or enter a `PSCredential` object, such as one generated by the `Get-Credential` cmdlet. +**Credential** can be used alone or in conjunction with certain **Authentication** parameter +options. When used alone, it will only supply credentials to the remote server if the remote server +sends an authentication challenge request. When used with **Authentication** options, the +credentials will be explicitly sent. -**-Credential** can be used alone or in conjunction with certain **-Authentication** options. When used alone, it will only supply credentials to the remote server if the remote server -sends an authentication challenge request. When used with **-Authentication** options, the credentials will be explicitly sent. +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 @@ -357,7 +366,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: Current user Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/reference/7/Microsoft.PowerShell.Utility/Invoke-WebRequest.md b/reference/7/Microsoft.PowerShell.Utility/Invoke-WebRequest.md index e8aed0bfa597..dd743cd12e57 100644 --- a/reference/7/Microsoft.PowerShell.Utility/Invoke-WebRequest.md +++ b/reference/7/Microsoft.PowerShell.Utility/Invoke-WebRequest.md @@ -426,13 +426,20 @@ Accept wildcard characters: False Specifies a user account that has permission to send the request. The default is the current user. -Type a user name, such as "User01", "Domain01\User01", "User01@Domain.com", or enter a -`PSCredential` object, such as one generated 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. + +**Credential** can be used alone or in conjunction with certain **Authentication** parameter +options. When used alone, it only supplies credentials to the remote server if the remote server +sends an authentication challenge request. When used with **Authentication** options, the +credentials are explicitly sent. -**Credential** can be used alone or in conjunction with certain **Authentication** options. When -used alone, it only supplies credentials to the remote server if the remote server sends an -authentication challenge request. When used with **Authentication** options, the credentials are -explicitly sent. +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 diff --git a/reference/7/Microsoft.PowerShell.Utility/Send-MailMessage.md b/reference/7/Microsoft.PowerShell.Utility/Send-MailMessage.md index 54ebe1b6a27c..ffaf580d77ee 100644 --- a/reference/7/Microsoft.PowerShell.Utility/Send-MailMessage.md +++ b/reference/7/Microsoft.PowerShell.Utility/Send-MailMessage.md @@ -197,6 +197,13 @@ user. Type a user name, such as **User01** or **Domain01\User01**. Or, enter a **PSCredential** object, such as one from the `Get-Credential` cmdlet. +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)