Guide

Endpoint version resource

Set-APIEndpointVersionResource

Suggest Edits

Synopsis

Edit a resource.

Syntax

Set-APIEndpointVersionResource -APIEndpointName <String> -VersionNumber <String> -APIResourceID <Int32> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Set-APIEndpointVersionResource -APIEndpointID <Int32> -VersionNumber <String> -APIResourceID <Int32> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates a resource within an endpoint version, including information about the resource as well as the methods and parameters assigned to the resource. You can only modify resources assigned to versions that have never been activated on the staging or production network.

In the request, you can specify an API endpoint by its name or ID. The -VersionNumber parameter is an integer or the word latest.

Parameters

‑APIEndpointID
Conditionally required
Int Parameter sets: id Pipeline input: False

The endpoint's ID.
‑APIEndpointName
Conditionally required
String Parameter sets: name Pipeline input: False

The endpoint's name.
‑APIResourceID
Required
Int Pipeline input: False

The API resource's ID.
‑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.
‑Body
Required
Object Pipeline input: ByValue

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑Section
String Pipeline input: False

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

The endpoint version's number. Can be an integer or 'latest'.

Related Links

Updated 4 months ago