Rule format schema

Get-RuleFormatSchema

Synopsis

Get a schema for a rule format.

Syntax

Get-RuleFormatSchema [-ProductID] <String> [-RuleFormat] <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets the JSON schema for the given product and rule format, which you can use to validate a rule tree object.

Note that your rule tree may still fail to activate if you specify features that are optional within the schema for a product but not currently supported on your contract.

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.

‑EdgeRCFile

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

‑ProductID
Required

The product's ID.

‑RuleFormat
Required

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

‑Section

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

Related Links