Guide

Enrollment

Remove-CPSEnrollment

Suggest Edits

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 that hasn't deployed a certificate to the network yet will complete immediately and return HTTP Status 200 (OK).

Parameters

‑AccountSwitchKey
String Pipeline input: False

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.
‑AllowCancelPendingChanges
Switch Pipeline input: False

Cancels all pending changes when updating an enrollment.
‑DeployNotAfter
String Pipeline input: False

The date (UTC) after which the enrollment shouldn't be deployed.
‑DeployNotBefore
String Pipeline input: False

The date (UTC) before which the enrollment shouldn't be deployed.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑EnrollmentID
Required
Int Pipeline input: ByValue, ByPropertyName

Enrollment on which to perform the desired operation.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links

Updated about 4 hours ago