Guide

Code bundle

Get-EdgeWorkerCodeBundle

Suggest Edits

Synopsis

Download an EdgeWorkers code bundle.

Syntax

Get-EdgeWorkerCodeBundle -EdgeWorkerName <String> -Version <String> [-OutputFile <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-EdgeWorkerCodeBundle -EdgeWorkerName <String> -Version <String> [-OutputDirectory <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-EdgeWorkerCodeBundle -EdgeWorkerID <Int32> -Version <String> [-OutputDirectory <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-EdgeWorkerCodeBundle -EdgeWorkerID <Int32> -Version <String> [-OutputFile <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Downloads the bundle containing the code the EdgeWorker executes. If you specify the -OutputFile (which is the default), the code bundle will be written to a .tgz file. Alternatively, you can specify the -OutputDirectory, upon which the .tgz bundle will be extracted to the given directory.

Note: You need to have the tar command available on your system to run this operation.

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-directory, id-file Pipeline input: False

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

Your Edge Worker's name.
‑OutputDirectory
String Parameter sets: id-directory, name-directory Pipeline input: False

A directory to extract bundle contents into.
‑OutputFile
String Parameter sets: id-file, name-file Pipeline input: False

A TGZ filename to save bundle contents to.
‑Section
String Pipeline input: False

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

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

Related Links

Updated 17 days ago