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 that hasn't deployed a certificate to the network yet will complete immediately and return HTTP Status 200 (OK).
Warning: Impact to Property Behavior
If you delete a certificate enrollment that's linked to a CA set and used in a property hostname, requests to your property may stop working correctly. CPS doesn't currently provide warnings before or after deleting an enrollment.
To avoid unintentionally removing a certificate from a property, delete items in this order:
- Delete the property hostname.
- Remove the
enforceMtlsSettingsbehavior from the property's rule tree.- Delete the CPS enrollment.
- Deactivate the CA set and remove it.
Parameters
‑AccountSwitchKey |
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 |
Cancels all pending changes when updating an enrollment. |
‑DeployNotAfter |
The date (UTC) after which the enrollment shouldn't be deployed. |
‑DeployNotBefore |
The date (UTC) before which the enrollment shouldn't be deployed. |
‑EdgeRCFile |
Your EdgeGrid resource file to authenticate your command. Defaults to |
‑EnrollmentIDRequired |
Enrollment on which to perform the desired operation. |
‑Section |
The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to |
Related Links
Updated 11 days ago