Guide

Endpoint version PII

Set-APIEndpointVersionPII

Suggest Edits

Synopsis

Modify PII settings for an endpoint version.

Syntax

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

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

Description

Updates the PII settings in an endpoint version. These settings are for the PII object per endpoint version, and thus if you have the same object in multiple endpoint versions, you need to run the operation for each version. This includes parameters with the PII already in your API definition as well as parameters with the PII the network discovered on your behalf.

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.
‑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 29 days ago