Get-OCIWaasCustomProtectionRulesList

SYNOPSIS

Invokes Waas service - ListCustomProtectionRules operation.

SYNTAX

Limit

Get-OCIWaasCustomProtectionRulesList -CompartmentId <String> [-OpcRequestId <String>] [-Limit <Int32>] [-Page <String>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-Id <System.Collections.Generic.List`1[System.String]>] [-DisplayName <System.Collections.Generic.List`1[System.String]>] [-LifecycleState <System.Collections.Generic.List`1[Oci.WaasService.Models.LifecycleStates]>] [-TimeCreatedGreaterThanOrEqualTo <DateTime>] [-TimeCreatedLessThan <DateTime>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIWaasCustomProtectionRulesList -CompartmentId <String> [-OpcRequestId <String>] [-Page <String>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-Id <System.Collections.Generic.List`1[System.String]>] [-DisplayName <System.Collections.Generic.List`1[System.String]>] [-LifecycleState <System.Collections.Generic.List`1[Oci.WaasService.Models.LifecycleStates]>] [-TimeCreatedGreaterThanOrEqualTo <DateTime>] [-TimeCreatedLessThan <DateTime>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Gets a list of custom protection rules for the specified Web Application Firewall.

PARAMETERS

-All

Fetches all pages of results.

Type: SwitchParameter
Parameter Sets: AllPages
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AuthType

Type of authentication to use for making API requests. Default is Key based Authentication.

Type: AuthenticationType
Parameter Sets: (All)
Aliases: None
Accepted values: ApiKey, InstancePrincipal, SessionToken

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CompartmentId

The OCID of the compartment. This number is generated when the compartment is created.

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ConfigFile

The path to the config file.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DisplayName

Filter custom protection rules using a list of display names.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Endpoint

The value to use as the service endpoint, including any required API version path.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-FullResponse

Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Id

Filter custom protection rules using a list of custom protection rule OCIDs.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-LifecycleState

Filter Custom Protection rules using a list of lifecycle states.

Type: System.Collections.Generic.List`1[Oci.WaasService.Models.LifecycleStates]
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Creating, Active, Failed, Updating, Deleting, Deleted

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Limit

The maximum number of items to return in a paginated call. If unspecified, defaults to `10`.

Type: Int32
Parameter Sets: Limit
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NoRetry

Disable retry logic for calls to services.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OpcRequestId

The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Page

The value of the `opc-next-page` response header from the previous paginated call.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Profile

The profile in the config file to load.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Region

Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SortBy

The value by which custom protection rules are sorted in a paginated 'List' call. If unspecified, defaults to `timeCreated`.

Type: SortByEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Id, CompartmentId, DisplayName, ModSecurityRuleId, TimeCreated

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SortOrder

The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `DESC`.

Type: SortOrderEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Asc, Desc

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeCreatedGreaterThanOrEqualTo

A filter that matches Custom Protection rules created on or after the specified date-time.

Type: DateTime
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeCreatedLessThan

A filter that matches custom protection rules created before the specified date-time.

Type: DateTime
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeOutInMillis

Max wait time in milliseconds for the API request to complete. Default is 100000 millis(100 secs).

Type: Int32
Parameter Sets: (All)
Aliases: None

Required: False
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.

OUTPUTS

• Oci.WaasService.Models.CustomProtectionRuleSummary
• Oci.WaasService.Responses.ListCustomProtectionRulesResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples