Policy
Set-CloudletPolicy
Synopsis
Update a policy.
Syntax
Set-CloudletPolicy -PolicyID <Int32> [-Legacy] -GroupID <Int32> [-Description <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Set-CloudletPolicy -PolicyID <Int32> [-Legacy] [-Name <String>] [-GroupID <Int32>] [-Description <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Set-CloudletPolicy -PolicyID <Int32> [-Legacy] -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Updates an existing policy. Use the -Legacy
switch to specify v2 policies; otherwise, this command will apply only to v3 policies. For both types of policies, you can update the policy's description and move it to a new group by its ID. For v2 policies, you can also update the policy's name.
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. |
‑Body Conditionally required |
A request body, either as a |
‑Description |
A description to include. |
‑EdgeRCFile |
Your EdgeGrid resource file to authenticate your command. Defaults to |
‑GroupID Conditionally required |
Your group's ID. |
‑Legacy |
If present, this indicates that your policy is legacy (v2). Without this switch, v3 of the Cloudlets API is used. |
‑Name |
Your policy's name. |
‑PolicyID Required |
Your cloudlet policy's ID. |
‑Section |
The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to |
Related Links
Updated 6 days ago