Guide

EdgeWorker

Set-EdgeWorker

Suggest Edits

Synopsis

Update an EdgeWorker ID.

Syntax

Set-EdgeWorker -EdgeWorkerName <String> [-NewName <String>] -GroupID <Int32> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Set-EdgeWorker -EdgeWorkerID <Int32> [-NewName <String>] -GroupID <Int32> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates the name or group ID of an existing EdgeWorker. You can specify an EdgeWorker by either its name or 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
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.
‑GroupID
Required
Int Pipeline input: False

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

A name for the new Edge Worker.
‑Section
String Pipeline input: False

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

Related Links

Updated 14 days ago