Skip to content

Commit 176c411

Browse files
Update Register-PSResourceRepository.md - Example 4 (#225)
* Update Register-PSResourceRepository.md - Example 4 Provide a little more information around example 4. From my reading here it wasn't clear anywhere that the secret must be stored as a PSCredential object and expected Find-PSResource to use the name of the secret and the value of the secret as username/password. This wasn't the case. * Update Register-PSResourceRepository.md - Adhere to contrib guide Improve contrib guide adherance * Update Register-PSResourceRepository.md Edit for style --------- Co-authored-by: Sean Wheeler <[email protected]>
1 parent 3367f26 commit 176c411

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

powershell-gallery/powershellget-3.x/Microsoft.PowerShell.PSResourceGet/Register-PSResourceRepository.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,16 @@ PSGv3 https://www.powershellgallery.com/api/v3 True 50
115115
### Example 4
116116

117117
This example registers a repository with credential information to be retrieved from a registered
118-
**SecretManagement** vault. You must have the **Microsoft.PowerShell.SecretManagement** module
119-
installed and have a registered vault containing the stored secret. The format of the secret must
120-
match the requirements of the repository.
118+
**SecretManagement** vault, where **SecretStore** is the name of the vault and **TestSecret** is the
119+
name of the stored secret.
120+
121+
You must have the **Microsoft.PowerShell.SecretManagement** module installed, have a registered
122+
vault, and stored a secret within it. If setup correctly, the command
123+
`Get-SecretInfo -Name 'TestSecret'` would return the secret.
124+
125+
The format of the secret must match the requirements of the repository. In some instances,
126+
`TestSecret` might need storing as a **PSCredential** object with a username and password or token.
127+
In others it may need storing as a **SecureString** representing just the token.
121128

122129
```powershell
123130
$parameters = @{

0 commit comments

Comments
 (0)