forked from OCram85/PSCredentialStore
Marco Blessing
b76668c1e7
#### 📖 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: OCram85/PSCredentialStore#66
73 lines
1.4 KiB
Markdown
73 lines
1.4 KiB
Markdown
---
|
|
external help file: ModuleRoot-help.xml
|
|
Module Name: PSCredentialStore
|
|
online version:
|
|
schema: 2.0.0
|
|
---
|
|
|
|
# Get-CSCertificate
|
|
|
|
## SYNOPSIS
|
|
Returns the current used valid PfX certificate.
|
|
|
|
## SYNTAX
|
|
|
|
```
|
|
Get-CSCertificate [-Type] <String> [-Thumbprint] <String> [<CommonParameters>]
|
|
```
|
|
|
|
## DESCRIPTION
|
|
Use this function to get the available pfx certificate respecting the config hierarchy.
|
|
|
|
## EXAMPLES
|
|
|
|
### EXAMPLE 1
|
|
```
|
|
Get-CSCertificate -Type 'Shared' -Thumbprint '12334456'
|
|
```
|
|
|
|
## PARAMETERS
|
|
|
|
### -Thumbprint
|
|
Provide the credentials thumbprint for the search.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: 2
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -Type
|
|
Select the current credential store type.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: 1
|
|
Default value: None
|
|
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
|
|
|
|
### [System.Security.Cryptography.X509Certificates.X509Certificate2]
|
|
## NOTES
|
|
|
|
## RELATED LINKS
|