Property deactivation
New-PropertyDeactivation
Synopsis
Deactivate a property.
Syntax
New-PropertyDeactivation [-PropertyName] <String> -PropertyVersion <String> -Network <String> [-Note <String>] [-UseFastFallback] -NotifyEmails <Object> [-GroupID <String>] [-ContractId <String>] [-NoncomplianceReason <String>] [-OtherNoncomplianceReason <String>] [-CustomerEmail <String>] [-PeerReviewedBy <String>] [-UnitTested] [-TicketID <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
New-PropertyDeactivation [-PropertyName] <String> -Body <Object> [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
New-PropertyDeactivation -PropertyID <String> -Body <Object> [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
New-PropertyDeactivation -PropertyID <String> -PropertyVersion <String> -Network <String> [-Note <String>] [-UseFastFallback] -NotifyEmails <Object> [-GroupID <String>] [-ContractId <String>] [-NoncomplianceReason <String>] [-OtherNoncomplianceReason <String>] [-CustomerEmail <String>] [-PeerReviewedBy <String>] [-UnitTested] [-TicketID <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Deactivates a specific version of a property from either the staging or production network.
Note: Deactivating a property version is required if you want to delete the property, as no alternate version will take its place, and any hostnames within the property will no longer be served by the Akamai network. If you want to move a hostname from one property to another, add it to the destination property and activate it. The source property will be updated automatically.
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. |
‑Body Conditionally required |
A request body, either as a |
‑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 |
‑CustomerEmail |
The customer email attribute of a |
‑EdgeRCFile |
Your EdgeGrid resource file to authenticate your command. Defaults to |
‑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 |
‑Network Conditionally required |
The network to activate on, either |
‑NoncomplianceReason |
A reason to include in the |
‑Note |
A descriptive message about the activation request. |
‑NotifyEmails Conditionally required |
One or more email addresses to notify when the activation status changes. |
‑OtherNoncomplianceReason |
A free text field to include if the options for the |
‑PeerReviewedBy |
ID of the reviewing user. Generally only used by Akamai internal users. Can be ignored otherwise. |
‑PropertyID Conditionally required |
Your property's ID. Commonly, you only need to specify either |
‑PropertyName Conditionally required |
A human-readable name for your property. Commonly, you only need to specify either |
‑PropertyVersion Conditionally required |
Property's incremental version number. Can be an integer or the word |
‑Section |
The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to |
‑TicketID |
The Siebel ticket ID to include in the |
‑UnitTested |
A switch to indicate unit testing has been carried out. Part of the |
‑UseFastFallback |
After activating a property and finding it causes problems, submitting another activation within one hour with the |
Related Links
Updated 19 days ago