1. Packages
  2. Avi Provider
  3. API Docs
  4. getErrorpageprofile
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

avi.getErrorpageprofile

Explore with Pulumi AI

<!–

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

–>

layout: “avi”

page_title: “AVI: avi.Errorpageprofile” sidebar_current: “docs-avi-datasource-errorpageprofile” description: |- Get information of Avi ErrorPageProfile.

avi.Errorpageprofile

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

Example Usage

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

const fooErrorpageprofile = avi.getErrorpageprofile({
    name: "foo",
    uuid: "errorpageprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
});
Copy
import pulumi
import pulumi_avi as avi

foo_errorpageprofile = avi.get_errorpageprofile(name="foo",
    uuid="errorpageprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
Copy
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.LookupErrorpageprofile(ctx, &avi.LookupErrorpageprofileArgs{
			Name: pulumi.StringRef("foo"),
			Uuid: pulumi.StringRef("errorpageprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

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

});
Copy
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.GetErrorpageprofileArgs;
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 fooErrorpageprofile = AviFunctions.getErrorpageprofile(GetErrorpageprofileArgs.builder()
            .name("foo")
            .uuid("errorpageprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .build());

    }
}
Copy
variables:
  fooErrorpageprofile:
    fn::invoke:
      function: avi:getErrorpageprofile
      arguments:
        name: foo
        uuid: errorpageprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b
Copy

Using getErrorpageprofile

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 getErrorpageprofile(args: GetErrorpageprofileArgs, opts?: InvokeOptions): Promise<GetErrorpageprofileResult>
function getErrorpageprofileOutput(args: GetErrorpageprofileOutputArgs, opts?: InvokeOptions): Output<GetErrorpageprofileResult>
Copy
def get_errorpageprofile(id: Optional[str] = None,
                         name: Optional[str] = None,
                         tenant_ref: Optional[str] = None,
                         uuid: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetErrorpageprofileResult
def get_errorpageprofile_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[GetErrorpageprofileResult]
Copy
func LookupErrorpageprofile(ctx *Context, args *LookupErrorpageprofileArgs, opts ...InvokeOption) (*LookupErrorpageprofileResult, error)
func LookupErrorpageprofileOutput(ctx *Context, args *LookupErrorpageprofileOutputArgs, opts ...InvokeOption) LookupErrorpageprofileResultOutput
Copy

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

public static class GetErrorpageprofile 
{
    public static Task<GetErrorpageprofileResult> InvokeAsync(GetErrorpageprofileArgs args, InvokeOptions? opts = null)
    public static Output<GetErrorpageprofileResult> Invoke(GetErrorpageprofileInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetErrorpageprofileResult> getErrorpageprofile(GetErrorpageprofileArgs args, InvokeOptions options)
public static Output<GetErrorpageprofileResult> getErrorpageprofile(GetErrorpageprofileArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: avi:index/getErrorpageprofile:getErrorpageprofile
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
Name string
Search ErrorPageProfile by name.
TenantRef string
It is a reference to an object of type tenant. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Search ErrorPageProfile by uuid.
Id string
Name string
Search ErrorPageProfile by name.
TenantRef string
It is a reference to an object of type tenant. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Search ErrorPageProfile by uuid.
id String
name String
Search ErrorPageProfile by name.
tenantRef String
It is a reference to an object of type tenant. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Search ErrorPageProfile by uuid.
id string
name string
Search ErrorPageProfile by name.
tenantRef string
It is a reference to an object of type tenant. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string
Search ErrorPageProfile by uuid.
id str
name str
Search ErrorPageProfile by name.
tenant_ref str
It is a reference to an object of type tenant. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str
Search ErrorPageProfile by uuid.
id String
name String
Search ErrorPageProfile by name.
tenantRef String
It is a reference to an object of type tenant. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Search ErrorPageProfile by uuid.

getErrorpageprofile Result

The following output properties are available:

ConfigpbAttributes List<GetErrorpageprofileConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ErrorPages List<GetErrorpageprofileErrorPage>
Defined error pages for http status codes. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
Markers List<GetErrorpageprofileMarker>
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string
Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
It is a reference to an object of type tenant. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []GetErrorpageprofileConfigpbAttribute
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ErrorPages []GetErrorpageprofileErrorPage
Defined error pages for http status codes. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
Markers []GetErrorpageprofileMarker
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string
Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
It is a reference to an object of type tenant. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<GetErrorpageprofileConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
errorPages List<GetErrorpageprofileErrorPage>
Defined error pages for http status codes. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id String
markers List<GetErrorpageprofileMarker>
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String
Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
It is a reference to an object of type tenant. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes GetErrorpageprofileConfigpbAttribute[]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
errorPages GetErrorpageprofileErrorPage[]
Defined error pages for http status codes. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id string
markers GetErrorpageprofileMarker[]
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name string
Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef string
It is a reference to an object of type tenant. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string
Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[GetErrorpageprofileConfigpbAttribute]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
error_pages Sequence[GetErrorpageprofileErrorPage]
Defined error pages for http status codes. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id str
markers Sequence[GetErrorpageprofileMarker]
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name str
Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_ref str
It is a reference to an object of type tenant. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str
Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<Property Map>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
errorPages List<Property Map>
Defined error pages for http status codes. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id String
markers List<Property Map>
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String
Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
It is a reference to an object of type tenant. Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Field introduced in 17.2.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Supporting Types

GetErrorpageprofileConfigpbAttribute

Version This property is required. string
Version This property is required. string
version This property is required. String
version This property is required. string
version This property is required. str
version This property is required. String

GetErrorpageprofileErrorPage

Enable This property is required. string
ErrorPageBodyRef This property is required. string
ErrorRedirect This property is required. string
Index This property is required. string
Matches This property is required. List<GetErrorpageprofileErrorPageMatch>
Enable This property is required. string
ErrorPageBodyRef This property is required. string
ErrorRedirect This property is required. string
Index This property is required. string
Matches This property is required. []GetErrorpageprofileErrorPageMatch
enable This property is required. String
errorPageBodyRef This property is required. String
errorRedirect This property is required. String
index This property is required. String
matches This property is required. List<GetErrorpageprofileErrorPageMatch>
enable This property is required. string
errorPageBodyRef This property is required. string
errorRedirect This property is required. string
index This property is required. string
matches This property is required. GetErrorpageprofileErrorPageMatch[]
enable This property is required. str
error_page_body_ref This property is required. str
error_redirect This property is required. str
index This property is required. str
matches This property is required. Sequence[GetErrorpageprofileErrorPageMatch]
enable This property is required. String
errorPageBodyRef This property is required. String
errorRedirect This property is required. String
index This property is required. String
matches This property is required. List<Property Map>

GetErrorpageprofileErrorPageMatch

MatchCriteria This property is required. string
Ranges This property is required. List<GetErrorpageprofileErrorPageMatchRange>
StatusCodes This property is required. List<double>
MatchCriteria This property is required. string
Ranges This property is required. []GetErrorpageprofileErrorPageMatchRange
StatusCodes This property is required. []float64
matchCriteria This property is required. String
ranges This property is required. List<GetErrorpageprofileErrorPageMatchRange>
statusCodes This property is required. List<Double>
matchCriteria This property is required. string
ranges This property is required. GetErrorpageprofileErrorPageMatchRange[]
statusCodes This property is required. number[]
match_criteria This property is required. str
ranges This property is required. Sequence[GetErrorpageprofileErrorPageMatchRange]
status_codes This property is required. Sequence[float]
matchCriteria This property is required. String
ranges This property is required. List<Property Map>
statusCodes This property is required. List<Number>

GetErrorpageprofileErrorPageMatchRange

Begin This property is required. string
End This property is required. string
Begin This property is required. string
End This property is required. string
begin This property is required. String
end This property is required. String
begin This property is required. string
end This property is required. string
begin This property is required. str
end This property is required. str
begin This property is required. String
end This property is required. String

GetErrorpageprofileMarker

Key This property is required. string
Values This property is required. List<string>
Key This property is required. string
Values This property is required. []string
key This property is required. String
values This property is required. List<String>
key This property is required. string
values This property is required. string[]
key This property is required. str
values This property is required. Sequence[str]
key This property is required. String
values This property is required. List<String>

Package Details

Repository
avi vmware/terraform-provider-avi
License
Notes
This Pulumi package is based on the avi Terraform Provider.