Enrollment

Set-CPSEnrollment

Synopsis

Update an enrollment.

Syntax

Set-CPSEnrollment [-EnrollmentID] <Int32> [-Body] <Object> [-AllowCancelPendingChanges] [-AllowStagingBypass]
 [[-DeployNotAfter] <String>] [[-DeployNotBefore] <String>] [-ForceRenewal] [-RenewalDateCheckOverride]
 [-AllowMissingCertificateAddition] [[-EdgeRCFile] <String>] [[-Section] <String>]
 [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates an enrollment with changes.

Note: The request body for this function can be quite complex, therefore, it's recommended that you retrieve the existing enrollment with the Get-CPSEnrollment operation, make your changes locally, then 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

-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

-AllowMissingCertificateAddition

Applicable for Third Party Dual Stack Enrollments, allows to update missing certificate.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AllowStagingBypass

Bypass staging and push meta-data updates directly to production network. The current change will also be updated with the same changes.

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

-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

-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)
Accept wildcard characters: False

-ForceRenewal

Force certificate renewal for an enrollment.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-RenewalDateCheckOverride

CPS will automatically start a change to renew certificates in time before they expire. This automatic change is started when the certificate's expiration is within a renewal window, and system will protect against other changes started during this renewal window.

Setting renewal-date-check-override=true will allow creating a change during the renewal window, potentially running the risk of ending up with an expired certificate on the network.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
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.Int32

System.Object

Outputs