CP code
Get-PropertyCPCode
Synopsis
Get or list CP codes.
Syntax
Get-PropertyCPCode [[-CPCodeID] <String>] -GroupId <String> -ContractId <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Gets all CP codes available under a given contract and group. To retrieve a specific CP code, you need to specify its ID. This operation uses the Property API, and thus its output will differ slightly from the Get-CPCode
operation.
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. |
‑CPCodeID |
Your CP code's ID. |
‑ContractId Required |
Your contract's ID. The parameter is optional if a property belongs to only one contract; otherwise, you need to specify it along with the |
‑EdgeRCFile |
Your EdgeGrid resource file to authenticate your command. Defaults to |
‑GroupId Required |
Your group's ID. The parameter is optional if a property belongs to only one group, otherwise you need to specify it along with the |
‑Section |
The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to |
Related Links
Updated 10 days ago