Endpoint version PII

New-APIEndpointVersionPII

Synopsis

Add or update a user-created PII instance.

Syntax

name (Default)

New-APIEndpointVersionPII -APIEndpointName <String> -VersionNumber <String> -ParamID <Int32> -Types <String>
 [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

id

New-APIEndpointVersionPII -APIEndpointID <Int32> -VersionNumber <String> -ParamID <Int32> -Types <String>
 [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Description

Adds or updates the PII (personally identifiable information) in an API parameter. Use this operation to add the PII to or modify it in your API definition, rather than the network discovering the PII for you.

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

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

-ParamID

The ID for a parameter.

Type: Int32
Parameter Sets: (All)
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

-Types

The set of PII types you want to add to the parameter. The API supports PERSONAL_EMAIL or CREDIT_OR_DEBIT_CARD_NUMBER.

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

Related links