1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. getGlobalForwardingRule
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi

gcp.compute.getGlobalForwardingRule

Explore with Pulumi AI

Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi

Get a global forwarding rule within GCE from its name.

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",
});
Copy
import pulumi
import pulumi_gcp as gcp

my_forwarding_rule = gcp.compute.get_global_forwarding_rule(name="forwarding-rule-global")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

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

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>
Copy
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]
Copy
func LookupGlobalForwardingRule(ctx *Context, args *LookupGlobalForwardingRuleArgs, opts ...InvokeOption) (*LookupGlobalForwardingRuleResult, error)
func LookupGlobalForwardingRuleOutput(ctx *Context, args *LookupGlobalForwardingRuleOutputArgs, opts ...InvokeOption) LookupGlobalForwardingRuleResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetGlobalForwardingRuleResult> getGlobalForwardingRule(GetGlobalForwardingRuleArgs args, InvokeOptions options)
public static Output<GetGlobalForwardingRuleResult> getGlobalForwardingRule(GetGlobalForwardingRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: gcp:compute/getGlobalForwardingRule:getGlobalForwardingRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 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
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 This property is required. 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 This property is required. string

Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

MATCH_ANY - At least one of the filterLabels must have a matching label in the provided metadata. MATCH_ALL - All filterLabels must have matching labels in the provided metadata. Possible values: ["MATCH_ANY", "MATCH_ALL"]

FilterLabels This property is required. []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 This property is required. string

Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

MATCH_ANY - At least one of the filterLabels must have a matching label in the provided metadata. MATCH_ALL - All filterLabels must have matching labels in the provided metadata. Possible values: ["MATCH_ANY", "MATCH_ALL"]

filterLabels This property is required. 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 This property is required. String

Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

MATCH_ANY - At least one of the filterLabels must have a matching label in the provided metadata. MATCH_ALL - All filterLabels must have matching labels in the provided metadata. Possible values: ["MATCH_ANY", "MATCH_ALL"]

filterLabels This property is required. 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 This property is required. string

Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

MATCH_ANY - At least one of the filterLabels must have a matching label in the provided metadata. MATCH_ALL - All filterLabels must have matching labels in the provided metadata. Possible values: ["MATCH_ANY", "MATCH_ALL"]

filter_labels This property is required. Sequence[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.

filter_match_criteria This property is required. str

Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

MATCH_ANY - At least one of the filterLabels must have a matching label in the provided metadata. MATCH_ALL - All filterLabels must have matching labels in the provided metadata. Possible values: ["MATCH_ANY", "MATCH_ALL"]

filterLabels This property is required. List<Property Map>

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 This property is required. String

Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

MATCH_ANY - At least one of the filterLabels must have a matching label in the provided metadata. MATCH_ALL - All filterLabels must have matching labels in the provided metadata. Possible values: ["MATCH_ANY", "MATCH_ALL"]

GetGlobalForwardingRuleMetadataFilterFilterLabel

Name This property is required. string
The name of the global forwarding rule.


Value This property is required. string
The value that the label must match. The value has a maximum length of 1024 characters.
Name This property is required. string
The name of the global forwarding rule.


Value This property is required. string
The value that the label must match. The value has a maximum length of 1024 characters.
name This property is required. String
The name of the global forwarding rule.


value This property is required. String
The value that the label must match. The value has a maximum length of 1024 characters.
name This property is required. string
The name of the global forwarding rule.


value This property is required. string
The value that the label must match. The value has a maximum length of 1024 characters.
name This property is required. str
The name of the global forwarding rule.


value This property is required. str
The value that the label must match. The value has a maximum length of 1024 characters.
name This property is required. String
The name of the global forwarding rule.


value This property is required. String
The value that the label must match. The value has a maximum length of 1024 characters.

GetGlobalForwardingRuleServiceDirectoryRegistration

Namespace This property is required. string
Service Directory namespace to register the forwarding rule under.
ServiceDirectoryRegion This property is required. string
[Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.
Namespace This property is required. string
Service Directory namespace to register the forwarding rule under.
ServiceDirectoryRegion This property is required. string
[Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.
namespace This property is required. String
Service Directory namespace to register the forwarding rule under.
serviceDirectoryRegion This property is required. String
[Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.
namespace This property is required. string
Service Directory namespace to register the forwarding rule under.
serviceDirectoryRegion This property is required. string
[Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.
namespace This property is required. str
Service Directory namespace to register the forwarding rule under.
service_directory_region This property is required. str
[Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.
namespace This property is required. String
Service Directory namespace to register the forwarding rule under.
serviceDirectoryRegion This property is required. String
[Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.

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.
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi