Property deactivation

New-PropertyDeactivation

Synopsis

Deactivate a property.

Syntax

name-attributes (Default)

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>]

name-postbody

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

id-postbody

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

id-attributes

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. The source property will be updated automatically.

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: Named
Default value: None
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: name-postbody, id-postbody
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ContractId

Unique identifier for the contract. 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 create requests.

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

-CustomerEmail

The customer email attribute of a complianceRecord. Generally only used by Akamai internal users.

Type: String
Parameter Sets: name-attributes, id-attributes
Aliases: None
Required: False
Position: Named
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-GroupID

Unique identifier for the group. 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 create requests.

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

-Network

The network to activate on, either STAGING or PRODUCTION.

Type: String
Parameter Sets: name-attributes, id-attributes
Aliases:
Accepted values: Staging, Production

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NoncomplianceReason

Reason to include in the complianceRecord. Generally only used by Akamai internal users. Can be ignored otherwise.

Type: String
Parameter Sets: name-attributes, id-attributes
Aliases:
Accepted values: NONE, OTHER, NO_PRODUCTION_TRAFFIC, EMERGENCY

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Note

A descriptive log comment.

Type: String
Parameter Sets: name-attributes, id-attributes
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NotifyEmails

Email addresses to notify when the activation status changes.

Type: Object
Parameter Sets: name-attributes, id-attributes
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OtherNoncomplianceReason

Free text field to include if the options for NoncomplianceReason are not sufficient. Generally only used by Akamai internal users. Can be ignored otherwise.

Type: String
Parameter Sets: name-attributes, id-attributes
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PeerReviewedBy

ID of the reviewing user. Generally only used by Akamai internal users. Can be ignored otherwise.

Type: String
Parameter Sets: name-attributes, id-attributes
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PropertyID

Unique identifier for the property. Commonly you only need to specify one of: PropertyName, PropertyID.

Type: String
Parameter Sets: id-postbody, id-attributes
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PropertyName

Name of your property. Commonly you only need to specify one of: PropertyName, PropertyID.

Type: String
Parameter Sets: name-attributes, name-postbody
Aliases: None
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PropertyVersion

Property's incremental version number. Can be an integer or the word latest.

Type: String
Parameter Sets: name-attributes, id-attributes
Aliases: None
Required: True
Position: Named
Default value: None
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TicketID

Siebel ticket ID to include in the complianceRecord. Generally only used by Akamai internal users. Can be ignored otherwise.

Type: String
Parameter Sets: name-attributes, id-attributes
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UnitTested

Switch to indicate unit testing has been carried out. Part of the complianceReason and generally only used by Akamai internal users. Can be ignored otherwise.

Type: SwitchParameter
Parameter Sets: name-attributes, id-attributes
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-UseFastFallback

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

Type: SwitchParameter
Parameter Sets: name-attributes, id-attributes
Aliases: None
Required: False
Position: Named
Default value: False
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.Object

Outputs