Guide

CP code

Get-CPCode

Suggest Edits

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
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.
‑CPCodeID
Conditionally required
Int Parameter sets: single Pipeline input: False

Your CP code's ID.
‑ContractID
String Parameter sets: all Pipeline input: False

The ID of the contract to filter data by. Include this optional parameter to narrow down the results to a specific contract only.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑GroupID
String Parameter sets: all Pipeline input: False

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
String Parameter sets: all Pipeline input: False

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
String Parameter sets: all Pipeline input: False

Identifies the product or service to filter data by. Include this optional parameter to narrow down the results to a specific product only.
‑Section
String Pipeline input: False

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

Related Links

Updated 3 days ago