Marco Blessing
fdc6651588
## About ## Content (Micro Commits) * fixes #38 * fixes #44 * Implement precise lookup hierarchy (fixes #43) * align pester test with #43 logic * split cert functions * use new cert functions for save an lookup * fix pester tests * [wip] * fix var name ref * fix exports * fix cert store location for windows shared mode * fix mandatory params * fix accidentially removed code block * add basic cert pester pests * remove old docs * update cbh blocks * update cbh blocks * update docs * move .net wrapper forpfx files * do not export .net wrapper functions * update docs * rename tests * fix private functions location * - fixes #44: FTP connection * add link to reference * add format files * add preview version shield * update markdown help files (platyps) * add emoji images in captions * fix typos * fix typos * fix typo * prepare version numbers
84 lines
1.9 KiB
Markdown
84 lines
1.9 KiB
Markdown
# 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
|
|
|
|
### BEISPIEL 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
|
|
- File Name : Get-CredentialStore.ps1
|
|
- Author : Marco Blessing - marco.blessing@googlemail.com
|
|
- Requires :
|
|
|
|
## RELATED LINKS
|
|
|
|
[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
|
|
|