Policy

Get-AppSecPolicy

Synopsis

Get a security policy.

Syntax

configname-all (Default)

Get-AppSecPolicy [-ConfigName <String>] [-VersionNumber] <String> [-NotMatched] [-Detail]
 [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

configname-policyid

Get-AppSecPolicy -ConfigName <String> [-VersionNumber] <String> -PolicyID <String> [-EdgeRCFile <String>]
 [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

configname-policyname

Get-AppSecPolicy -ConfigName <String> [-VersionNumber] <String> [-PolicyName] <String> [-EdgeRCFile <String>]
 [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

configid-all

Get-AppSecPolicy [-ConfigID <Int32>] [-VersionNumber] <String> [-NotMatched] [-Detail] [-EdgeRCFile <String>]
 [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

configid-policyid

Get-AppSecPolicy -ConfigID <Int32> [-VersionNumber] <String> -PolicyID <String> [-EdgeRCFile <String>]
 [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

configid-policyname

Get-AppSecPolicy -ConfigID <Int32> [-VersionNumber] <String> [-PolicyName] <String> [-EdgeRCFile <String>]
 [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all security policies in your configuration or returns a specific security policy by its name or ID.

When making a request, you can specify a configuration in the -ConfigName or -ConfigID parameter. The -VersionNumber 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

-ConfigID

An ID for each configuration.

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

Type: Int32
Parameter Sets: configid-policyid, configid-policyname
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-all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Type: String
Parameter Sets: configname-policyid, configname-policyname
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Detail

When true, the results contain detailed information on versions. With the default false, the results contain summary information on versions.

Type: SwitchParameter
Parameter Sets: configname-all, configid-all
Aliases: None
Required: False
Position: Named
Default value: False
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

-NotMatched

If true, returns all security policies in the configuration version that don't have a match target. If false, returns all security policies in the configuration version.

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

-PolicyID

An ID for a security policy.

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

-PolicyName

The name of the security policy.

Type: String
Parameter Sets: configname-policyname, configid-policyname
Aliases: None
Required: True
Position: 2
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

None

Outputs

System.Object