Marco Blessing
b76668c1e7
All checks were successful
continuous-integration/drone/push Build is passing
#### 📖 Summary - `Test-CredentialStoreItem` now returns `$false` and not a terminating error if store doesn't exists. - Updates platyPS generated docs #### 📑 Test Plan > 💡 Select your test plan for the code changes. - [x] Tested via Drone.io pipeline - [ ] Custom test - [ ] No test plan ##### Details / Justification <!-- Add your test details or justification for missing tests here. --> #### 📚 Additional Notes - fixes #50 Co-authored-by: OCram85 <marco.blessing@googlemail.com> Reviewed-on: #66
85 lines
1.7 KiB
Markdown
85 lines
1.7 KiB
Markdown
---
|
|
external help file: ModuleRoot-help.xml
|
|
Module Name: PSCredentialStore
|
|
online version:
|
|
schema: 2.0.0
|
|
---
|
|
|
|
# Get-CredentialStore
|
|
|
|
## SYNOPSIS
|
|
Reads the complete content of the credential store and returns it as a new object.
|
|
|
|
## SYNTAX
|
|
|
|
### Private (Default)
|
|
```
|
|
Get-CredentialStore [<CommonParameters>]
|
|
```
|
|
|
|
### Shared
|
|
```
|
|
Get-CredentialStore [-Path <String>] [-Shared] [<CommonParameters>]
|
|
```
|
|
|
|
## DESCRIPTION
|
|
The content is in a raw format.
|
|
It means there is no transformation to the different credential types.
|
|
You can not use the object properties to connect with remote host.
|
|
Therefore please use
|
|
Get-CredentialStoreItem.
|
|
|
|
## EXAMPLES
|
|
|
|
### EXAMPLE 1
|
|
```
|
|
$CSContent = Get-CredentialStore -Path "C:\TMP\mystore.json"
|
|
```
|
|
|
|
## PARAMETERS
|
|
|
|
### -Path
|
|
Define a custom path to a shared CredentialStore.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: Shared
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -Shared
|
|
Switch to shared mode with this param.
|
|
This enforces the command to work with a shared CredentialStore which
|
|
can be decrypted across systems.
|
|
|
|
```yaml
|
|
Type: SwitchParameter
|
|
Parameter Sets: Shared
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: Named
|
|
Default value: False
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### CommonParameters
|
|
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
|
|
|
|
## INPUTS
|
|
|
|
### [None]
|
|
## OUTPUTS
|
|
|
|
### [PSObject] Returns the credential store content as PSObject.
|
|
## NOTES
|
|
|
|
## RELATED LINKS
|