gcp.compute.getGlobalForwardingRule

Explore with Pulumi AI

Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi

Example Usage

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

const my_forwarding_rule = gcp.compute.getGlobalForwardingRule({
    name: "forwarding-rule-global",
});

import pulumi
import pulumi_gcp as gcp

my_forwarding_rule = gcp.compute.get_global_forwarding_rule(name="forwarding-rule-global")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.LookupGlobalForwardingRule(ctx, &compute.LookupGlobalForwardingRuleArgs{
			Name: "forwarding-rule-global",
		}, 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_forwarding_rule = Gcp.Compute.GetGlobalForwardingRule.Invoke(new()
    {
        Name = "forwarding-rule-global",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetGlobalForwardingRuleArgs;
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-forwarding-rule = ComputeFunctions.getGlobalForwardingRule(GetGlobalForwardingRuleArgs.builder()
            .name("forwarding-rule-global")
            .build());

    }
}

variables:
  my-forwarding-rule:
    fn::invoke:
      function: gcp:compute:getGlobalForwardingRule
      arguments:
        name: forwarding-rule-global

Using getGlobalForwardingRule

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 getGlobalForwardingRule(args: GetGlobalForwardingRuleArgs, opts?: InvokeOptions): Promise<GetGlobalForwardingRuleResult>
function getGlobalForwardingRuleOutput(args: GetGlobalForwardingRuleOutputArgs, opts?: InvokeOptions): Output<GetGlobalForwardingRuleResult>

def get_global_forwarding_rule(name: Optional[str] = None,
                               project: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetGlobalForwardingRuleResult
def get_global_forwarding_rule_output(name: Optional[pulumi.Input[str]] = None,
                               project: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetGlobalForwardingRuleResult]

func LookupGlobalForwardingRule(ctx *Context, args *LookupGlobalForwardingRuleArgs, opts ...InvokeOption) (*LookupGlobalForwardingRuleResult, error)
func LookupGlobalForwardingRuleOutput(ctx *Context, args *LookupGlobalForwardingRuleOutputArgs, opts ...InvokeOption) LookupGlobalForwardingRuleResultOutput

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

public static class GetGlobalForwardingRule 
{
    public static Task<GetGlobalForwardingRuleResult> InvokeAsync(GetGlobalForwardingRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetGlobalForwardingRuleResult> Invoke(GetGlobalForwardingRuleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGlobalForwardingRuleResult> getGlobalForwardingRule(GetGlobalForwardingRuleArgs args, InvokeOptions options)
public static Output<GetGlobalForwardingRuleResult> getGlobalForwardingRule(GetGlobalForwardingRuleArgs args, InvokeOptions options)

fn::invoke:
  function: gcp:compute/getGlobalForwardingRule:getGlobalForwardingRule
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the global forwarding rule.
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.

Name string: The name of the global forwarding rule.
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.

name String: The name of the global forwarding rule.
project String: The project in which the resource belongs. If it is not provided, the provider project is used.

name string: The name of the global forwarding rule.
project string: The project in which the resource belongs. If it is not provided, the provider project is used.

name str: The name of the global forwarding rule.
project str: The project in which the resource belongs. If it is not provided, the provider project is used.

name String: The name of the global forwarding rule.
project String: The project in which the resource belongs. If it is not provided, the provider project is used.

getGlobalForwardingRule Result

The following output properties are available:

AllowPscGlobalAccess bool
BaseForwardingRule string
Description string
EffectiveLabels Dictionary<string, string>
ForwardingRuleId int
Id string: The provider-assigned unique ID for this managed resource.
IpAddress string
IpProtocol string
IpVersion string
LabelFingerprint string
Labels Dictionary<string, string>
LoadBalancingScheme string
MetadataFilters List<GetGlobalForwardingRuleMetadataFilter>
Name string
Network string
NetworkTier string
NoAutomateDnsZone bool
PortRange string
PscConnectionId string
PscConnectionStatus string
PulumiLabels Dictionary<string, string>
SelfLink string
ServiceDirectoryRegistrations List<GetGlobalForwardingRuleServiceDirectoryRegistration>
SourceIpRanges List<string>
Subnetwork string
Target string
Project string

AllowPscGlobalAccess bool
BaseForwardingRule string
Description string
EffectiveLabels map[string]string
ForwardingRuleId int
Id string: The provider-assigned unique ID for this managed resource.
IpAddress string
IpProtocol string
IpVersion string
LabelFingerprint string
Labels map[string]string
LoadBalancingScheme string
MetadataFilters []GetGlobalForwardingRuleMetadataFilter
Name string
Network string
NetworkTier string
NoAutomateDnsZone bool
PortRange string
PscConnectionId string
PscConnectionStatus string
PulumiLabels map[string]string
SelfLink string
ServiceDirectoryRegistrations []GetGlobalForwardingRuleServiceDirectoryRegistration
SourceIpRanges []string
Subnetwork string
Target string
Project string

allowPscGlobalAccess Boolean
baseForwardingRule String
description String
effectiveLabels Map<String,String>
forwardingRuleId Integer
id String: The provider-assigned unique ID for this managed resource.
ipAddress String
ipProtocol String
ipVersion String
labelFingerprint String
labels Map<String,String>
loadBalancingScheme String
metadataFilters List<GetGlobalForwardingRuleMetadataFilter>
name String
network String
networkTier String
noAutomateDnsZone Boolean
portRange String
pscConnectionId String
pscConnectionStatus String
pulumiLabels Map<String,String>
selfLink String
serviceDirectoryRegistrations List<GetGlobalForwardingRuleServiceDirectoryRegistration>
sourceIpRanges List<String>
subnetwork String
target String
project String

allowPscGlobalAccess boolean
baseForwardingRule string
description string
effectiveLabels {[key: string]: string}
forwardingRuleId number
id string: The provider-assigned unique ID for this managed resource.
ipAddress string
ipProtocol string
ipVersion string
labelFingerprint string
labels {[key: string]: string}
loadBalancingScheme string
metadataFilters GetGlobalForwardingRuleMetadataFilter[]
name string
network string
networkTier string
noAutomateDnsZone boolean
portRange string
pscConnectionId string
pscConnectionStatus string
pulumiLabels {[key: string]: string}
selfLink string
serviceDirectoryRegistrations GetGlobalForwardingRuleServiceDirectoryRegistration[]
sourceIpRanges string[]
subnetwork string
target string
project string

allow_psc_global_access bool
base_forwarding_rule str
description str
effective_labels Mapping[str, str]
forwarding_rule_id int
id str: The provider-assigned unique ID for this managed resource.
ip_address str
ip_protocol str
ip_version str
label_fingerprint str
labels Mapping[str, str]
load_balancing_scheme str
metadata_filters Sequence[GetGlobalForwardingRuleMetadataFilter]
name str
network str
network_tier str
no_automate_dns_zone bool
port_range str
psc_connection_id str
psc_connection_status str
pulumi_labels Mapping[str, str]
self_link str
service_directory_registrations Sequence[GetGlobalForwardingRuleServiceDirectoryRegistration]
source_ip_ranges Sequence[str]
subnetwork str
target str
project str

allowPscGlobalAccess Boolean
baseForwardingRule String
description String
effectiveLabels Map<String>
forwardingRuleId Number
id String: The provider-assigned unique ID for this managed resource.
ipAddress String
ipProtocol String
ipVersion String
labelFingerprint String
labels Map<String>
loadBalancingScheme String
metadataFilters List<Property Map>
name String
network String
networkTier String
noAutomateDnsZone Boolean
portRange String
pscConnectionId String
pscConnectionStatus String
pulumiLabels Map<String>
selfLink String
serviceDirectoryRegistrations List<Property Map>
sourceIpRanges List<String>
subnetwork String
target String
project String

Supporting Types

GetGlobalForwardingRuleMetadataFilter

FilterLabels List<GetGlobalForwardingRuleMetadataFilterFilterLabel>

The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

This list must not be empty and can have at the most 64 entries.

FilterMatchCriteria string