Guide

Enrollment

Get-CPSEnrollment

Suggest Edits

Synopsis

Get an enrollment.

Syntax

Get-CPSEnrollment [-ContractID <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-CPSEnrollment [-EnrollmentID <Int32>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all CPS enrollments or returns a specific enrollment by its ID.

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

Your contract's ID.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑EnrollmentID
Int Parameter sets: single Pipeline input: False

Enrollment on which to perform the desired operation.
‑Section
String Pipeline input: False

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

Related Links

Updated about 1 month ago