Guide
  1. Cloudlets
  2. Get

Schema

Synopsis

Get a schema.

Syntax

Get-CloudletSchema -CloudletType <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-CloudletSchema -SchemaName <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all Cloudlet schemas or returns a specific schema by its Cloudlet type.

The -CloudletType parameter is translated automatically from the product name, for example, Phased Release, to its API-specific type code, for example, CD.

Parameters

‑AccountSwitchKey
StringPipeline 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.

‑CloudletType
Conditionally required
StringAccepted values: API Prioritization, Application Load Balancer, Audience Segmentation, Edge Redirector, Forward Rewrite, Phased Release, Request Control, Visitor PrioritizationParameter sets: Get allPipeline input: False

The name of the cloudlet type, for example, Phased Release. This is translated to the correct 2- or 3-letter code automatically.

‑EdgeRCFile
StringPipeline input: False

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

‑SchemaName
Conditionally required
StringParameter sets: Get onePipeline input: False

The name of the JSON schema file. JSON schema filenames include:

  • create-policy.json
  • update-policy.json
  • clone-policy.json
  • create-nimbus_policy_version-{cloudletCode}_1.0.json
  • update-nimbus_policy_version-{cloudletCode}_1.0.json
  • match_rule-{cloudletCode}_1.0.json
  • The value for the cloudletCode is either ALB, AP, AS, CD, ER, FR, IG, or VP.
‑Section
StringPipeline input: False

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

Related Links

Updated 10 days ago