Endpoint activation

New-APIEndpointActivation

Synopsis

Activate a version.

Syntax

name-attributes (Default)

New-APIEndpointActivation -APIEndpointName <String> -VersionNumber <String> -Notes <String> -Networks <String>
 -NotificationRecipients <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

name-body

New-APIEndpointActivation -APIEndpointName <String> -VersionNumber <String> -Body <Object>
 [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

id-body

New-APIEndpointActivation -APIEndpointID <Int32> -VersionNumber <String> -Body <Object> [-EdgeRCFile <String>]
 [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

id-attributes

New-APIEndpointActivation -APIEndpointID <Int32> -VersionNumber <String> -Notes <String> -Networks <String>
 -NotificationRecipients <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Activates an endpoint version on the staging or production network by name or ID and version number. If another version of the endpoint is already active on the specified network, it gets automatically deactivated and the newly activated version takes its place.

You can provide the activation settings individually or send all at once as PSCustomObject with the -Body parameter. The -VersionNumber parameter is an integer or the word latest.

Parameters

-APIEndpointID

The ID for the endpoint.

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

-APIEndpointName

The name of the endpoint.

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

-AccountSwitchKey

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run Get-AccountSwitchKey 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

-Body

Request body, either as a PSCustomObject or string. This parameter supports pipelining.

Type: Object
Parameter Sets: name-body, id-body
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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

-Networks

The network environments where you activate the endpoint version, either STAGING or PRODUCTION.

Type: String
Parameter Sets: name-attributes, id-attributes
Aliases:
Accepted values: Production, Staging, Both

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

-Notes

The notes describing the version that you activate.

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

-NotificationRecipients

The email addresses where the system sends the activation notification.

Type: String
Parameter Sets: name-attributes, id-attributes
Aliases: None
Required: True
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

-VersionNumber

The ID for the endpoint version. Defaults to latest.

Type: String
Parameter Sets: (All)
Aliases: None
Required: True
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

System.Object

Outputs