CP code

Get-CPCode

Synopsis

Get a CP code.

Syntax

Get-CPCode [-ContractID <String>] [-GroupID <String>] [-ProductID <String>] [-Name <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-CPCode -CPCodeID <Int32> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all CP codes or returns a specific CP code by its ID available within your account and contract.

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
Conditionally required

Your CP code's ID.

‑ContractID

The ID of the contract to filter data by. Include this optional parameter to narrow down the results to a specific contract only.

‑EdgeRCFile

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

‑GroupID

The ID of the access group to filter data by. Include this optional parameter to narrow down the results to a specific access group only.

‑Name

The name of the CP code to filter data by. Include this optional parameter to narrow down the results to a specific CP code name only.

‑ProductID

Identifies the product or service to filter data by. Include this optional parameter to narrow down the results to a specific product only.

‑Section

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

Related Links