1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. beyondcorp
  5. getSecurityGateway
Google Cloud v9.4.0 published on Tuesday, Nov 4, 2025 by Pulumi

gcp.beyondcorp.getSecurityGateway

Start a Neo task
Explain and create a gcp.beyondcorp.getSecurityGateway resource
gcp logo
Google Cloud v9.4.0 published on Tuesday, Nov 4, 2025 by Pulumi

    Get information about a Google BeyondCorp Security Gateway.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const my_beyondcorp_security_gateway = gcp.beyondcorp.getSecurityGateway({
        securityGatewayId: "my-beyondcorp-security-gateway",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    my_beyondcorp_security_gateway = gcp.beyondcorp.get_security_gateway(security_gateway_id="my-beyondcorp-security-gateway")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/beyondcorp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := beyondcorp.LookupSecurityGateway(ctx, &beyondcorp.LookupSecurityGatewayArgs{
    			SecurityGatewayId: "my-beyondcorp-security-gateway",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var my_beyondcorp_security_gateway = Gcp.Beyondcorp.GetSecurityGateway.Invoke(new()
        {
            SecurityGatewayId = "my-beyondcorp-security-gateway",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.beyondcorp.BeyondcorpFunctions;
    import com.pulumi.gcp.beyondcorp.inputs.GetSecurityGatewayArgs;
    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 my-beyondcorp-security-gateway = BeyondcorpFunctions.getSecurityGateway(GetSecurityGatewayArgs.builder()
                .securityGatewayId("my-beyondcorp-security-gateway")
                .build());
    
        }
    }
    
    variables:
      my-beyondcorp-security-gateway:
        fn::invoke:
          function: gcp:beyondcorp:getSecurityGateway
          arguments:
            securityGatewayId: my-beyondcorp-security-gateway
    

    Using getSecurityGateway

    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 getSecurityGateway(args: GetSecurityGatewayArgs, opts?: InvokeOptions): Promise<GetSecurityGatewayResult>
    function getSecurityGatewayOutput(args: GetSecurityGatewayOutputArgs, opts?: InvokeOptions): Output<GetSecurityGatewayResult>
    def get_security_gateway(project: Optional[str] = None,
                             security_gateway_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetSecurityGatewayResult
    def get_security_gateway_output(project: Optional[pulumi.Input[str]] = None,
                             security_gateway_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetSecurityGatewayResult]
    func LookupSecurityGateway(ctx *Context, args *LookupSecurityGatewayArgs, opts ...InvokeOption) (*LookupSecurityGatewayResult, error)
    func LookupSecurityGatewayOutput(ctx *Context, args *LookupSecurityGatewayOutputArgs, opts ...InvokeOption) LookupSecurityGatewayResultOutput

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

    public static class GetSecurityGateway 
    {
        public static Task<GetSecurityGatewayResult> InvokeAsync(GetSecurityGatewayArgs args, InvokeOptions? opts = null)
        public static Output<GetSecurityGatewayResult> Invoke(GetSecurityGatewayInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSecurityGatewayResult> getSecurityGateway(GetSecurityGatewayArgs args, InvokeOptions options)
    public static Output<GetSecurityGatewayResult> getSecurityGateway(GetSecurityGatewayArgs args, InvokeOptions options)
    
    fn::invoke:
      function: gcp:beyondcorp/getSecurityGateway:getSecurityGateway
      arguments:
        # arguments dictionary

    The following arguments are supported:

    SecurityGatewayId string
    The name of the Security Gateway resource.


    Project string
    The project in which the resource belongs. If it is not provided, the provider project is used.
    SecurityGatewayId string
    The name of the Security Gateway resource.


    Project string
    The project in which the resource belongs. If it is not provided, the provider project is used.
    securityGatewayId String
    The name of the Security Gateway resource.


    project String
    The project in which the resource belongs. If it is not provided, the provider project is used.
    securityGatewayId string
    The name of the Security Gateway resource.


    project string
    The project in which the resource belongs. If it is not provided, the provider project is used.
    security_gateway_id str
    The name of the Security Gateway resource.


    project str
    The project in which the resource belongs. If it is not provided, the provider project is used.
    securityGatewayId String
    The name of the Security Gateway resource.


    project String
    The project in which the resource belongs. If it is not provided, the provider project is used.

    getSecurityGateway Result

    The following output properties are available:

    createTime String
    delegatingServiceAccount String
    displayName String
    externalIps List<String>
    hubs List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    name String
    proxyProtocolConfigs List<Property Map>
    securityGatewayId String
    serviceDiscoveries List<Property Map>
    state String
    updateTime String
    project String

    Supporting Types

    GetSecurityGatewayHub

    internetGateways List<Property Map>
    Internet Gateway configuration.
    region String

    GetSecurityGatewayHubInternetGateway

    AssignedIps List<string>
    Output only. List of IP addresses assigned to the Cloud NAT.
    AssignedIps []string
    Output only. List of IP addresses assigned to the Cloud NAT.
    assignedIps List<String>
    Output only. List of IP addresses assigned to the Cloud NAT.
    assignedIps string[]
    Output only. List of IP addresses assigned to the Cloud NAT.
    assigned_ips Sequence[str]
    Output only. List of IP addresses assigned to the Cloud NAT.
    assignedIps List<String>
    Output only. List of IP addresses assigned to the Cloud NAT.

    GetSecurityGatewayProxyProtocolConfig

    AllowedClientHeaders List<string>
    The configuration for the proxy.
    ClientIp bool
    Client IP configuration. The client IP address is included if true.
    ContextualHeaders List<GetSecurityGatewayProxyProtocolConfigContextualHeader>
    Configuration for the contextual headers.
    GatewayIdentity string
    Gateway identity configuration. Possible values: ["RESOURCE_NAME"]
    MetadataHeaders Dictionary<string, string>

    Custom resource specific headers along with the values. The names should conform to RFC 9110:

    Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.

    AllowedClientHeaders []string
    The configuration for the proxy.
    ClientIp bool
    Client IP configuration. The client IP address is included if true.
    ContextualHeaders []GetSecurityGatewayProxyProtocolConfigContextualHeader
    Configuration for the contextual headers.
    GatewayIdentity string
    Gateway identity configuration. Possible values: ["RESOURCE_NAME"]
    MetadataHeaders map[string]string

    Custom resource specific headers along with the values. The names should conform to RFC 9110:

    Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.

    allowedClientHeaders List<String>
    The configuration for the proxy.
    clientIp Boolean
    Client IP configuration. The client IP address is included if true.
    contextualHeaders List<GetSecurityGatewayProxyProtocolConfigContextualHeader>
    Configuration for the contextual headers.
    gatewayIdentity String
    Gateway identity configuration. Possible values: ["RESOURCE_NAME"]
    metadataHeaders Map<String,String>

    Custom resource specific headers along with the values. The names should conform to RFC 9110:

    Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.

    allowedClientHeaders string[]
    The configuration for the proxy.
    clientIp boolean
    Client IP configuration. The client IP address is included if true.
    contextualHeaders GetSecurityGatewayProxyProtocolConfigContextualHeader[]
    Configuration for the contextual headers.
    gatewayIdentity string
    Gateway identity configuration. Possible values: ["RESOURCE_NAME"]
    metadataHeaders {[key: string]: string}

    Custom resource specific headers along with the values. The names should conform to RFC 9110:

    Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.

    allowed_client_headers Sequence[str]
    The configuration for the proxy.
    client_ip bool
    Client IP configuration. The client IP address is included if true.
    contextual_headers Sequence[GetSecurityGatewayProxyProtocolConfigContextualHeader]
    Configuration for the contextual headers.
    gateway_identity str
    Gateway identity configuration. Possible values: ["RESOURCE_NAME"]
    metadata_headers Mapping[str, str]

    Custom resource specific headers along with the values. The names should conform to RFC 9110:

    Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.

    allowedClientHeaders List<String>
    The configuration for the proxy.
    clientIp Boolean
    Client IP configuration. The client IP address is included if true.
    contextualHeaders List<Property Map>
    Configuration for the contextual headers.
    gatewayIdentity String
    Gateway identity configuration. Possible values: ["RESOURCE_NAME"]
    metadataHeaders Map<String>

    Custom resource specific headers along with the values. The names should conform to RFC 9110:

    Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.

    GetSecurityGatewayProxyProtocolConfigContextualHeader

    DeviceInfos List<GetSecurityGatewayProxyProtocolConfigContextualHeaderDeviceInfo>
    Device info configuration.
    GroupInfos List<GetSecurityGatewayProxyProtocolConfigContextualHeaderGroupInfo>
    Group info configuration.
    OutputType string
    Default output type for all enabled headers. Possible values: ["PROTOBUF", "JSON", "NONE"]
    UserInfos List<GetSecurityGatewayProxyProtocolConfigContextualHeaderUserInfo>
    User info configuration.
    DeviceInfos []GetSecurityGatewayProxyProtocolConfigContextualHeaderDeviceInfo
    Device info configuration.
    GroupInfos []GetSecurityGatewayProxyProtocolConfigContextualHeaderGroupInfo
    Group info configuration.
    OutputType string
    Default output type for all enabled headers. Possible values: ["PROTOBUF", "JSON", "NONE"]
    UserInfos []GetSecurityGatewayProxyProtocolConfigContextualHeaderUserInfo
    User info configuration.
    deviceInfos List<GetSecurityGatewayProxyProtocolConfigContextualHeaderDeviceInfo>
    Device info configuration.
    groupInfos List<GetSecurityGatewayProxyProtocolConfigContextualHeaderGroupInfo>
    Group info configuration.
    outputType String
    Default output type for all enabled headers. Possible values: ["PROTOBUF", "JSON", "NONE"]
    userInfos List<GetSecurityGatewayProxyProtocolConfigContextualHeaderUserInfo>
    User info configuration.
    deviceInfos GetSecurityGatewayProxyProtocolConfigContextualHeaderDeviceInfo[]
    Device info configuration.
    groupInfos GetSecurityGatewayProxyProtocolConfigContextualHeaderGroupInfo[]
    Group info configuration.
    outputType string
    Default output type for all enabled headers. Possible values: ["PROTOBUF", "JSON", "NONE"]
    userInfos GetSecurityGatewayProxyProtocolConfigContextualHeaderUserInfo[]
    User info configuration.
    deviceInfos List<Property Map>
    Device info configuration.
    groupInfos List<Property Map>
    Group info configuration.
    outputType String
    Default output type for all enabled headers. Possible values: ["PROTOBUF", "JSON", "NONE"]
    userInfos List<Property Map>
    User info configuration.

    GetSecurityGatewayProxyProtocolConfigContextualHeaderDeviceInfo

    OutputType string
    The output type of the delegated device info. Possible values: ["PROTOBUF", "JSON", "NONE"]
    OutputType string
    The output type of the delegated device info. Possible values: ["PROTOBUF", "JSON", "NONE"]
    outputType String
    The output type of the delegated device info. Possible values: ["PROTOBUF", "JSON", "NONE"]
    outputType string
    The output type of the delegated device info. Possible values: ["PROTOBUF", "JSON", "NONE"]
    output_type str
    The output type of the delegated device info. Possible values: ["PROTOBUF", "JSON", "NONE"]
    outputType String
    The output type of the delegated device info. Possible values: ["PROTOBUF", "JSON", "NONE"]

    GetSecurityGatewayProxyProtocolConfigContextualHeaderGroupInfo

    OutputType string
    The output type of the delegated group info. Possible values: ["PROTOBUF", "JSON", "NONE"]
    OutputType string
    The output type of the delegated group info. Possible values: ["PROTOBUF", "JSON", "NONE"]
    outputType String
    The output type of the delegated group info. Possible values: ["PROTOBUF", "JSON", "NONE"]
    outputType string
    The output type of the delegated group info. Possible values: ["PROTOBUF", "JSON", "NONE"]
    output_type str
    The output type of the delegated group info. Possible values: ["PROTOBUF", "JSON", "NONE"]
    outputType String
    The output type of the delegated group info. Possible values: ["PROTOBUF", "JSON", "NONE"]

    GetSecurityGatewayProxyProtocolConfigContextualHeaderUserInfo

    OutputType string
    The output type of the delegated user info. Possible values: ["PROTOBUF", "JSON", "NONE"]
    OutputType string
    The output type of the delegated user info. Possible values: ["PROTOBUF", "JSON", "NONE"]
    outputType String
    The output type of the delegated user info. Possible values: ["PROTOBUF", "JSON", "NONE"]
    outputType string
    The output type of the delegated user info. Possible values: ["PROTOBUF", "JSON", "NONE"]
    output_type str
    The output type of the delegated user info. Possible values: ["PROTOBUF", "JSON", "NONE"]
    outputType String
    The output type of the delegated user info. Possible values: ["PROTOBUF", "JSON", "NONE"]

    GetSecurityGatewayServiceDiscovery

    apiGateways List<Property Map>
    External API configuration.

    GetSecurityGatewayServiceDiscoveryApiGateway

    ResourceOverrides List<GetSecurityGatewayServiceDiscoveryApiGatewayResourceOverride>
    Enables fetching resource model updates to alter service behavior per Chrome profile.
    ResourceOverrides []GetSecurityGatewayServiceDiscoveryApiGatewayResourceOverride
    Enables fetching resource model updates to alter service behavior per Chrome profile.
    resourceOverrides List<GetSecurityGatewayServiceDiscoveryApiGatewayResourceOverride>
    Enables fetching resource model updates to alter service behavior per Chrome profile.
    resourceOverrides GetSecurityGatewayServiceDiscoveryApiGatewayResourceOverride[]
    Enables fetching resource model updates to alter service behavior per Chrome profile.
    resource_overrides Sequence[GetSecurityGatewayServiceDiscoveryApiGatewayResourceOverride]
    Enables fetching resource model updates to alter service behavior per Chrome profile.
    resourceOverrides List<Property Map>
    Enables fetching resource model updates to alter service behavior per Chrome profile.

    GetSecurityGatewayServiceDiscoveryApiGatewayResourceOverride

    Path string
    Contains uri path fragment where HTTP request is sent.
    Path string
    Contains uri path fragment where HTTP request is sent.
    path String
    Contains uri path fragment where HTTP request is sent.
    path string
    Contains uri path fragment where HTTP request is sent.
    path str
    Contains uri path fragment where HTTP request is sent.
    path String
    Contains uri path fragment where HTTP request is sent.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v9.4.0 published on Tuesday, Nov 4, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate