PSCredentialStore/docs/Get-CSPfxCertificate.md

96 lines
2.1 KiB
Markdown
Raw Normal View History

2019-04-08 13:12:15 +02:00
---
external help file: PSCredentialStore-help.xml
Module Name: PSCredentialStore
online version: https://github.com/OCram85/PSCredentialStore
schema: 2.0.0
---
# Get-CSPfxCertificate
## SYNOPSIS
Returns the certificate object given by thumbprint.
## SYNTAX
```
Get-CSPfxCertificate [-Thumbprint] <String[]> [[-StoreName] <String>] [[-StoreLocation] <String>]
[<CommonParameters>]
```
## DESCRIPTION
You can use this function to get a stored certificate.
Search for the object by its unique thumbprint.
## EXAMPLES
### BEISPIEL 1
```
Get-CSPfxCertificate -Thumbprint '12345678' -StoreName 'My' -StoreLocation 'CurrentUser'
```
## PARAMETERS
### -Thumbprint
Provide one or more thumbprints.
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```
### -StoreName
Select the store name in which you want to search the certificates.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: My
Accept pipeline input: False
Accept wildcard characters: False
```
### -StoreLocation
Select between the both available locations CurrentUser odr LocalMachine.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: CurrentUser
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
### [string]
## OUTPUTS
### [System.Security.Cryptography.X509Certificates.X509Certificate2[]]
## NOTES
- File Name : Get-CSPfxCertificate.ps1
- Author : Marco Blessing - marco.blessing@googlemail.com
- Requires :
## RELATED LINKS
[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)