Enrollment
New-CPSEnrollment
Synopsis
Create an enrollment.
Syntax
New-CPSEnrollment [-ContractID] <String> [-Body] <Object> [[-DeployNotAfter] <String>]
[[-DeployNotBefore] <String>] [-AllowDuplicateCN] [[-EdgeRCFile] <String>] [[-Section] <String>]
[[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Creates a new certificate enrollment.
Note: The request body for this function can be quite complex, therefore, it's recommended, where possible, that you retrieve an existing enrollment, edit it locally, and pipe the object to this function.
Parameters
-AccountSwitchKey
Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account switch keys can be found using Get-AccountSwitchKey
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AllowDuplicateCN
Allow the enrollment to be created, even if the Common Name exists in a certificate on the alternative network (Standard or Enhanced TLS).
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Body
Request body, either as a PSCustomObject
or string. This parameter supports pipelining.
Type: Object
Parameter Sets: (All)
Aliases: None
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-ContractID
Specify the contract on which to operate or view.
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DeployNotAfter
Don't deploy after this date (UTC).
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DeployNotBefore
Don't deploy before this date (UTC).
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EdgeRCFile
EdgeRC file to authenticate your command. Defaults to ~/.edgerc
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Section
EdgeRC section to retrieve authentication credentials from. Defaults to default
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 5
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
System.Object
Outputs
System.Object
Related links
Updated 9 days ago