Property activation

Undo-PropertyActivation

Synopsis

Cancel a property's pending activation.

Syntax

Undo-PropertyActivation [-PropertyName] <String> -ActivationId <String> [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Undo-PropertyActivation -PropertyID <String> -ActivationId <String> [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

If you detect a problem with a property version while its activation is still PENDING, use this operation to cancel it.

You can retrieve the required ActivationID from the response of the New-PropertyActivation, New-PropertyDeactivation, or Get-PropertyActivation operation.

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.

‑ActivationId
Required

The ID of your property or include activation.

‑ContractId

Your contract's ID. The parameter is optional if a property belongs to only one contract; otherwise, you need to specify it along with the -GroupID. This parameter is optional except for the create requests.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑GroupID

Your group's ID. The parameter is optional if a property belongs to only one group, otherwise you need to specify it along with the -ContractID. This parameter is optional except for the create requests.

‑PropertyID
Conditionally required

Your property's ID. Commonly, you only need to specify either -PropertyName or -PropertyID.

‑PropertyName
Conditionally required

A human-readable name for your property. Commonly, you only need to specify either -PropertyName or -PropertyID.

‑Section

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

Related Links