Guide

Include deactivation

New-PropertyIncludeDeactivation

Suggest Edits

Synopsis

Deactivate an include.

Syntax

New-PropertyIncludeDeactivation [-IncludeName] <String> -IncludeVersion <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-PropertyIncludeDeactivation [-IncludeName] <String> -Body <Object> [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

New-PropertyIncludeDeactivation -IncludeID <String> -Body <Object> [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

New-PropertyIncludeDeactivation -IncludeID <String> -IncludeVersion <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 include from either the staging or production network. Deactivating an include will cause its rules to no longer apply if referenced in a parent property. You also need to run this operation before deleting the property include.

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.
‑Body
Conditionally required
Object Parameter sets: id-postbody, name-postbody Pipeline input: ByValue

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

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.
‑CustomerEmail
String Parameter sets: id-attributes, name-attributes Pipeline input: False

The customer email attribute of a complianceRecord. Generally, only used by Akamai internal users.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑GroupID
String Pipeline input: False

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.
‑IncludeID
Conditionally required
String Parameter sets: id-postbody, id-attributes Pipeline input: False

Your include's ID. Commonly, you only need to specify either -IncludeName or -IncludeID.
‑IncludeName
Conditionally required
String Parameter sets: name-postbody, name-attributes Pipeline input: False

A human-readable name of your property include.
‑IncludeVersion
Conditionally required
String Parameter sets: id-attributes, name-attributes Pipeline input: False

Your include's incremental version number. Can be an integer or the word latest.
‑Network
Conditionally required
String Accepted values: Staging, Production Parameter sets: id-attributes, name-attributes Pipeline input: False

The network to activate on, either STAGING or PRODUCTION.
‑NoncomplianceReason
String Accepted values: NONE, OTHER, NO_PRODUCTION_TRAFFIC, EMERGENCY Parameter sets: id-attributes, name-attributes Pipeline input: False

A reason to include in the complianceRecord. Generally, only used by Akamai internal users. Otherwise, can be ignored.
‑Note
String Parameter sets: id-attributes, name-attributes Pipeline input: False

A descriptive message about the activation request.
‑NotifyEmails
Conditionally required
Object Parameter sets: id-attributes, name-attributes Pipeline input: False

One or more email addresses to notify when the activation status changes.
‑OtherNoncomplianceReason
String Parameter sets: id-attributes, name-attributes Pipeline input: False

A free text field to include if the options for the -NoncomplianceReason aren't sufficient. Generally, only used by Akamai internal users. Otherwise, can be ignored.
‑PeerReviewedBy
String Parameter sets: id-attributes, name-attributes Pipeline input: False

ID of the reviewing user. Generally only used by Akamai internal users. Can be ignored otherwise.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑TicketID
String Parameter sets: id-attributes, name-attributes Pipeline input: False

The Siebel ticket ID to include in the complianceRecord. Generally, only used by Akamai internal users. Otherwise, can be ignored.
‑UnitTested
Switch Parameter sets: id-attributes, name-attributes Pipeline input: False

A switch to indicate unit testing has been carried out. Part of the complianceReason and generally only used by Akamai internal users. Otherwise, can be ignored.
‑UseFastFallback
Switch Parameter sets: id-attributes, name-attributes Pipeline input: False

After activating a property and finding it causes problems, submitting another activation within one hour with the -UseFastFallback enabled quickly rolls back to the previous version. This option is only available for activations where canFastFallback is true.

Related Links

Updated 4 months ago