Activation

Get-EdgeWorkerActivation

Synopsis

Get an activation.

Syntax

name (Default)

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

id

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

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run the Get-AccountSwitchKey command to list the account switch keys available to you.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ActivationID

Unique identifier for an EdgeWorker activation.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ActiveOnNetwork

When enabled, limits results to show only currently activate 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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeWorkerID

Unique identifier for an EdgeWorker.

Type: Int32
Parameter Sets: id
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeWorkerName

Name of the Edge Worker.

Type: String
Parameter Sets: name
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Network

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.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: STAGING, PRODUCTION

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Version

Unique identifier for an EdgeWorker version. Can be an integer or the word latest.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object