Endpoint version PII params

Get-APIEndpointVersionPIIParams

Synopsis

Get parameters with PII for an endpoint version.

Syntax

name (Default)

Get-APIEndpointVersionPIIParams -APIEndpointName <String> -VersionNumber <String> [-EdgeRCFile <String>]
 [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

id

Get-APIEndpointVersionPIIParams -APIEndpointID <Int32> -VersionNumber <String> [-EdgeRCFile <String>]
 [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Returns all PII objects for an endpoint version. This includes parameters with PII already in your API definition, as well as parameters with PII the network discovers on your behalf.

You can return this information for both active and inactive endpoint versions. All operations for PII are per endpoint version. The -VersionNumber parameter is either an integer or the word latest.

Run Set-AppSecPIISettings from the Akamai.AppSec module to use this feature.

Parameters

-APIEndpointID

The ID for the endpoint.

Type: Int32
Parameter Sets: id
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
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

-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

-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

None

Outputs

System.Object