From e122c33489e47732a0880b01b2a2b1749783411e Mon Sep 17 00:00:00 2001 From: davidsmatlak Date: Wed, 30 Oct 2019 16:35:37 -0700 Subject: [PATCH] updated credential parameter --- .../Invoke-Command.md | 11 ++++++-- .../Microsoft.PowerShell.Core/Save-Help.md | 26 ++++++++++++++----- .../Microsoft.PowerShell.Core/Start-Job.md | 12 +++++++-- .../Microsoft.PowerShell.Core/Update-Help.md | 13 +++++++++- .../Invoke-Command.md | 11 ++++++-- .../6/Microsoft.PowerShell.Core/Save-Help.md | 26 ++++++++++++++----- .../6/Microsoft.PowerShell.Core/Start-Job.md | 12 +++++++-- .../Microsoft.PowerShell.Core/Update-Help.md | 13 +++++++++- .../Invoke-Command.md | 11 ++++++-- .../7/Microsoft.PowerShell.Core/Save-Help.md | 26 ++++++++++++++----- .../7/Microsoft.PowerShell.Core/Start-Job.md | 12 +++++++-- .../Microsoft.PowerShell.Core/Update-Help.md | 13 +++++++++- 12 files changed, 153 insertions(+), 33 deletions(-) diff --git a/reference/5.1/Microsoft.PowerShell.Core/Invoke-Command.md b/reference/5.1/Microsoft.PowerShell.Core/Invoke-Command.md index 20a63ffc34c8..8a575d200510 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/Invoke-Command.md +++ b/reference/5.1/Microsoft.PowerShell.Core/Invoke-Command.md @@ -908,10 +908,17 @@ Accept wildcard characters: False 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 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 Accept pipeline input: True (ByPropertyName) Position: Named diff --git a/reference/5.1/Microsoft.PowerShell.Core/Save-Help.md b/reference/5.1/Microsoft.PowerShell.Core/Save-Help.md index 5758c999096c..4faf08b8c64f 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/Save-Help.md +++ b/reference/5.1/Microsoft.PowerShell.Core/Save-Help.md @@ -174,12 +174,26 @@ The *Force* parameter is required when you have to run a **Save-Help** command m ### -Credential -Specifies a user credential. -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. -This parameter is valid only when the *DestinationPath* or *LiteralPath* parameter is used in the command. - -This parameter enables you to run **Save-Help** commands that use the *DestinationPath* parameter on remote computers. -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. +Specifies a user credential. 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. This +parameter is valid only when the **DestinationPath** or **LiteralPath** parameter is used in the +command. + +This parameter enables you to run `Save-Help` commands that use the **DestinationPath** parameter on +remote computers. 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. + +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 diff --git a/reference/5.1/Microsoft.PowerShell.Core/Start-Job.md b/reference/5.1/Microsoft.PowerShell.Core/Start-Job.md index 639d82e9782a..312416baed59 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/Start-Job.md +++ b/reference/5.1/Microsoft.PowerShell.Core/Start-Job.md @@ -275,8 +275,16 @@ Accept wildcard characters: False Specifies a user account that has permission to perform this action. If the **Credential** parameter isn't specified, the command uses the current user's credentials. -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 diff --git a/reference/5.1/Microsoft.PowerShell.Core/Update-Help.md b/reference/5.1/Microsoft.PowerShell.Core/Update-Help.md index 2213f1a15599..16eeb371445c 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/Update-Help.md +++ b/reference/5.1/Microsoft.PowerShell.Core/Update-Help.md @@ -287,6 +287,17 @@ parameter on remote computers. By providing explicit credentials, you can run th remote computer and access a file share on a third computer without encountering an access denied error or using CredSSP authentication to delegate 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 Parameter Sets: (All) @@ -294,7 +305,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/6/Microsoft.PowerShell.Core/Invoke-Command.md b/reference/6/Microsoft.PowerShell.Core/Invoke-Command.md index ae8d0b8b2f6f..120c6b35270c 100644 --- a/reference/6/Microsoft.PowerShell.Core/Invoke-Command.md +++ b/reference/6/Microsoft.PowerShell.Core/Invoke-Command.md @@ -986,10 +986,17 @@ Accept wildcard characters: False 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 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 Accept pipeline input: True (ByPropertyName) Position: Named diff --git a/reference/6/Microsoft.PowerShell.Core/Save-Help.md b/reference/6/Microsoft.PowerShell.Core/Save-Help.md index fa5f14634301..9d006cb7ee2b 100644 --- a/reference/6/Microsoft.PowerShell.Core/Save-Help.md +++ b/reference/6/Microsoft.PowerShell.Core/Save-Help.md @@ -174,12 +174,26 @@ The *Force* parameter is required when you have to run a **Save-Help** command m ### -Credential -Specifies a user credential. -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. -This parameter is valid only when the *DestinationPath* or *LiteralPath* parameter is used in the command. - -This parameter enables you to run **Save-Help** commands that use the *DestinationPath* parameter on remote computers. -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. +Specifies a user credential. 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. This +parameter is valid only when the **DestinationPath** or **LiteralPath** parameter is used in the +command. + +This parameter enables you to run `Save-Help` commands that use the **DestinationPath** parameter on +remote computers. 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. + +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 diff --git a/reference/6/Microsoft.PowerShell.Core/Start-Job.md b/reference/6/Microsoft.PowerShell.Core/Start-Job.md index 333c80fcd504..815c1c3a9e3e 100644 --- a/reference/6/Microsoft.PowerShell.Core/Start-Job.md +++ b/reference/6/Microsoft.PowerShell.Core/Start-Job.md @@ -315,8 +315,16 @@ Accept wildcard characters: False Specifies a user account that has permission to perform this action. If the **Credential** parameter isn't specified, the command uses the current user's credentials. -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 diff --git a/reference/6/Microsoft.PowerShell.Core/Update-Help.md b/reference/6/Microsoft.PowerShell.Core/Update-Help.md index 8ceaa6a8055b..0d5d0b5aca0b 100644 --- a/reference/6/Microsoft.PowerShell.Core/Update-Help.md +++ b/reference/6/Microsoft.PowerShell.Core/Update-Help.md @@ -247,6 +247,17 @@ parameter on remote computers. By providing explicit credentials, you can run th remote computer and access a file share on a third computer without encountering an access denied error or using CredSSP authentication to delegate 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 Parameter Sets: (All) @@ -254,7 +265,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.Core/Invoke-Command.md b/reference/7/Microsoft.PowerShell.Core/Invoke-Command.md index ad6355d86125..47691f71d640 100644 --- a/reference/7/Microsoft.PowerShell.Core/Invoke-Command.md +++ b/reference/7/Microsoft.PowerShell.Core/Invoke-Command.md @@ -986,10 +986,17 @@ Accept wildcard characters: False 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 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 Accept pipeline input: True (ByPropertyName) Position: Named diff --git a/reference/7/Microsoft.PowerShell.Core/Save-Help.md b/reference/7/Microsoft.PowerShell.Core/Save-Help.md index 1262909fc8f6..266ce33f9784 100644 --- a/reference/7/Microsoft.PowerShell.Core/Save-Help.md +++ b/reference/7/Microsoft.PowerShell.Core/Save-Help.md @@ -174,12 +174,26 @@ The *Force* parameter is required when you have to run a **Save-Help** command m ### -Credential -Specifies a user credential. -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. -This parameter is valid only when the *DestinationPath* or *LiteralPath* parameter is used in the command. - -This parameter enables you to run **Save-Help** commands that use the *DestinationPath* parameter on remote computers. -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. +Specifies a user credential. 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. This +parameter is valid only when the **DestinationPath** or **LiteralPath** parameter is used in the +command. + +This parameter enables you to run `Save-Help` commands that use the **DestinationPath** parameter on +remote computers. 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. + +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 diff --git a/reference/7/Microsoft.PowerShell.Core/Start-Job.md b/reference/7/Microsoft.PowerShell.Core/Start-Job.md index 24b072d25a3e..c0d4da277254 100644 --- a/reference/7/Microsoft.PowerShell.Core/Start-Job.md +++ b/reference/7/Microsoft.PowerShell.Core/Start-Job.md @@ -340,8 +340,16 @@ Accept wildcard characters: False Specifies a user account that has permission to perform this action. If the **Credential** parameter isn't specified, the command uses the current user's credentials. -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 diff --git a/reference/7/Microsoft.PowerShell.Core/Update-Help.md b/reference/7/Microsoft.PowerShell.Core/Update-Help.md index 6efd3c842afc..ef08b256ec08 100644 --- a/reference/7/Microsoft.PowerShell.Core/Update-Help.md +++ b/reference/7/Microsoft.PowerShell.Core/Update-Help.md @@ -247,6 +247,17 @@ parameter on remote computers. By providing explicit credentials, you can run th remote computer and access a file share on a third computer without encountering an access denied error or using CredSSP authentication to delegate 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 Parameter Sets: (All) @@ -254,7 +265,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: Current user Accept pipeline input: False Accept wildcard characters: False ```