1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. getTrafficForwardingVIPRecommendedList
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler

zia.getTrafficForwardingVIPRecommendedList

Explore with Pulumi AI

Use the zia_gre_vip_recommended_list data source to get information about a list of recommended GRE tunnel virtual IP addresses (VIPs), based on source IP address or latitude/longitude coordinates.

Example Usage

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

const this = zia.getTrafficForwardingVIPRecommendedList({
    requiredCount: 2,
    sourceIp: "1.1.1.1",
});
Copy
import pulumi
import pulumi_zia as zia

this = zia.get_traffic_forwarding_vip_recommended_list(required_count=2,
    source_ip="1.1.1.1")
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/zscaler/pulumi-zia/sdk/go/zia"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zia.GetTrafficForwardingVIPRecommendedList(ctx, &zia.GetTrafficForwardingVIPRecommendedListArgs{
			RequiredCount: pulumi.IntRef(2),
			SourceIp:      pulumi.StringRef("1.1.1.1"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zia = Pulumi.Zia;

return await Deployment.RunAsync(() => 
{
    var @this = Zia.GetTrafficForwardingVIPRecommendedList.Invoke(new()
    {
        RequiredCount = 2,
        SourceIp = "1.1.1.1",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zia.ZiaFunctions;
import com.pulumi.zia.inputs.GetTrafficForwardingVIPRecommendedListArgs;
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 this = ZiaFunctions.getTrafficForwardingVIPRecommendedList(GetTrafficForwardingVIPRecommendedListArgs.builder()
            .requiredCount(2)
            .sourceIp("1.1.1.1")
            .build());

    }
}
Copy
variables:
  this:
    fn::invoke:
      Function: zia:getTrafficForwardingVIPRecommendedList
      Arguments:
        requiredCount: 2
        sourceIp: 1.1.1.1
Copy

Using getTrafficForwardingVIPRecommendedList

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 getTrafficForwardingVIPRecommendedList(args: GetTrafficForwardingVIPRecommendedListArgs, opts?: InvokeOptions): Promise<GetTrafficForwardingVIPRecommendedListResult>
function getTrafficForwardingVIPRecommendedListOutput(args: GetTrafficForwardingVIPRecommendedListOutputArgs, opts?: InvokeOptions): Output<GetTrafficForwardingVIPRecommendedListResult>
Copy
def get_traffic_forwarding_vip_recommended_list(required_count: Optional[int] = None,
                                                source_ip: Optional[str] = None,
                                                opts: Optional[InvokeOptions] = None) -> GetTrafficForwardingVIPRecommendedListResult
def get_traffic_forwarding_vip_recommended_list_output(required_count: Optional[pulumi.Input[int]] = None,
                                                source_ip: Optional[pulumi.Input[str]] = None,
                                                opts: Optional[InvokeOptions] = None) -> Output[GetTrafficForwardingVIPRecommendedListResult]
Copy
func GetTrafficForwardingVIPRecommendedList(ctx *Context, args *GetTrafficForwardingVIPRecommendedListArgs, opts ...InvokeOption) (*GetTrafficForwardingVIPRecommendedListResult, error)
func GetTrafficForwardingVIPRecommendedListOutput(ctx *Context, args *GetTrafficForwardingVIPRecommendedListOutputArgs, opts ...InvokeOption) GetTrafficForwardingVIPRecommendedListResultOutput
Copy

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

public static class GetTrafficForwardingVIPRecommendedList 
{
    public static Task<GetTrafficForwardingVIPRecommendedListResult> InvokeAsync(GetTrafficForwardingVIPRecommendedListArgs args, InvokeOptions? opts = null)
    public static Output<GetTrafficForwardingVIPRecommendedListResult> Invoke(GetTrafficForwardingVIPRecommendedListInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTrafficForwardingVIPRecommendedListResult> getTrafficForwardingVIPRecommendedList(GetTrafficForwardingVIPRecommendedListArgs args, InvokeOptions options)
public static Output<GetTrafficForwardingVIPRecommendedListResult> getTrafficForwardingVIPRecommendedList(GetTrafficForwardingVIPRecommendedListArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: zia:index/getTrafficForwardingVIPRecommendedList:getTrafficForwardingVIPRecommendedList
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

RequiredCount int
Number of IP address to be exported.
SourceIp string
Filter based on an IP address range.
RequiredCount int
Number of IP address to be exported.
SourceIp string
Filter based on an IP address range.
requiredCount Integer
Number of IP address to be exported.
sourceIp String
Filter based on an IP address range.
requiredCount number
Number of IP address to be exported.
sourceIp string
Filter based on an IP address range.
required_count int
Number of IP address to be exported.
source_ip str
Filter based on an IP address range.
requiredCount Number
Number of IP address to be exported.
sourceIp String
Filter based on an IP address range.

getTrafficForwardingVIPRecommendedList Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Lists List<zscaler.PulumiPackage.Zia.Outputs.GetTrafficForwardingVIPRecommendedListList>
RequiredCount int
SourceIp string
(String) The public source IP address.
Id string
The provider-assigned unique ID for this managed resource.
Lists []GetTrafficForwardingVIPRecommendedListList
RequiredCount int
SourceIp string
(String) The public source IP address.
id String
The provider-assigned unique ID for this managed resource.
lists List<GetTrafficForwardingVIPRecommendedListList>
requiredCount Integer
sourceIp String
(String) The public source IP address.
id string
The provider-assigned unique ID for this managed resource.
lists GetTrafficForwardingVIPRecommendedListList[]
requiredCount number
sourceIp string
(String) The public source IP address.
id str
The provider-assigned unique ID for this managed resource.
lists Sequence[GetTrafficForwardingVIPRecommendedListList]
required_count int
source_ip str
(String) The public source IP address.
id String
The provider-assigned unique ID for this managed resource.
lists List<Property Map>
requiredCount Number
sourceIp String
(String) The public source IP address.

Supporting Types

GetTrafficForwardingVIPRecommendedListList

City This property is required. string
Latitude This property is required. double
Longitude This property is required. double
Region This property is required. string
Datacenter string
(String) Data center information
Id int
Unique identifer of the GRE virtual IP address (VIP)
PrivateServiceEdge bool
(Boolean) Set to true if the virtual IP address (VIP) is a ZIA Private Service Edge
VirtualIp string
(String) GRE cluster virtual IP address (VIP)
City This property is required. string
Latitude This property is required. float64
Longitude This property is required. float64
Region This property is required. string
Datacenter string
(String) Data center information
Id int
Unique identifer of the GRE virtual IP address (VIP)
PrivateServiceEdge bool
(Boolean) Set to true if the virtual IP address (VIP) is a ZIA Private Service Edge
VirtualIp string
(String) GRE cluster virtual IP address (VIP)
city This property is required. String
latitude This property is required. Double
longitude This property is required. Double
region This property is required. String
datacenter String
(String) Data center information
id Integer
Unique identifer of the GRE virtual IP address (VIP)
privateServiceEdge Boolean
(Boolean) Set to true if the virtual IP address (VIP) is a ZIA Private Service Edge
virtualIp String
(String) GRE cluster virtual IP address (VIP)
city This property is required. string
latitude This property is required. number
longitude This property is required. number
region This property is required. string
datacenter string
(String) Data center information
id number
Unique identifer of the GRE virtual IP address (VIP)
privateServiceEdge boolean
(Boolean) Set to true if the virtual IP address (VIP) is a ZIA Private Service Edge
virtualIp string
(String) GRE cluster virtual IP address (VIP)
city This property is required. str
latitude This property is required. float
longitude This property is required. float
region This property is required. str
datacenter str
(String) Data center information
id int
Unique identifer of the GRE virtual IP address (VIP)
private_service_edge bool
(Boolean) Set to true if the virtual IP address (VIP) is a ZIA Private Service Edge
virtual_ip str
(String) GRE cluster virtual IP address (VIP)
city This property is required. String
latitude This property is required. Number
longitude This property is required. Number
region This property is required. String
datacenter String
(String) Data center information
id Number
Unique identifer of the GRE virtual IP address (VIP)
privateServiceEdge Boolean
(Boolean) Set to true if the virtual IP address (VIP) is a ZIA Private Service Edge
virtualIp String
(String) GRE cluster virtual IP address (VIP)

Package Details

Repository
zia zscaler/pulumi-zia
License
MIT
Notes
This Pulumi package is based on the zia Terraform Provider.