Guide

EdgeWorker

Get-EdgeWorker

Suggest Edits

Synopsis

Get an EdgeWorker.

Syntax

Get-EdgeWorker [-GroupID <Int32>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-EdgeWorker [-EdgeWorkerName <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-EdgeWorker [-EdgeWorkerID <Int32>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all EdgeWorkers or returns a specific EdgeWorker by its name or ID. When listing all EdgeWorkers, you can filter the results by group 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.
‑EdgeRCFile
String Pipeline input: False

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

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

Your Edge Worker's name.
‑GroupID
Int Parameter sets: all Pipeline input: False

Your group's ID.
‑Section
String Pipeline input: False

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

Related Links

Updated 27 days ago