Guide

Enrollment

New-CPSEnrollment

Suggest Edits

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
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.
‑AllowDuplicateCN
Switch Pipeline input: False

Allows the enrollment to be created, even if a common name exists in a certificate on the alternative network (Standard or Enhanced TLS).
‑Body
Required
Object Pipeline input: ByValue

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑ContractID
Required
String Pipeline input: False

Your contract's ID.
‑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.
‑Section
String Pipeline input: False

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

Related Links

Updated 16 days ago