PSCredentialStore/docs/Use-CSCertificate.md
Marco Blessing b76668c1e7 fix Test-CredentialStoreItem return (#66)
#### 📖 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
2022-07-19 11:46:21 +02:00

2.0 KiB

external help file Module Name online version schema
ModuleRoot-help.xml PSCredentialStore 2.0.0

Use-CSCertificate

SYNOPSIS

Links an existing PFX Certificate to a CredentialStore.

SYNTAX

Private (Default)

Use-CSCertificate -Path <String> [-UseCertStore] [<CommonParameters>]

Shared

Use-CSCertificate -Path <String> [-CredentialStore <String>] [-Shared] [-UseCertStore] [<CommonParameters>]

DESCRIPTION

Linking a certificate is needed if you plan to use the same CredentialStore in cross platform scenarios.

EXAMPLES

EXAMPLE 1

Use-CSCertificate -Path 'C:\cert.pfx'

PARAMETERS

-CredentialStore

Specify a custom path for a shared credential store.

Type: String
Parameter Sets: Shared
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Path

Specify the path to the PFX Certificate you want to link for usage.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Shared

Use the credential store in shared mode.

Type: SwitchParameter
Parameter Sets: Shared
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-UseCertStore

Use the given certificate and import it into the corresponding certificate store.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
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.

INPUTS

[None]

OUTPUTS

[None]

NOTES