Enrollment

Remove-CPSEnrollment

Synopsis

Remove an enrollment.

Syntax

Remove-CPSEnrollment [-EnrollmentID] <Int32> [-AllowCancelPendingChanges] [[-DeployNotAfter] <String>]
 [[-DeployNotBefore] <String>] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Removes an enrollment from the CPS. The response type will vary depending on the state of the enrollment.

Deleting an enrollment in the future or when the enrollment has a certificate deployed to the network may return HTTP Status 202 (Accepted).

Deleting an enrollment which hasn't deployed a certificate to the network yet will complete immediately and return HTTP Status 200 (OK).

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: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AllowCancelPendingChanges

All pending changes to be cancelled when updating an enrollment.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
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: 1
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: 2
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: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EnrollmentID

Enrollment on which to perform the desired operation.

Type: Int32
Parameter Sets: (All)
Aliases: id

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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: 4
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.Int32

Outputs

System.Object