Guide

Active properties

Get-CloudletPolicyProperty

Suggest Edits

Synopsis

Get active properties.

Syntax

Get-CloudletPolicyProperty -PolicyID <Int32> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-CloudletPolicyProperty -PolicyID <Int32> [-Legacy] [-Size <Int32>] [-Page <Int32>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all active properties that are using the specified policy. Use the -Legacy switch to specify v2 policies; otherwise, the command will search only for v3 (shared) policies.

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.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑Legacy
Switch Parameter sets: shared Pipeline input: False

If present, this indicates that your policy is legacy (v2). Without this switch, v3 of the Cloudlets API is used.
‑Page
Int Parameter sets: shared Pipeline input: False

Specifies a page number for batched results, starting at zero.
‑PolicyID
Required
Int Pipeline input: False

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

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑Size
Int Parameter sets: shared Pipeline input: False

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

Related Links

Updated about 1 month ago