Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. getForwardingControlZPAGateway
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zia

zia.getForwardingControlZPAGateway

Explore with Pulumi AI

zia logo
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zia

    Use the forwarding_control_zpa_gateway data source to get information about a forwarding control zpa gateway used in IP Source Anchoring integration between Zscaler Internet Access and Zscaler Private Access. This data source can then be associated with a ZIA Forwarding Control Rule.

    Example Usage

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

const this = zia.getForwardingControlZPAGateway({
    name: "ZPA_GW01",
});

    import pulumi
import pulumi_zia as zia

this = zia.get_forwarding_control_zpa_gateway(name="ZPA_GW01")

    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.LookupForwardingControlZPAGateway(ctx, &zia.LookupForwardingControlZPAGatewayArgs{
			Name: pulumi.StringRef("ZPA_GW01"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zia = Pulumi.Zia;

return await Deployment.RunAsync(() => 
{
    var @this = Zia.GetForwardingControlZPAGateway.Invoke(new()
    {
        Name = "ZPA_GW01",
    });

});

    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.GetForwardingControlZPAGatewayArgs;
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.getForwardingControlZPAGateway(GetForwardingControlZPAGatewayArgs.builder()
            .name("ZPA_GW01")
            .build());

    }
}

    variables:
  this:
    fn::invoke:
      Function: zia:getForwardingControlZPAGateway
      Arguments:
        name: ZPA_GW01

    Using getForwardingControlZPAGateway

    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 getForwardingControlZPAGateway(args: GetForwardingControlZPAGatewayArgs, opts?: InvokeOptions): Promise<GetForwardingControlZPAGatewayResult>
function getForwardingControlZPAGatewayOutput(args: GetForwardingControlZPAGatewayOutputArgs, opts?: InvokeOptions): Output<GetForwardingControlZPAGatewayResult>
    def get_forwarding_control_zpa_gateway(id: Optional[int] = None,
                                       name: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetForwardingControlZPAGatewayResult
def get_forwarding_control_zpa_gateway_output(id: Optional[pulumi.Input[int]] = None,
                                       name: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetForwardingControlZPAGatewayResult]
    func LookupForwardingControlZPAGateway(ctx *Context, args *LookupForwardingControlZPAGatewayArgs, opts ...InvokeOption) (*LookupForwardingControlZPAGatewayResult, error)
func LookupForwardingControlZPAGatewayOutput(ctx *Context, args *LookupForwardingControlZPAGatewayOutputArgs, opts ...InvokeOption) LookupForwardingControlZPAGatewayResultOutput

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

    public static class GetForwardingControlZPAGateway 
{
    public static Task<GetForwardingControlZPAGatewayResult> InvokeAsync(GetForwardingControlZPAGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetForwardingControlZPAGatewayResult> Invoke(GetForwardingControlZPAGatewayInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetForwardingControlZPAGatewayResult> getForwardingControlZPAGateway(GetForwardingControlZPAGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: zia:index/getForwardingControlZPAGateway:getForwardingControlZPAGateway
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id int
    The ID of the forwarding control ZPA Gateway resource.
    Name string
    The name of the forwarding control ZPA Gateway to be exported.
    Id int
    The ID of the forwarding control ZPA Gateway resource.
    Name string
    The name of the forwarding control ZPA Gateway to be exported.
    id Integer
    The ID of the forwarding control ZPA Gateway resource.
    name String
    The name of the forwarding control ZPA Gateway to be exported.
    id number
    The ID of the forwarding control ZPA Gateway resource.
    name string
    The name of the forwarding control ZPA Gateway to be exported.
    id int
    The ID of the forwarding control ZPA Gateway resource.
    name str
    The name of the forwarding control ZPA Gateway to be exported.
    id Number
    The ID of the forwarding control ZPA Gateway resource.
    name String
    The name of the forwarding control ZPA Gateway to be exported.

    getForwardingControlZPAGateway Result

    The following output properties are available:

    Description string
    (string) - Additional details about the ZPA gateway
    Id int
    (int) - Identifier that uniquely identifies an entity
    LastModifiedBies List<zscaler.PulumiPackage.Zia.Outputs.GetForwardingControlZPAGatewayLastModifiedBy>
    (list) - Information about the admin user that last modified the ZPA gateway
    LastModifiedTime int
    (int) - Timestamp when the ZPA gateway was last modified
    Name string
    (string) The configured name of the entity
    Type string
    (string) - Indicates whether the ZPA gateway is configured for Zscaler Internet Access (using option ZPA) or Zscaler Cloud Connector (using option ECZPA)
    ZpaAppSegments List<zscaler.PulumiPackage.Zia.Outputs.GetForwardingControlZPAGatewayZpaAppSegment>
    ZpaServerGroups List<zscaler.PulumiPackage.Zia.Outputs.GetForwardingControlZPAGatewayZpaServerGroup>
    () - The ZPA Server Group that is configured for Source IP Anchoring
    ZpaTenantId int
    Description string
    (string) - Additional details about the ZPA gateway
    Id int
    (int) - Identifier that uniquely identifies an entity
    LastModifiedBies []GetForwardingControlZPAGatewayLastModifiedBy
    (list) - Information about the admin user that last modified the ZPA gateway
    LastModifiedTime int
    (int) - Timestamp when the ZPA gateway was last modified
    Name string
    (string) The configured name of the entity
    Type string
    (string) - Indicates whether the ZPA gateway is configured for Zscaler Internet Access (using option ZPA) or Zscaler Cloud Connector (using option ECZPA)
    ZpaAppSegments []GetForwardingControlZPAGatewayZpaAppSegment
    ZpaServerGroups []GetForwardingControlZPAGatewayZpaServerGroup
    () - The ZPA Server Group that is configured for Source IP Anchoring
    ZpaTenantId int
    description String
    (string) - Additional details about the ZPA gateway
    id Integer
    (int) - Identifier that uniquely identifies an entity
    lastModifiedBies List<GetForwardingControlZPAGatewayLastModifiedBy>
    (list) - Information about the admin user that last modified the ZPA gateway
    lastModifiedTime Integer
    (int) - Timestamp when the ZPA gateway was last modified
    name String
    (string) The configured name of the entity
    type String
    (string) - Indicates whether the ZPA gateway is configured for Zscaler Internet Access (using option ZPA) or Zscaler Cloud Connector (using option ECZPA)
    zpaAppSegments List<GetForwardingControlZPAGatewayZpaAppSegment>
    zpaServerGroups List<GetForwardingControlZPAGatewayZpaServerGroup>
    () - The ZPA Server Group that is configured for Source IP Anchoring
    zpaTenantId Integer
    description string
    (string) - Additional details about the ZPA gateway
    id number
    (int) - Identifier that uniquely identifies an entity
    lastModifiedBies GetForwardingControlZPAGatewayLastModifiedBy[]
    (list) - Information about the admin user that last modified the ZPA gateway
    lastModifiedTime number
    (int) - Timestamp when the ZPA gateway was last modified
    name string
    (string) The configured name of the entity
    type string
    (string) - Indicates whether the ZPA gateway is configured for Zscaler Internet Access (using option ZPA) or Zscaler Cloud Connector (using option ECZPA)
    zpaAppSegments GetForwardingControlZPAGatewayZpaAppSegment[]
    zpaServerGroups GetForwardingControlZPAGatewayZpaServerGroup[]
    () - The ZPA Server Group that is configured for Source IP Anchoring
    zpaTenantId number
    description str
    (string) - Additional details about the ZPA gateway
    id int
    (int) - Identifier that uniquely identifies an entity
    last_modified_bies Sequence[GetForwardingControlZPAGatewayLastModifiedBy]
    (list) - Information about the admin user that last modified the ZPA gateway
    last_modified_time int
    (int) - Timestamp when the ZPA gateway was last modified
    name str
    (string) The configured name of the entity
    type str
    (string) - Indicates whether the ZPA gateway is configured for Zscaler Internet Access (using option ZPA) or Zscaler Cloud Connector (using option ECZPA)
    zpa_app_segments Sequence[GetForwardingControlZPAGatewayZpaAppSegment]
    zpa_server_groups Sequence[GetForwardingControlZPAGatewayZpaServerGroup]
    () - The ZPA Server Group that is configured for Source IP Anchoring
    zpa_tenant_id int
    description String
    (string) - Additional details about the ZPA gateway
    id Number
    (int) - Identifier that uniquely identifies an entity
    lastModifiedBies List<Property Map>
    (list) - Information about the admin user that last modified the ZPA gateway
    lastModifiedTime Number
    (int) - Timestamp when the ZPA gateway was last modified
    name String
    (string) The configured name of the entity
    type String
    (string) - Indicates whether the ZPA gateway is configured for Zscaler Internet Access (using option ZPA) or Zscaler Cloud Connector (using option ECZPA)
    zpaAppSegments List<Property Map>
    zpaServerGroups List<Property Map>
    () - The ZPA Server Group that is configured for Source IP Anchoring
    zpaTenantId Number

    Supporting Types

    GetForwardingControlZPAGatewayLastModifiedBy

    Extensions Dictionary<string, string>
    Id int
    The ID of the forwarding control ZPA Gateway resource.
    Name string
    The name of the forwarding control ZPA Gateway to be exported.
    Extensions map[string]string
    Id int
    The ID of the forwarding control ZPA Gateway resource.
    Name string
    The name of the forwarding control ZPA Gateway to be exported.
    extensions Map<String,String>
    id Integer
    The ID of the forwarding control ZPA Gateway resource.
    name String
    The name of the forwarding control ZPA Gateway to be exported.
    extensions {[key: string]: string}
    id number
    The ID of the forwarding control ZPA Gateway resource.
    name string
    The name of the forwarding control ZPA Gateway to be exported.
    extensions Mapping[str, str]
    id int
    The ID of the forwarding control ZPA Gateway resource.
    name str
    The name of the forwarding control ZPA Gateway to be exported.
    extensions Map<String>
    id Number
    The ID of the forwarding control ZPA Gateway resource.
    name String
    The name of the forwarding control ZPA Gateway to be exported.

    GetForwardingControlZPAGatewayZpaAppSegment

    ExternalId string
    (string) An external identifier used for an entity that is managed outside of ZIA. Examples include zpaServerGroup and zpaAppSegments. This field is not applicable to ZIA-managed entities.
    Name string
    The name of the forwarding control ZPA Gateway to be exported.
    ExternalId string
    (string) An external identifier used for an entity that is managed outside of ZIA. Examples include zpaServerGroup and zpaAppSegments. This field is not applicable to ZIA-managed entities.
    Name string
    The name of the forwarding control ZPA Gateway to be exported.
    externalId String
    (string) An external identifier used for an entity that is managed outside of ZIA. Examples include zpaServerGroup and zpaAppSegments. This field is not applicable to ZIA-managed entities.
    name String
    The name of the forwarding control ZPA Gateway to be exported.
    externalId string
    (string) An external identifier used for an entity that is managed outside of ZIA. Examples include zpaServerGroup and zpaAppSegments. This field is not applicable to ZIA-managed entities.
    name string
    The name of the forwarding control ZPA Gateway to be exported.
    external_id str
    (string) An external identifier used for an entity that is managed outside of ZIA. Examples include zpaServerGroup and zpaAppSegments. This field is not applicable to ZIA-managed entities.
    name str
    The name of the forwarding control ZPA Gateway to be exported.
    externalId String
    (string) An external identifier used for an entity that is managed outside of ZIA. Examples include zpaServerGroup and zpaAppSegments. This field is not applicable to ZIA-managed entities.
    name String
    The name of the forwarding control ZPA Gateway to be exported.

    GetForwardingControlZPAGatewayZpaServerGroup

    ExternalId string
    (string) An external identifier used for an entity that is managed outside of ZIA. Examples include zpaServerGroup and zpaAppSegments. This field is not applicable to ZIA-managed entities.
    Name string
    The name of the forwarding control ZPA Gateway to be exported.
    ExternalId string
    (string) An external identifier used for an entity that is managed outside of ZIA. Examples include zpaServerGroup and zpaAppSegments. This field is not applicable to ZIA-managed entities.
    Name string
    The name of the forwarding control ZPA Gateway to be exported.
    externalId String
    (string) An external identifier used for an entity that is managed outside of ZIA. Examples include zpaServerGroup and zpaAppSegments. This field is not applicable to ZIA-managed entities.
    name String
    The name of the forwarding control ZPA Gateway to be exported.
    externalId string
    (string) An external identifier used for an entity that is managed outside of ZIA. Examples include zpaServerGroup and zpaAppSegments. This field is not applicable to ZIA-managed entities.
    name string
    The name of the forwarding control ZPA Gateway to be exported.
    external_id str
    (string) An external identifier used for an entity that is managed outside of ZIA. Examples include zpaServerGroup and zpaAppSegments. This field is not applicable to ZIA-managed entities.
    name str
    The name of the forwarding control ZPA Gateway to be exported.
    externalId String
    (string) An external identifier used for an entity that is managed outside of ZIA. Examples include zpaServerGroup and zpaAppSegments. This field is not applicable to ZIA-managed entities.
    name String
    The name of the forwarding control ZPA Gateway to be exported.

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    MIT
    Notes
    This Pulumi package is based on the zia Terraform Provider.
    zia logo
    Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
    zscaler/pulumi-zia