avi.getBotdetectionpolicy

Explore with Pulumi AI

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

<!–

Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

–>

layout: “avi”

page_title: “AVI: avi.Botdetectionpolicy” sidebar_current: “docs-avi-datasource-botdetectionpolicy” description: |- Get information of Avi BotDetectionPolicy.

avi.Botdetectionpolicy

This data source is used to to get avi.Botdetectionpolicy objects.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as avi from "@pulumi/avi";

const fooBotdetectionpolicy = avi.getBotdetectionpolicy({
    name: "foo",
    uuid: "botdetectionpolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
});

import pulumi
import pulumi_avi as avi

foo_botdetectionpolicy = avi.get_botdetectionpolicy(name="foo",
    uuid="botdetectionpolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.LookupBotdetectionpolicy(ctx, &avi.LookupBotdetectionpolicyArgs{
			Name: pulumi.StringRef("foo"),
			Uuid: pulumi.StringRef("botdetectionpolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var fooBotdetectionpolicy = Avi.GetBotdetectionpolicy.Invoke(new()
    {
        Name = "foo",
        Uuid = "botdetectionpolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.AviFunctions;
import com.pulumi.avi.inputs.GetBotdetectionpolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var fooBotdetectionpolicy = AviFunctions.getBotdetectionpolicy(GetBotdetectionpolicyArgs.builder()
            .name("foo")
            .uuid("botdetectionpolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .build());

    }
}

variables:
  fooBotdetectionpolicy:
    fn::invoke:
      function: avi:getBotdetectionpolicy
      arguments:
        name: foo
        uuid: botdetectionpolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b

Using getBotdetectionpolicy

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getBotdetectionpolicy(args: GetBotdetectionpolicyArgs, opts?: InvokeOptions): Promise<GetBotdetectionpolicyResult>
function getBotdetectionpolicyOutput(args: GetBotdetectionpolicyOutputArgs, opts?: InvokeOptions): Output<GetBotdetectionpolicyResult>

def get_botdetectionpolicy(id: Optional[str] = None,
                           name: Optional[str] = None,
                           tenant_ref: Optional[str] = None,
                           uuid: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetBotdetectionpolicyResult
def get_botdetectionpolicy_output(id: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           tenant_ref: Optional[pulumi.Input[str]] = None,
                           uuid: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetBotdetectionpolicyResult]

func LookupBotdetectionpolicy(ctx *Context, args *LookupBotdetectionpolicyArgs, opts ...InvokeOption) (*LookupBotdetectionpolicyResult, error)
func LookupBotdetectionpolicyOutput(ctx *Context, args *LookupBotdetectionpolicyOutputArgs, opts ...InvokeOption) LookupBotdetectionpolicyResultOutput

> Note: This function is named LookupBotdetectionpolicy in the Go SDK.

public static class GetBotdetectionpolicy 
{
    public static Task<GetBotdetectionpolicyResult> InvokeAsync(GetBotdetectionpolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetBotdetectionpolicyResult> Invoke(GetBotdetectionpolicyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBotdetectionpolicyResult> getBotdetectionpolicy(GetBotdetectionpolicyArgs args, InvokeOptions options)
public static Output<GetBotdetectionpolicyResult> getBotdetectionpolicy(GetBotdetectionpolicyArgs args, InvokeOptions options)

fn::invoke:
  function: avi:index/getBotdetectionpolicy:getBotdetectionpolicy
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string
Name string: Search BotDetectionPolicy by name.
TenantRef string: The unique identifier of the tenant to which this policy belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: Search BotDetectionPolicy by uuid.

Id string
Name string: Search BotDetectionPolicy by name.
TenantRef string: The unique identifier of the tenant to which this policy belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: Search BotDetectionPolicy by uuid.

id String
name String: Search BotDetectionPolicy by name.
tenantRef String: The unique identifier of the tenant to which this policy belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: Search BotDetectionPolicy by uuid.

id string
name string: Search BotDetectionPolicy by name.
tenantRef string: The unique identifier of the tenant to which this policy belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid string: Search BotDetectionPolicy by uuid.

id str
name str: Search BotDetectionPolicy by name.
tenant_ref str: The unique identifier of the tenant to which this policy belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid str: Search BotDetectionPolicy by uuid.

id String
name String: Search BotDetectionPolicy by name.
tenantRef String: The unique identifier of the tenant to which this policy belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: Search BotDetectionPolicy by uuid.

getBotdetectionpolicy Result

The following output properties are available:

AllowLists List<GetBotdetectionpolicyAllowList>: Allow the user to skip botmanagement for selected requests. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
ClientBehaviorDetectors List<GetBotdetectionpolicyClientBehaviorDetector>: The client behavior configuration used in this policy. Field introduced in 30.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string: Human-readable description of this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Id string
IpLocationDetectors List<GetBotdetectionpolicyIpLocationDetector>: The ip location configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
IpReputationDetectors List<GetBotdetectionpolicyIpReputationDetector>: The ip reputation configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Name string: The name of this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
SystemBotMappingRef string: System-defined rules for classification. It is a reference to an object of type botmapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
SystemConsolidatorRef string: The installation provides an updated ruleset for consolidating the results of different decider phases. It is a reference to an object of type botconfigconsolidator. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
TenantRef string: The unique identifier of the tenant to which this policy belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
UserAgentDetectors List<GetBotdetectionpolicyUserAgentDetector>: The user-agent configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
UserBotMappingRef string: User-defined rules for classification. These are applied before the system classification rules. If a rule matches, processing terminates and the system-defined rules will not run. It is a reference to an object of type botmapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
UserConsolidatorRef string: The user-provided ruleset for consolidating the results of different decider phases. This runs before the system consolidator. If it successfully sets a consolidation, the system consolidator will not change it. It is a reference to an object of type botconfigconsolidator. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: A unique identifier to this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.

AllowLists []GetBotdetectionpolicyAllowList: Allow the user to skip botmanagement for selected requests. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
ClientBehaviorDetectors []GetBotdetectionpolicyClientBehaviorDetector: The client behavior configuration used in this policy. Field introduced in 30.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string: Human-readable description of this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Id string
IpLocationDetectors []GetBotdetectionpolicyIpLocationDetector: The ip location configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
IpReputationDetectors []GetBotdetectionpolicyIpReputationDetector: The ip reputation configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Name string: The name of this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
SystemBotMappingRef string: System-defined rules for classification. It is a reference to an object of type botmapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
SystemConsolidatorRef string: The installation provides an updated ruleset for consolidating the results of different decider phases. It is a reference to an object of type botconfigconsolidator. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
TenantRef string: The unique identifier of the tenant to which this policy belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
UserAgentDetectors []GetBotdetectionpolicyUserAgentDetector: The user-agent configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
UserBotMappingRef string: User-defined rules for classification. These are applied before the system classification rules. If a rule matches, processing terminates and the system-defined rules will not run. It is a reference to an object of type botmapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
UserConsolidatorRef string: The user-provided ruleset for consolidating the results of different decider phases. This runs before the system consolidator. If it successfully sets a consolidation, the system consolidator will not change it. It is a reference to an object of type botconfigconsolidator. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: A unique identifier to this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.

allowLists List<GetBotdetectionpolicyAllowList>: Allow the user to skip botmanagement for selected requests. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
clientBehaviorDetectors List<GetBotdetectionpolicyClientBehaviorDetector>: The client behavior configuration used in this policy. Field introduced in 30.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String: Human-readable description of this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
id String
ipLocationDetectors List<GetBotdetectionpolicyIpLocationDetector>: The ip location configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
ipReputationDetectors List<GetBotdetectionpolicyIpReputationDetector>: The ip reputation configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
name String: The name of this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
systemBotMappingRef String: System-defined rules for classification. It is a reference to an object of type botmapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
systemConsolidatorRef String: The installation provides an updated ruleset for consolidating the results of different decider phases. It is a reference to an object of type botconfigconsolidator. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
tenantRef String: The unique identifier of the tenant to which this policy belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
userAgentDetectors List<GetBotdetectionpolicyUserAgentDetector>: The user-agent configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
userBotMappingRef String: User-defined rules for classification. These are applied before the system classification rules. If a rule matches, processing terminates and the system-defined rules will not run. It is a reference to an object of type botmapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
userConsolidatorRef String: The user-provided ruleset for consolidating the results of different decider phases. This runs before the system consolidator. If it successfully sets a consolidation, the system consolidator will not change it. It is a reference to an object of type botconfigconsolidator. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: A unique identifier to this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.

allowLists GetBotdetectionpolicyAllowList[]: Allow the user to skip botmanagement for selected requests. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
clientBehaviorDetectors GetBotdetectionpolicyClientBehaviorDetector[]: The client behavior configuration used in this policy. Field introduced in 30.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description string: Human-readable description of this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
id string
ipLocationDetectors GetBotdetectionpolicyIpLocationDetector[]: The ip location configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
ipReputationDetectors GetBotdetectionpolicyIpReputationDetector[]: The ip reputation configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
name string: The name of this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
systemBotMappingRef string: System-defined rules for classification. It is a reference to an object of type botmapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
systemConsolidatorRef string: The installation provides an updated ruleset for consolidating the results of different decider phases. It is a reference to an object of type botconfigconsolidator. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
tenantRef string: The unique identifier of the tenant to which this policy belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
userAgentDetectors GetBotdetectionpolicyUserAgentDetector[]: The user-agent configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
userBotMappingRef string: User-defined rules for classification. These are applied before the system classification rules. If a rule matches, processing terminates and the system-defined rules will not run. It is a reference to an object of type botmapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
userConsolidatorRef string: The user-provided ruleset for consolidating the results of different decider phases. This runs before the system consolidator. If it successfully sets a consolidation, the system consolidator will not change it. It is a reference to an object of type botconfigconsolidator. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid string: A unique identifier to this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.

allow_lists Sequence[GetBotdetectionpolicyAllowList]: Allow the user to skip botmanagement for selected requests. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
client_behavior_detectors Sequence[GetBotdetectionpolicyClientBehaviorDetector]: The client behavior configuration used in this policy. Field introduced in 30.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description str: Human-readable description of this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
id str
ip_location_detectors Sequence[GetBotdetectionpolicyIpLocationDetector]: The ip location configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
ip_reputation_detectors Sequence[GetBotdetectionpolicyIpReputationDetector]: The ip reputation configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
name str: The name of this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
system_bot_mapping_ref str: System-defined rules for classification. It is a reference to an object of type botmapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
system_consolidator_ref str: The installation provides an updated ruleset for consolidating the results of different decider phases. It is a reference to an object of type botconfigconsolidator. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
tenant_ref str: The unique identifier of the tenant to which this policy belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
user_agent_detectors Sequence[GetBotdetectionpolicyUserAgentDetector]: The user-agent configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
user_bot_mapping_ref str: User-defined rules for classification. These are applied before the system classification rules. If a rule matches, processing terminates and the system-defined rules will not run. It is a reference to an object of type botmapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
user_consolidator_ref str: The user-provided ruleset for consolidating the results of different decider phases. This runs before the system consolidator. If it successfully sets a consolidation, the system consolidator will not change it. It is a reference to an object of type botconfigconsolidator. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid str: A unique identifier to this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.

allowLists List<Property Map>: Allow the user to skip botmanagement for selected requests. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
clientBehaviorDetectors List<Property Map>: The client behavior configuration used in this policy. Field introduced in 30.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String: Human-readable description of this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
id String
ipLocationDetectors List<Property Map>: The ip location configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
ipReputationDetectors List<Property Map>: The ip reputation configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
name String: The name of this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
systemBotMappingRef String: System-defined rules for classification. It is a reference to an object of type botmapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
systemConsolidatorRef String: The installation provides an updated ruleset for consolidating the results of different decider phases. It is a reference to an object of type botconfigconsolidator. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
tenantRef String: The unique identifier of the tenant to which this policy belongs. It is a reference to an object of type tenant. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
userAgentDetectors List<Property Map>: The user-agent configuration used in this policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
userBotMappingRef String: User-defined rules for classification. These are applied before the system classification rules. If a rule matches, processing terminates and the system-defined rules will not run. It is a reference to an object of type botmapping. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
userConsolidatorRef String: The user-provided ruleset for consolidating the results of different decider phases. This runs before the system consolidator. If it successfully sets a consolidation, the system consolidator will not change it. It is a reference to an object of type botconfigconsolidator. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: A unique identifier to this bot detection policy. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.