Policy

Get-AppSecPolicy

Synopsis

Get a security policy.

Syntax

Get-AppSecPolicy [-ConfigName <String>] [-VersionNumber] <String> [-NotMatched] [-Detail] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-AppSecPolicy -ConfigName <String> [-VersionNumber] <String> -PolicyID <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-AppSecPolicy -ConfigName <String> [-VersionNumber] <String> [-PolicyName] <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-AppSecPolicy [-ConfigID <Int32>] [-VersionNumber] <String> [-NotMatched] [-Detail] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-AppSecPolicy -ConfigID <Int32> [-VersionNumber] <String> -PolicyID <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
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

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.

‑ConfigID

Your configuration's ID.

‑ConfigName

The name of your security configuration.

‑Detail

If present, the results contain detailed information on versions. If absent, the results contain summary information on versions.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑NotMatched

If present, the function returns all security policies in the configuration version that don't have a match target. If absent, returns all security policies in the configuration version.

‑PolicyID
Conditionally required

Your security policy's ID.

‑PolicyName
Conditionally required

The name of your security policy.

‑Section

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

‑VersionNumber
Required

A configuration's version. Can be an integer or the word latest.

Related Links