PSCredentialStore/docs/New-CSCertificate.md
Marco Blessing e3404666d4 update references (#60)
#### 📖 Summary

- Replace all github refs with gitea url

#### 📑 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

<!-- A place for additional detail notes. -->

Co-authored-by: OCram85 <marco.blessing@googlemail.com>
Reviewed-on: OCram85/PSCredentialStore#60
2022-07-13 08:34:31 +02:00

2.5 KiB

external help file Module Name schema
PSCredentialStore-help.xml PSCredentialStore 2.0.0

New-CSCertificate

SYNOPSIS

Creates a new PFX certificate for the CredentialStore encryption.

SYNTAX

New-CSCertificate [-CRTAttribute] <Object> [[-KeyName] <String>] [[-CertName] <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Use this function to create a custom self signed certificate used by the PSCredentialStore module.

EXAMPLES

EXAMPLE 1

New-CSCertificate -CRTAttribute $CRTAttribute -KeyName './myprivate.key' -CertName './mycert.pfx'

PARAMETERS

-CertName

Provide a custom full path and name for the PFX certificate file. The file extension has to be `*.pfx`

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: ./certificate.pfx
Accept pipeline input: False
Accept wildcard characters: False

-CRTAttribute

Provide certificate related attributes provided by function New-CRTAttribute.

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-KeyName

Provide a custom full path and name for the private key. The file extension has to be `*.key`.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: ./private.key
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

INPUTS

[PSCredentialStore.Certificate.Attribute]

OUTPUTS

[None]

NOTES