Policy

Get-CloudletPolicy

Synopsis

Get a policy.

Syntax

Get-CloudletPolicy [-Legacy] [-Page <String>] [-Size <Int32>] [-GroupID <Int32>] [-IncludeDeleted] [-CloudletID <String>] [-All] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-CloudletPolicy [-PolicyID <Int32>] [-Legacy] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all Cloudlet policies or returns a specific policy by its ID. When listing all policies, you can control paging with the -Page and -Size parameters. When listing v2 policies, you can additionally limit them by group ID or Cloudlet ID and include deleted policies with the -IncludeDeleted parameter.

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.

‑All

Following paging links until exhausted, returning all policies.

‑CloudletID

For GET operations, returns only policies for this particular -CloudletIF. The -CloudletID for: Edge Redirector is 0, Visitor Prioritization is 1, Forward Rewrite is 3, Request Control is 4, API Prioritization is 5, Audience Segmentation is 6, Phased Release is 7 and Application Load Balancer is 9.

‑EdgeRCFile

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

‑GroupID

Your group's ID.

‑IncludeDeleted

For GET operations, if present, this includes deleted policies in the results.

‑Legacy

If present, this indicates that your policy is legacy (v2). Without this switch, v3 of the Cloudlets API is used.

‑Page

Specifies a page number for batched results, starting at zero.

‑PolicyID

Your cloudlet policy's ID.

‑Section

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

‑Size

Specifies the number of objects on a page, at least 10 objects if using Shared. Otherwise the minimum is 1.

Related Links