Guide

Policy

New-CloudletPolicy

Suggest Edits

Synopsis

Create a policy.

Syntax

New-CloudletPolicy -Name <String> [-Description <String>] -GroupID <Int32> -CloudletType <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

New-CloudletPolicy -Name <String> [-Description <String>] -GroupID <Int32> -CloudletType <String> [-Legacy] [-ClonePolicyID <Int32>] [-ClonePolicyVersion <Int32>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Creates a new Cloudlet policy either as a v3 policy (shared) or a legacy policy enabled with the -Legacy switch. You need to specify the -CloudletType parameter as the full product name (for example, Phased Release).

When creating a v2 policy, you also have the option of cloning an existing policy with the -ClonePolicyId and -ClonePolicyVersion parameters.

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.
‑ClonePolicyID
Int Parameter sets: legacy Pipeline input: False

The ID of the policy to clone.
‑ClonePolicyVersion
Int Parameter sets: legacy Pipeline input: False

A version of the policy to clone.
‑CloudletType
Required
String Accepted values: API Prioritization, Application Load Balancer, Audience Segmentation, Edge Redirector, Forward Rewrite, Phased Release, Request Control, Visitor Prioritization Pipeline input: False

The name of the cloudlet type, for example, Phased Release. This is translated to the correct 2- or 3-letter code automatically.
‑Description
String Pipeline input: False

A description to include.
‑EdgeRCFile
String Pipeline input: False

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

Your group's ID.
‑Legacy
Switch Parameter sets: legacy Pipeline input: False

If present, this indicates that your policy is legacy (v2). Without this switch, v3 of the Cloudlets API is used.
‑Name
Required
String Pipeline input: False

Your policy's name.
‑Section
String Pipeline input: False

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

Related Links

Updated 18 days ago