1. Packages
  2. Vcd Provider
  3. API Docs
  4. getNsxtAlbVirtualServiceHttpRespRules
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.getNsxtAlbVirtualServiceHttpRespRules

Explore with Pulumi AI

Supported in provider v3.14+ and VCD 10.5+ with NSX-T and ALB.

Provides a data source to read ALB Service Engine Groups policies for HTTP responses. HTTP response rules can be used to to evaluate and modify the response and response attributes that the application returns.

Example Usage

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

const response_rules = vcd.getNsxtAlbVirtualServiceHttpRespRules({
    virtualServiceId: vcd_nsxt_alb_virtual_service.test.id,
});
Copy
import pulumi
import pulumi_vcd as vcd

response_rules = vcd.get_nsxt_alb_virtual_service_http_resp_rules(virtual_service_id=vcd_nsxt_alb_virtual_service["test"]["id"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vcd.LookupNsxtAlbVirtualServiceHttpRespRules(ctx, &vcd.LookupNsxtAlbVirtualServiceHttpRespRulesArgs{
			VirtualServiceId: vcd_nsxt_alb_virtual_service.Test.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vcd = Pulumi.Vcd;

return await Deployment.RunAsync(() => 
{
    var response_rules = Vcd.GetNsxtAlbVirtualServiceHttpRespRules.Invoke(new()
    {
        VirtualServiceId = vcd_nsxt_alb_virtual_service.Test.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetNsxtAlbVirtualServiceHttpRespRulesArgs;
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 response-rules = VcdFunctions.getNsxtAlbVirtualServiceHttpRespRules(GetNsxtAlbVirtualServiceHttpRespRulesArgs.builder()
            .virtualServiceId(vcd_nsxt_alb_virtual_service.test().id())
            .build());

    }
}
Copy
variables:
  response-rules:
    fn::invoke:
      function: vcd:getNsxtAlbVirtualServiceHttpRespRules
      arguments:
        virtualServiceId: ${vcd_nsxt_alb_virtual_service.test.id}
Copy

Using getNsxtAlbVirtualServiceHttpRespRules

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 getNsxtAlbVirtualServiceHttpRespRules(args: GetNsxtAlbVirtualServiceHttpRespRulesArgs, opts?: InvokeOptions): Promise<GetNsxtAlbVirtualServiceHttpRespRulesResult>
function getNsxtAlbVirtualServiceHttpRespRulesOutput(args: GetNsxtAlbVirtualServiceHttpRespRulesOutputArgs, opts?: InvokeOptions): Output<GetNsxtAlbVirtualServiceHttpRespRulesResult>
Copy
def get_nsxt_alb_virtual_service_http_resp_rules(id: Optional[str] = None,
                                                 virtual_service_id: Optional[str] = None,
                                                 opts: Optional[InvokeOptions] = None) -> GetNsxtAlbVirtualServiceHttpRespRulesResult
def get_nsxt_alb_virtual_service_http_resp_rules_output(id: Optional[pulumi.Input[str]] = None,
                                                 virtual_service_id: Optional[pulumi.Input[str]] = None,
                                                 opts: Optional[InvokeOptions] = None) -> Output[GetNsxtAlbVirtualServiceHttpRespRulesResult]
Copy
func LookupNsxtAlbVirtualServiceHttpRespRules(ctx *Context, args *LookupNsxtAlbVirtualServiceHttpRespRulesArgs, opts ...InvokeOption) (*LookupNsxtAlbVirtualServiceHttpRespRulesResult, error)
func LookupNsxtAlbVirtualServiceHttpRespRulesOutput(ctx *Context, args *LookupNsxtAlbVirtualServiceHttpRespRulesOutputArgs, opts ...InvokeOption) LookupNsxtAlbVirtualServiceHttpRespRulesResultOutput
Copy

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

public static class GetNsxtAlbVirtualServiceHttpRespRules 
{
    public static Task<GetNsxtAlbVirtualServiceHttpRespRulesResult> InvokeAsync(GetNsxtAlbVirtualServiceHttpRespRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetNsxtAlbVirtualServiceHttpRespRulesResult> Invoke(GetNsxtAlbVirtualServiceHttpRespRulesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNsxtAlbVirtualServiceHttpRespRulesResult> getNsxtAlbVirtualServiceHttpRespRules(GetNsxtAlbVirtualServiceHttpRespRulesArgs args, InvokeOptions options)
public static Output<GetNsxtAlbVirtualServiceHttpRespRulesResult> getNsxtAlbVirtualServiceHttpRespRules(GetNsxtAlbVirtualServiceHttpRespRulesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: vcd:index/getNsxtAlbVirtualServiceHttpRespRules:getNsxtAlbVirtualServiceHttpRespRules
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

VirtualServiceId This property is required. string
An ID of existing ALB Virtual Service.
Id string
VirtualServiceId This property is required. string
An ID of existing ALB Virtual Service.
Id string
virtualServiceId This property is required. String
An ID of existing ALB Virtual Service.
id String
virtualServiceId This property is required. string
An ID of existing ALB Virtual Service.
id string
virtual_service_id This property is required. str
An ID of existing ALB Virtual Service.
id str
virtualServiceId This property is required. String
An ID of existing ALB Virtual Service.
id String

getNsxtAlbVirtualServiceHttpRespRules Result

The following output properties are available:

Supporting Types

GetNsxtAlbVirtualServiceHttpRespRulesRule

Actions This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleAction>
Active This property is required. bool
Logging This property is required. bool
MatchCriterias This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteria>
Name This property is required. string
Actions This property is required. []GetNsxtAlbVirtualServiceHttpRespRulesRuleAction
Active This property is required. bool
Logging This property is required. bool
MatchCriterias This property is required. []GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteria
Name This property is required. string
actions This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleAction>
active This property is required. Boolean
logging This property is required. Boolean
matchCriterias This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteria>
name This property is required. String
actions This property is required. GetNsxtAlbVirtualServiceHttpRespRulesRuleAction[]
active This property is required. boolean
logging This property is required. boolean
matchCriterias This property is required. GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteria[]
name This property is required. string
actions This property is required. Sequence[GetNsxtAlbVirtualServiceHttpRespRulesRuleAction]
active This property is required. bool
logging This property is required. bool
match_criterias This property is required. Sequence[GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteria]
name This property is required. str
actions This property is required. List<Property Map>
active This property is required. Boolean
logging This property is required. Boolean
matchCriterias This property is required. List<Property Map>
name This property is required. String

GetNsxtAlbVirtualServiceHttpRespRulesRuleAction

modifyHeaders This property is required. List<Property Map>
rewriteLocationHeaders This property is required. List<Property Map>

GetNsxtAlbVirtualServiceHttpRespRulesRuleActionModifyHeader

Action This property is required. string
Name This property is required. string
Value This property is required. string
Action This property is required. string
Name This property is required. string
Value This property is required. string
action This property is required. String
name This property is required. String
value This property is required. String
action This property is required. string
name This property is required. string
value This property is required. string
action This property is required. str
name This property is required. str
value This property is required. str
action This property is required. String
name This property is required. String
value This property is required. String

GetNsxtAlbVirtualServiceHttpRespRulesRuleActionRewriteLocationHeader

Host This property is required. string
KeepQuery This property is required. bool
Path This property is required. string
Port This property is required. string
Protocol This property is required. string
Host This property is required. string
KeepQuery This property is required. bool
Path This property is required. string
Port This property is required. string
Protocol This property is required. string
host This property is required. String
keepQuery This property is required. Boolean
path This property is required. String
port This property is required. String
protocol This property is required. String
host This property is required. string
keepQuery This property is required. boolean
path This property is required. string
port This property is required. string
protocol This property is required. string
host This property is required. str
keep_query This property is required. bool
path This property is required. str
port This property is required. str
protocol This property is required. str
host This property is required. String
keepQuery This property is required. Boolean
path This property is required. String
port This property is required. String
protocol This property is required. String

GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteria

ClientIpAddresses This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaClientIpAddress>
Cookies This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaCookie>
HttpMethods This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaHttpMethod>
LocationHeaders This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaLocationHeader>
Paths This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaPath>
ProtocolType This property is required. string
Queries This property is required. List<string>
RequestHeaders This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaRequestHeader>
ResponseHeaders This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaResponseHeader>
ServicePorts This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaServicePort>
StatusCodes This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaStatusCode>
ClientIpAddresses This property is required. []GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaClientIpAddress
Cookies This property is required. []GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaCookie
HttpMethods This property is required. []GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaHttpMethod
LocationHeaders This property is required. []GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaLocationHeader
Paths This property is required. []GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaPath
ProtocolType This property is required. string
Queries This property is required. []string
RequestHeaders This property is required. []GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaRequestHeader
ResponseHeaders This property is required. []GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaResponseHeader
ServicePorts This property is required. []GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaServicePort
StatusCodes This property is required. []GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaStatusCode
clientIpAddresses This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaClientIpAddress>
cookies This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaCookie>
httpMethods This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaHttpMethod>
locationHeaders This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaLocationHeader>
paths This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaPath>
protocolType This property is required. String
queries This property is required. List<String>
requestHeaders This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaRequestHeader>
responseHeaders This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaResponseHeader>
servicePorts This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaServicePort>
statusCodes This property is required. List<GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaStatusCode>
client_ip_addresses This property is required. Sequence[GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaClientIpAddress]
cookies This property is required. Sequence[GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaCookie]
http_methods This property is required. Sequence[GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaHttpMethod]
location_headers This property is required. Sequence[GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaLocationHeader]
paths This property is required. Sequence[GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaPath]
protocol_type This property is required. str
queries This property is required. Sequence[str]
request_headers This property is required. Sequence[GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaRequestHeader]
response_headers This property is required. Sequence[GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaResponseHeader]
service_ports This property is required. Sequence[GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaServicePort]
status_codes This property is required. Sequence[GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaStatusCode]
clientIpAddresses This property is required. List<Property Map>
cookies This property is required. List<Property Map>
httpMethods This property is required. List<Property Map>
locationHeaders This property is required. List<Property Map>
paths This property is required. List<Property Map>
protocolType This property is required. String
queries This property is required. List<String>
requestHeaders This property is required. List<Property Map>
responseHeaders This property is required. List<Property Map>
servicePorts This property is required. List<Property Map>
statusCodes This property is required. List<Property Map>

GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaClientIpAddress

Criteria This property is required. string
IpAddresses This property is required. List<string>
Criteria This property is required. string
IpAddresses This property is required. []string
criteria This property is required. String
ipAddresses This property is required. List<String>
criteria This property is required. string
ipAddresses This property is required. string[]
criteria This property is required. str
ip_addresses This property is required. Sequence[str]
criteria This property is required. String
ipAddresses This property is required. List<String>

GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaCookie

Criteria This property is required. string
Name This property is required. string
Value This property is required. string
Criteria This property is required. string
Name This property is required. string
Value This property is required. string
criteria This property is required. String
name This property is required. String
value This property is required. String
criteria This property is required. string
name This property is required. string
value This property is required. string
criteria This property is required. str
name This property is required. str
value This property is required. str
criteria This property is required. String
name This property is required. String
value This property is required. String

GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaHttpMethod

Criteria This property is required. string
Methods This property is required. List<string>
Criteria This property is required. string
Methods This property is required. []string
criteria This property is required. String
methods This property is required. List<String>
criteria This property is required. string
methods This property is required. string[]
criteria This property is required. str
methods This property is required. Sequence[str]
criteria This property is required. String
methods This property is required. List<String>

GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaLocationHeader

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

GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaPath

Criteria This property is required. string
Paths This property is required. List<string>
Criteria This property is required. string
Paths This property is required. []string
criteria This property is required. String
paths This property is required. List<String>
criteria This property is required. string
paths This property is required. string[]
criteria This property is required. str
paths This property is required. Sequence[str]
criteria This property is required. String
paths This property is required. List<String>

GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaRequestHeader

Criteria This property is required. string
Name This property is required. string
Values This property is required. List<string>
Criteria This property is required. string
Name This property is required. string
Values This property is required. []string
criteria This property is required. String
name This property is required. String
values This property is required. List<String>
criteria This property is required. string
name This property is required. string
values This property is required. string[]
criteria This property is required. str
name This property is required. str
values This property is required. Sequence[str]
criteria This property is required. String
name This property is required. String
values This property is required. List<String>

GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaResponseHeader

Criteria This property is required. string
Name This property is required. string
Values This property is required. List<string>
Criteria This property is required. string
Name This property is required. string
Values This property is required. []string
criteria This property is required. String
name This property is required. String
values This property is required. List<String>
criteria This property is required. string
name This property is required. string
values This property is required. string[]
criteria This property is required. str
name This property is required. str
values This property is required. Sequence[str]
criteria This property is required. String
name This property is required. String
values This property is required. List<String>

GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaServicePort

Criteria This property is required. string
Ports This property is required. List<double>
Criteria This property is required. string
Ports This property is required. []float64
criteria This property is required. String
ports This property is required. List<Double>
criteria This property is required. string
ports This property is required. number[]
criteria This property is required. str
ports This property is required. Sequence[float]
criteria This property is required. String
ports This property is required. List<Number>

GetNsxtAlbVirtualServiceHttpRespRulesRuleMatchCriteriaStatusCode

Criteria This property is required. string
HttpStatusCode This property is required. string
Criteria This property is required. string
HttpStatusCode This property is required. string
criteria This property is required. String
httpStatusCode This property is required. String
criteria This property is required. string
httpStatusCode This property is required. string
criteria This property is required. str
http_status_code This property is required. str
criteria This property is required. String
httpStatusCode This property is required. String

Package Details

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