getApiratelimitprofile

avi 31.2.2, Feb 10 26

Viewing docs for avi 31.2.2
published on Tuesday, Feb 10, 2026 by vmware

Schema (JSON)

vmware/terraform-provider-avi

Viewing docs for avi 31.2.2
published on Tuesday, Feb 10, 2026 by vmware

Schema (JSON)

vmware/terraform-provider-avi

<!–

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

–>

layout: “avi”

page_title: “AVI:<span pulumi-lang-nodejs=” avi.Apiratelimitprofile"" pulumi-lang-dotnet=" avi.Apiratelimitprofile"" pulumi-lang-go=" Apiratelimitprofile"" pulumi-lang-python=" Apiratelimitprofile"" pulumi-lang-yaml=" avi.Apiratelimitprofile"" pulumi-lang-java=" avi.Apiratelimitprofile""> avi.Apiratelimitprofile" sidebar_current: “docs-avi-datasource-apiratelimitprofile” description: |- Get information of Avi ApiRateLimitProfile.

# avi.Apiratelimitprofile This data source is used to to get avi.Apiratelimitprofile objects.

Example Usage

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

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

import pulumi
import pulumi_avi as avi

foo_apiratelimitprofile = avi.get_apiratelimitprofile(uuid="apiratelimitprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    name="foo")

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.LookupApiratelimitprofile(ctx, &avi.LookupApiratelimitprofileArgs{
			Uuid: pulumi.StringRef("apiratelimitprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
			Name: pulumi.StringRef("foo"),
		}, 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 fooApiratelimitprofile = Avi.GetApiratelimitprofile.Invoke(new()
    {
        Uuid = "apiratelimitprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
        Name = "foo",
    });

});

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.GetApiratelimitprofileArgs;
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 fooApiratelimitprofile = AviFunctions.getApiratelimitprofile(GetApiratelimitprofileArgs.builder()
            .uuid("apiratelimitprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .name("foo")
            .build());

    }
}

variables:
  fooApiratelimitprofile:
    fn::invoke:
      function: avi:getApiratelimitprofile
      arguments:
        uuid: apiratelimitprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b
        name: foo

Using getApiratelimitprofile

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 getApiratelimitprofile(args: GetApiratelimitprofileArgs, opts?: InvokeOptions): Promise<GetApiratelimitprofileResult>
function getApiratelimitprofileOutput(args: GetApiratelimitprofileOutputArgs, opts?: InvokeOptions): Output<GetApiratelimitprofileResult>

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

func LookupApiratelimitprofile(ctx *Context, args *LookupApiratelimitprofileArgs, opts ...InvokeOption) (*LookupApiratelimitprofileResult, error)
func LookupApiratelimitprofileOutput(ctx *Context, args *LookupApiratelimitprofileOutputArgs, opts ...InvokeOption) LookupApiratelimitprofileResultOutput

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

public static class GetApiratelimitprofile 
{
    public static Task<GetApiratelimitprofileResult> InvokeAsync(GetApiratelimitprofileArgs args, InvokeOptions? opts = null)
    public static Output<GetApiratelimitprofileResult> Invoke(GetApiratelimitprofileInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiratelimitprofileResult> getApiratelimitprofile(GetApiratelimitprofileArgs args, InvokeOptions options)
public static Output<GetApiratelimitprofileResult> getApiratelimitprofile(GetApiratelimitprofileArgs args, InvokeOptions options)

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

The following arguments are supported:

Id string
Name string: Search ApiRateLimitProfile by name.
TenantRef string: Tenant ref for the api rate limit profile. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: Search ApiRateLimitProfile by uuid.

Id string
Name string: Search ApiRateLimitProfile by name.
TenantRef string: Tenant ref for the api rate limit profile. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: Search ApiRateLimitProfile by uuid.

id String
name String: Search ApiRateLimitProfile by name.
tenantRef String: Tenant ref for the api rate limit profile. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: Search ApiRateLimitProfile by uuid.

id string
name string: Search ApiRateLimitProfile by name.
tenantRef string: Tenant ref for the api rate limit profile. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid string: Search ApiRateLimitProfile by uuid.

id str
name str: Search ApiRateLimitProfile by name.
tenant_ref str: Tenant ref for the api rate limit profile. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid str: Search ApiRateLimitProfile by uuid.

id String
name String: Search ApiRateLimitProfile by name.
tenantRef String: Tenant ref for the api rate limit profile. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: Search ApiRateLimitProfile by uuid.

getApiratelimitprofile Result

The following output properties are available:

ConfigpbAttributes List<GetApiratelimitprofileConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string: Description for the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Enabled string: Activate/deactivate the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Id string
Name string: Name of the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
RateLimitConfigurationRefs List<string>: List of the rate limiter configuration uuids. It is a reference to an object of type ratelimitconfiguration. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 100 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
TenantRef string: Tenant ref for the api rate limit profile. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: Uuid of the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.

ConfigpbAttributes []GetApiratelimitprofileConfigpbAttribute: Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string: Description for the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Enabled string: Activate/deactivate the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Id string
Name string: Name of the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
RateLimitConfigurationRefs []string: List of the rate limiter configuration uuids. It is a reference to an object of type ratelimitconfiguration. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 100 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
TenantRef string: Tenant ref for the api rate limit profile. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: Uuid of the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.

configpbAttributes List<GetApiratelimitprofileConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String: Description for the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
enabled String: Activate/deactivate the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
id String
name String: Name of the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
rateLimitConfigurationRefs List<String>: List of the rate limiter configuration uuids. It is a reference to an object of type ratelimitconfiguration. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 100 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
tenantRef String: Tenant ref for the api rate limit profile. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: Uuid of the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.

configpbAttributes GetApiratelimitprofileConfigpbAttribute[]: Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description string: Description for the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
enabled string: Activate/deactivate the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
id string
name string: Name of the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
rateLimitConfigurationRefs string[]: List of the rate limiter configuration uuids. It is a reference to an object of type ratelimitconfiguration. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 100 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
tenantRef string: Tenant ref for the api rate limit profile. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid string: Uuid of the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.

configpb_attributes Sequence[GetApiratelimitprofileConfigpbAttribute]: Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description str: Description for the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
enabled str: Activate/deactivate the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
id str
name str: Name of the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
rate_limit_configuration_refs Sequence[str]: List of the rate limiter configuration uuids. It is a reference to an object of type ratelimitconfiguration. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 100 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
tenant_ref str: Tenant ref for the api rate limit profile. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid str: Uuid of the api rate limit profile. Field introduced in 31.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 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String: Description for the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
enabled String: Activate/deactivate the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
id String
name String: Name of the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
rateLimitConfigurationRefs List<String>: List of the rate limiter configuration uuids. It is a reference to an object of type ratelimitconfiguration. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 100 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
tenantRef String: Tenant ref for the api rate limit profile. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: Uuid of the api rate limit profile. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.