avi.getCsrfpolicy

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.Csrfpolicy” sidebar_current: “docs-avi-datasource-csrfpolicy” description: |- Get information of Avi CSRFPolicy.

avi.Csrfpolicy

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

Example Usage

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

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

import pulumi
import pulumi_avi as avi

foo_csrfpolicy = avi.get_csrfpolicy(name="foo",
    uuid="csrfpolicy-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.LookupCsrfpolicy(ctx, &avi.LookupCsrfpolicyArgs{
			Name: pulumi.StringRef("foo"),
			Uuid: pulumi.StringRef("csrfpolicy-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 fooCsrfpolicy = Avi.GetCsrfpolicy.Invoke(new()
    {
        Name = "foo",
        Uuid = "csrfpolicy-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.GetCsrfpolicyArgs;
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 fooCsrfpolicy = AviFunctions.getCsrfpolicy(GetCsrfpolicyArgs.builder()
            .name("foo")
            .uuid("csrfpolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .build());

    }
}

variables:
  fooCsrfpolicy:
    fn::invoke:
      function: avi:getCsrfpolicy
      arguments:
        name: foo
        uuid: csrfpolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b

Using getCsrfpolicy

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 getCsrfpolicy(args: GetCsrfpolicyArgs, opts?: InvokeOptions): Promise<GetCsrfpolicyResult>
function getCsrfpolicyOutput(args: GetCsrfpolicyOutputArgs, opts?: InvokeOptions): Output<GetCsrfpolicyResult>

def get_csrfpolicy(id: Optional[str] = None,
                   name: Optional[str] = None,
                   tenant_ref: Optional[str] = None,
                   uuid: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetCsrfpolicyResult
def get_csrfpolicy_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[GetCsrfpolicyResult]

func LookupCsrfpolicy(ctx *Context, args *LookupCsrfpolicyArgs, opts ...InvokeOption) (*LookupCsrfpolicyResult, error)
func LookupCsrfpolicyOutput(ctx *Context, args *LookupCsrfpolicyOutputArgs, opts ...InvokeOption) LookupCsrfpolicyResultOutput

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

public static class GetCsrfpolicy 
{
    public static Task<GetCsrfpolicyResult> InvokeAsync(GetCsrfpolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetCsrfpolicyResult> Invoke(GetCsrfpolicyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCsrfpolicyResult> getCsrfpolicy(GetCsrfpolicyArgs args, InvokeOptions options)
public static Output<GetCsrfpolicyResult> getCsrfpolicy(GetCsrfpolicyArgs args, InvokeOptions options)

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

The following arguments are supported:

Id string
Name string: Search CSRFPolicy 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 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: Search CSRFPolicy by uuid.

Id string
Name string: Search CSRFPolicy 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 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: Search CSRFPolicy by uuid.

id String
name String: Search CSRFPolicy 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 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: Search CSRFPolicy by uuid.

id string
name string: Search CSRFPolicy 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 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid string: Search CSRFPolicy by uuid.

id str
name str: Search CSRFPolicy 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 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid str: Search CSRFPolicy by uuid.

id String
name String: Search CSRFPolicy 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 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: Search CSRFPolicy by uuid.

getCsrfpolicy Result

The following output properties are available:

ConfigpbAttributes List<GetCsrfpolicyConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 30.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
CookieName string: Name of the cookie to be used for csrf token. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
CsrfFileRef string: The file object that contains csrf javascript content. Must be of type 'csrf'. It is a reference to an object of type fileobject. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Description string: Human-readable description of this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Id string
Name string: The name of this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Rules List<GetCsrfpolicyRule>: Rules to control which requests undergo csrf protection.if the client's request doesn't match with any rules matchtarget, bypass_csrf action is applied. Field introduced in 30.2.1. Minimum of 1 items required. 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 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
TokenValidityTimeMin string: A csrf token is rotated when this amount of time has passed. Even after that, tokens will be accepted until twice this amount of time has passed. Note, however, that other timeouts from the underlying session layer also affect how long a given token can be used. A token will be invalidated (rotated or deleted) after one of 'token_validity_time_min' (this value), 'session_establishment_timeout', 'session_idle_timeout', 'session_maximum_timeout' is reached, whichever occurs first. Allowed values are 10-1440. Special values are 0- unlimited. Field introduced in 30.2.1. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: A unique identifier to this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.

ConfigpbAttributes []GetCsrfpolicyConfigpbAttribute: Protobuf versioning for config pbs. Field introduced in 30.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
CookieName string: Name of the cookie to be used for csrf token. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
CsrfFileRef string: The file object that contains csrf javascript content. Must be of type 'csrf'. It is a reference to an object of type fileobject. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Description string: Human-readable description of this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Id string
Name string: The name of this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Rules []GetCsrfpolicyRule: Rules to control which requests undergo csrf protection.if the client's request doesn't match with any rules matchtarget, bypass_csrf action is applied. Field introduced in 30.2.1. Minimum of 1 items required. 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 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
TokenValidityTimeMin string: A csrf token is rotated when this amount of time has passed. Even after that, tokens will be accepted until twice this amount of time has passed. Note, however, that other timeouts from the underlying session layer also affect how long a given token can be used. A token will be invalidated (rotated or deleted) after one of 'token_validity_time_min' (this value), 'session_establishment_timeout', 'session_idle_timeout', 'session_maximum_timeout' is reached, whichever occurs first. Allowed values are 10-1440. Special values are 0- unlimited. Field introduced in 30.2.1. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: A unique identifier to this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.

configpbAttributes List<GetCsrfpolicyConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 30.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cookieName String: Name of the cookie to be used for csrf token. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
csrfFileRef String: The file object that contains csrf javascript content. Must be of type 'csrf'. It is a reference to an object of type fileobject. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
description String: Human-readable description of this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
id String
name String: The name of this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
rules List<GetCsrfpolicyRule>: Rules to control which requests undergo csrf protection.if the client's request doesn't match with any rules matchtarget, bypass_csrf action is applied. Field introduced in 30.2.1. Minimum of 1 items required. 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 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
tokenValidityTimeMin String: A csrf token is rotated when this amount of time has passed. Even after that, tokens will be accepted until twice this amount of time has passed. Note, however, that other timeouts from the underlying session layer also affect how long a given token can be used. A token will be invalidated (rotated or deleted) after one of 'token_validity_time_min' (this value), 'session_establishment_timeout', 'session_idle_timeout', 'session_maximum_timeout' is reached, whichever occurs first. Allowed values are 10-1440. Special values are 0- unlimited. Field introduced in 30.2.1. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: A unique identifier to this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.

configpbAttributes GetCsrfpolicyConfigpbAttribute[]: Protobuf versioning for config pbs. Field introduced in 30.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cookieName string: Name of the cookie to be used for csrf token. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
csrfFileRef string: The file object that contains csrf javascript content. Must be of type 'csrf'. It is a reference to an object of type fileobject. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
description string: Human-readable description of this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
id string
name string: The name of this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
rules GetCsrfpolicyRule[]: Rules to control which requests undergo csrf protection.if the client's request doesn't match with any rules matchtarget, bypass_csrf action is applied. Field introduced in 30.2.1. Minimum of 1 items required. 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 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
tokenValidityTimeMin string: A csrf token is rotated when this amount of time has passed. Even after that, tokens will be accepted until twice this amount of time has passed. Note, however, that other timeouts from the underlying session layer also affect how long a given token can be used. A token will be invalidated (rotated or deleted) after one of 'token_validity_time_min' (this value), 'session_establishment_timeout', 'session_idle_timeout', 'session_maximum_timeout' is reached, whichever occurs first. Allowed values are 10-1440. Special values are 0- unlimited. Field introduced in 30.2.1. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid string: A unique identifier to this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.

configpb_attributes Sequence[GetCsrfpolicyConfigpbAttribute]: Protobuf versioning for config pbs. Field introduced in 30.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cookie_name str: Name of the cookie to be used for csrf token. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
csrf_file_ref str: The file object that contains csrf javascript content. Must be of type 'csrf'. It is a reference to an object of type fileobject. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
description str: Human-readable description of this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
id str
name str: The name of this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
rules Sequence[GetCsrfpolicyRule]: Rules to control which requests undergo csrf protection.if the client's request doesn't match with any rules matchtarget, bypass_csrf action is applied. Field introduced in 30.2.1. Minimum of 1 items required. 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 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
token_validity_time_min str: A csrf token is rotated when this amount of time has passed. Even after that, tokens will be accepted until twice this amount of time has passed. Note, however, that other timeouts from the underlying session layer also affect how long a given token can be used. A token will be invalidated (rotated or deleted) after one of 'token_validity_time_min' (this value), 'session_establishment_timeout', 'session_idle_timeout', 'session_maximum_timeout' is reached, whichever occurs first. Allowed values are 10-1440. Special values are 0- unlimited. Field introduced in 30.2.1. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid str: A unique identifier to this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.

configpbAttributes List<Property Map>: Protobuf versioning for config pbs. Field introduced in 30.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cookieName String: Name of the cookie to be used for csrf token. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
csrfFileRef String: The file object that contains csrf javascript content. Must be of type 'csrf'. It is a reference to an object of type fileobject. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
description String: Human-readable description of this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
id String
name String: The name of this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
rules List<Property Map>: Rules to control which requests undergo csrf protection.if the client's request doesn't match with any rules matchtarget, bypass_csrf action is applied. Field introduced in 30.2.1. Minimum of 1 items required. 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 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
tokenValidityTimeMin String: A csrf token is rotated when this amount of time has passed. Even after that, tokens will be accepted until twice this amount of time has passed. Note, however, that other timeouts from the underlying session layer also affect how long a given token can be used. A token will be invalidated (rotated or deleted) after one of 'token_validity_time_min' (this value), 'session_establishment_timeout', 'session_idle_timeout', 'session_maximum_timeout' is reached, whichever occurs first. Allowed values are 10-1440. Special values are 0- unlimited. Field introduced in 30.2.1. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: A unique identifier to this csrf protection policy. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.