Property rules

Get-PropertyRules

Synopsis

Get a property's rule tree.

Syntax

name (Default)

Get-PropertyRules [-PropertyName] <String> [-PropertyVersion] <String> [-GroupID <String>]
 [-ContractId <String>] [-RuleFormat <String>] [-OriginalInput] [-OutputToFile] [-OutputFileName <String>]
 [-OutputSnippets] [-OutputDirectory <String>] [-MaxDepth <Int32>] [-ForceSlashStyle <String>]
 [-PathFromMainJson] [-Force] [-PassThru] [-EdgeRCFile <String>] [-Section <String>]
 [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

id

Get-PropertyRules -PropertyID <String> [-PropertyVersion] <String> [-GroupID <String>] [-ContractId <String>]
 [-RuleFormat <String>] [-OriginalInput] [-OutputToFile] [-OutputFileName <String>] [-OutputSnippets]
 [-OutputDirectory <String>] [-MaxDepth <Int32>] [-ForceSlashStyle <String>] [-PathFromMainJson] [-Force]
 [-PassThru] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Retrieves the rules for a given property version. You can specify the rules' output as either:

A PSCustomObject.
A single JSON file (with the -OutputToFile parameter and optionally the -OutputFilename parameter).
Broken out into JSON snippets (with the -OutputSnippets parameter and optionally the -OutputDirectory parameter).

You can also specify the -RuleFormat to retrieve your property rules in a specific schema version. Multiple output formats can now be used in the same command and are no longer mutually-exclusive.

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

-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

-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

-Force

Overwrite a local file or files if they exist. If files exist and this is not specified, an error will be thrown.

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

-ForceSlashStyle

Override the mechanism to detect your operating system and choose appropriate slashes in file paths (\ for Windows, / for *nix). Use this if collaborating with users across different operating systems.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Windows, Unix

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

-MaxDepth

By default, rules will be exported into nested folders as deeply as the rule tree specifies. This option allows you to specify how deep you want to iterate the rule extraction.

Note: Rules below your max depth will simply be included in the JSON file of their parent.

All rules are exported in ALL cases.

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

-OriginalInput

When present, PAPI outputs a property's rule tree in the original form provided by Set-PropertyRules, deliberately suppressing any updates.

When present, PAPI still upgrades catalog features in the background each time you run Get-PropertyRules and Add-PropertyRules operations on property version rules, but the response yields the rule tree just as you last saved it.

The parameter defaults to false, which means your original input can include latest rule changes, such as new options with default values.

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

-OutputDirectory

Directory to store JSON snippets from the retrieved rule tree.

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

-OutputFileName

JSON filename to save the retrieved rule tree.

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

-OutputSnippets

Output rule tree as JSON snippets.

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

-OutputToFile

Output rule tree as a single JSON file.

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

-PassThru

When writing rules to one or more files, use this switch to also return the rules as a PSCustomObject.

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

-PathFromMainJson

This option will use paths relative to the main JSON file, rather than purely relative to each file. This allows compatibility with the Akamai Terraform provider and other tools, which use this path style.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
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
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
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: (All)
Aliases: None
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RuleFormat

Name of the rule format. The rule format can be frozen to a specific version, or represent the latest set of behaviors and criteria. Rule formats can be retrieved with Get-RuleFormat.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
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

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

None

Outputs

System.Object