Protect-AppSecEvaluationHostnames

Synopsis

Protect evaluation hostnames.

Syntax

configname-pipeline (Default)

Protect-AppSecEvaluationHostnames [-ConfigName] <String> [-VersionNumber] <String> -Body <Object>
 [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

configname-attributes

Protect-AppSecEvaluationHostnames [-ConfigName] <String> [-VersionNumber] <String> -Hostnames <Object>
 -Mode <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

configid-pipeline

Protect-AppSecEvaluationHostnames -ConfigID <Int32> [-VersionNumber] <String> -Body <Object>
 [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

configid-attributes

Protect-AppSecEvaluationHostnames -ConfigID <Int32> [-VersionNumber] <String> -Hostnames <Object>
 -Mode <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Moves hostnames you're evaluating to active protection in a specified configuration version.
When you move a hostname from the evaluation hostnames list, it's added to your security policy as a protected hostname.
You can provide -Hostnames and -Mode as individual Parameters or all at once with the -Body parameter.
When making a request, you can specify a configuration by its name or ID.
The -VersionNumber parameter is an integer or the word latest.

Parameters

-AccountSwitchKey

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account Switch Keys can be found using Get-AccountSwitchKey.

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: configname-pipeline, configid-pipeline
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ConfigID

An ID for each configuration.

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

-ConfigName

The name of the security configuration.

Type: String
Parameter Sets: configname-pipeline, configname-attributes
Aliases: None
Required: True
Position: 0
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

-Hostnames

List of hostnames to be added to the configuration.

Type: Object
Parameter Sets: configname-attributes, configid-attributes
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Mode

The type of update you want to make to the evaluation hostname list.
You can append additional hostnames, remove hostnames from the list, or replace the existing list with the hostnames you pass in your request.

Type: String
Parameter Sets: configname-attributes, configid-attributes
Aliases:
Accepted values: append, remove, replace

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

An ID for each version of a configuration.
Can be an integer or the word 'latest'.

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

System.Object

Related links