Guide

Activation

Get-EdgeWorkerActivation

Suggest Edits

Synopsis

Get an activation.

Syntax

Get-EdgeWorkerActivation -EdgeWorkerName <String> [-ActivationID <String>] [-Version <String>] [-ActiveOnNetwork] [-Network <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-EdgeWorkerActivation -EdgeWorkerID <Int32> [-ActivationID <String>] [-Version <String>] [-ActiveOnNetwork] [-Network <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all EdgeWorker activations or returns a specific activation record by its ID. You can specify an EdgeWorker by either its name, ID, or version. The -Version parameter is a specific version number or the word latest.

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.
‑ActivationID
String Pipeline input: False

Your EdgeWorker activation's ID.
‑ActiveOnNetwork
Switch Pipeline input: False

When enabled, limits results to show only currently active versions. Pair this with a network to get the version that's currently active on a specific network. Otherwise, the response may include up to two versions.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑EdgeWorkerID
Conditionally required
Int Parameter sets: id Pipeline input: False

Your EdgeWorker's ID.
‑EdgeWorkerName
Conditionally required
String Parameter sets: name Pipeline input: False

Your Edge Worker's name.
‑Network
String Accepted values: STAGING, PRODUCTION Pipeline input: False

When enabled, limits results to show only versions activated on a specific network, either STAGING or PRODUCTION. Pair this with activeOnNetwork=true to get the version that's currently active on the specified network.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑Version
String Pipeline input: False

Your EdgeWorker's version, either an integer or the word latest.

Related Links

Updated 6 days ago