forwarding_rules

Creates, updates, deletes, gets or lists a forwarding_rules resource.

Overview

Name	`forwarding_rules`
Type	Resource
Id	`google.compute.forwarding_rules`

Fields

The following fields are returned by SELECT queries:

get
list
aggregated_list

Name	Datatype	Description
`id`	`string (uint64)`	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`name`	`string`	Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`IPAddress`	`string`	IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy andvalidateForProxyless is set to true, theIPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see IP address specifications. When reading an IPAddress, the API always returns the IP address number.
`IPProtocol`	`string`	The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP,AH, SCTP, ICMP andL3_DEFAULT. The valid IP protocols are different for different load balancing products as described in Load balancing features. (AH, ESP, ICMP, L3_DEFAULT, SCTP, TCP, UDP)
`allPorts`	`boolean`	The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The allPorts field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding. - Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.
`allowGlobalAccess`	`boolean`	If set to true, clients can access the internal passthrough Network Load Balancers, the regional internal Application Load Balancer, and the regional internal proxy Network Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created.
`allowPscGlobalAccess`	`boolean`	This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
`attachedExtensions`	`array`	Output only. [Output Only]. The extensions that are attached to this ForwardingRule.
`backendService`	`string`	Identifies the backend service to which the forwarding rule sends traffic. Required for internal and external passthrough Network Load Balancers; must be omitted for all other load balancer types.
`baseForwardingRule`	`string`	Output only. [Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified.
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp inRFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`externalManagedBackendBucketMigrationState`	`string`	Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. (PREPARE, TEST_ALL_TRAFFIC, TEST_BY_PERCENTAGE)
`externalManagedBackendBucketMigrationTestingPercentage`	`number (float)`	Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE.
`fingerprint`	`string (byte)`	Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
`ipCollection`	`string`	Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name
`ipVersion`	`string`	The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. (IPV4, IPV6, UNSPECIFIED_VERSION)
`isMirroringCollector`	`boolean`	Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if aPacketMirroring rule applies to them. This can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.
`kind`	`string`	Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources. (default: compute#forwardingRule)
`labelFingerprint`	`string (byte)`	A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
`labels`	`object`	Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.
`loadBalancingScheme`	`string`	Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. (EXTERNAL, EXTERNAL_MANAGED, INTERNAL, INTERNAL_MANAGED, INTERNAL_SELF_MANAGED, INVALID)
`metadataFilters`	`array`	Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiplemetadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that thisForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
`network`	`string`	This field is not used for global external load balancing. For internal passthrough Network Load Balancers, this field identifies the network that the load balanced IP should belong to for this forwarding rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.
`networkTier`	`string`	This signifies the networking tier used for configuring this load balancer and can only take the following values:PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. (FIXED_STANDARD, PREMIUM, STANDARD, STANDARD_OVERRIDES_FIXED_STANDARD)
`noAutomateDnsZone`	`boolean`	This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field. Once set, this field is not mutable.
`portRange`	`string`	The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The portRange field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN. - Some products have restrictions on what ports can be used. See port specifications for details. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \d+(?:-\d+)?
`ports`	`array`	The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \d+(?:-\d+)?
`pscConnectionId`	`string (uint64)`	[Output Only] The PSC connection id of the PSC forwarding rule.
`pscConnectionStatus`	`string`	(ACCEPTED, CLOSED, NEEDS_ATTENTION, PENDING, REJECTED, STATUS_UNSPECIFIED)
`region`	`string`	Output only. [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`selfLink`	`string`	[Output Only] Server-defined URL for the resource.
`selfLinkWithId`	`string`	Output only. [Output Only] Server-defined URL for this resource with the resource id.
`serviceDirectoryRegistrations`	`array`	Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
`serviceLabel`	`string`	An optional prefix to the service name for this forwarding rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply withRFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`serviceName`	`string`	[Output Only] The internal fully qualified service name for this forwarding rule. This field is only used for internal load balancing.
`sourceIpRanges`	`array`	If not empty, this forwarding rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a forwarding rule can only have up to 64 source IP ranges, and this field can only be used with a regional forwarding rule whose scheme isEXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
`subnetwork`	`string`	This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.
`target`	`string`	The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in Port specifications. - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`items`	`array`	A list of ForwardingRule resources.
`kind`	`string`	Output only. Type of resource. (default: compute#forwardingRuleList)
`nextPageToken`	`string`	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for this resource.
`warning`	`object`	[Output Only] Informational warning message.

Name	Datatype	Description
`id`	`string (uint64)`	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`name`	`string`	Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`IPAddress`	`string`	IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy andvalidateForProxyless is set to true, theIPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see IP address specifications. When reading an IPAddress, the API always returns the IP address number.
`IPProtocol`	`string`	The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP,AH, SCTP, ICMP andL3_DEFAULT. The valid IP protocols are different for different load balancing products as described in Load balancing features. (AH, ESP, ICMP, L3_DEFAULT, SCTP, TCP, UDP)
`allPorts`	`boolean`	The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The allPorts field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding. - Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.
`allowGlobalAccess`	`boolean`	If set to true, clients can access the internal passthrough Network Load Balancers, the regional internal Application Load Balancer, and the regional internal proxy Network Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created.
`allowPscGlobalAccess`	`boolean`	This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
`attachedExtensions`	`array`	Output only. [Output Only]. The extensions that are attached to this ForwardingRule.
`backendService`	`string`	Identifies the backend service to which the forwarding rule sends traffic. Required for internal and external passthrough Network Load Balancers; must be omitted for all other load balancer types.
`baseForwardingRule`	`string`	Output only. [Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified.
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp inRFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`externalManagedBackendBucketMigrationState`	`string`	Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. (PREPARE, TEST_ALL_TRAFFIC, TEST_BY_PERCENTAGE)
`externalManagedBackendBucketMigrationTestingPercentage`	`number (float)`	Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE.
`fingerprint`	`string (byte)`	Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
`ipCollection`	`string`	Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name
`ipVersion`	`string`	The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. (IPV4, IPV6, UNSPECIFIED_VERSION)
`isMirroringCollector`	`boolean`	Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if aPacketMirroring rule applies to them. This can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.
`kind`	`string`	Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources. (default: compute#forwardingRule)
`labelFingerprint`	`string (byte)`	A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
`labels`	`object`	Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.
`loadBalancingScheme`	`string`	Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. (EXTERNAL, EXTERNAL_MANAGED, INTERNAL, INTERNAL_MANAGED, INTERNAL_SELF_MANAGED, INVALID)
`metadataFilters`	`array`	Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiplemetadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that thisForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
`network`	`string`	This field is not used for global external load balancing. For internal passthrough Network Load Balancers, this field identifies the network that the load balanced IP should belong to for this forwarding rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.
`networkTier`	`string`	This signifies the networking tier used for configuring this load balancer and can only take the following values:PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. (FIXED_STANDARD, PREMIUM, STANDARD, STANDARD_OVERRIDES_FIXED_STANDARD)
`noAutomateDnsZone`	`boolean`	This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field. Once set, this field is not mutable.
`portRange`	`string`	The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The portRange field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN. - Some products have restrictions on what ports can be used. See port specifications for details. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \d+(?:-\d+)?
`ports`	`array`	The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \d+(?:-\d+)?
`pscConnectionId`	`string (uint64)`	[Output Only] The PSC connection id of the PSC forwarding rule.
`pscConnectionStatus`	`string`	(ACCEPTED, CLOSED, NEEDS_ATTENTION, PENDING, REJECTED, STATUS_UNSPECIFIED)
`region`	`string`	Output only. [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`selfLink`	`string`	[Output Only] Server-defined URL for the resource.
`selfLinkWithId`	`string`	Output only. [Output Only] Server-defined URL for this resource with the resource id.
`serviceDirectoryRegistrations`	`array`	Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
`serviceLabel`	`string`	An optional prefix to the service name for this forwarding rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply withRFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`serviceName`	`string`	[Output Only] The internal fully qualified service name for this forwarding rule. This field is only used for internal load balancing.
`sourceIpRanges`	`array`	If not empty, this forwarding rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a forwarding rule can only have up to 64 source IP ranges, and this field can only be used with a regional forwarding rule whose scheme isEXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
`subnetwork`	`string`	This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.
`target`	`string`	The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in Port specifications. - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`project`, `forwardingRule`	`view`	Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.
`list`	`select`	`project`	`returnPartialSuccess`, `orderBy`, `filter`, `maxResults`, `pageToken`	Retrieves a list of GlobalForwardingRule resources available to the specified project.
`aggregated_list`	`select`	`project`	`maxResults`, `pageToken`, `filter`, `serviceProjectNumber`, `includeAllScopes`, `orderBy`, `returnPartialSuccess`	Retrieves an aggregated list of forwarding rules. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
`insert`	`insert`	`project`	`requestId`	Creates a GlobalForwardingRule resource in the specified project using the data included in the request.
`patch`	`update`	`project`, `forwardingRule`	`requestId`	Updates the specified forwarding rule with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules. Currently, you can only patch the network_tier field.
`delete`	`delete`	`project`, `forwardingRule`	`requestId`	Deletes the specified GlobalForwardingRule resource.
`set_labels`	`exec`	`project`, `resource`		Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.
`set_target`	`exec`	`project`, `forwardingRule`	`requestId`	Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`forwardingRule`	`string`
`project`	`string`
`resource`	`string`
`filter`	`string`
`includeAllScopes`	`boolean`
`maxResults`	`integer (uint32)`
`orderBy`	`string`
`pageToken`	`string`
`requestId`	`string`
`returnPartialSuccess`	`boolean`
`serviceProjectNumber`	`string (int64)`
`view`	`string`

`SELECT` examples

get
list
aggregated_list

Returns the specified GlobalForwardingRule resource. Gets a list of
available forwarding rules by making a list() request.

SELECT
id,
name,
IPAddress,
IPProtocol,
allPorts,
allowGlobalAccess,
allowPscGlobalAccess,
attachedExtensions,
backendService,
baseForwardingRule,
creationTimestamp,
description,
externalManagedBackendBucketMigrationState,
externalManagedBackendBucketMigrationTestingPercentage,
fingerprint,
ipCollection,
ipVersion,
isMirroringCollector,
kind,
labelFingerprint,
labels,
loadBalancingScheme,
metadataFilters,
network,
networkTier,
noAutomateDnsZone,
portRange,
ports,
pscConnectionId,
pscConnectionStatus,
region,
selfLink,
selfLinkWithId,
serviceDirectoryRegistrations,
serviceLabel,
serviceName,
sourceIpRanges,
subnetwork,
target
FROM google.compute.forwarding_rules
WHERE project = '{{ project }}' -- required
AND forwardingRule = '{{ forwardingRule }}' -- required
AND view = '{{ view }}'
;

Retrieves a list of GlobalForwardingRule resources available to the
specified project.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.forwarding_rules
WHERE project = '{{ project }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
;

Retrieves an aggregated list of forwarding rules.

To prevent failure, it is recommended that you set the
returnPartialSuccess parameter to true.

SELECT
id,
name,
IPAddress,
IPProtocol,
allPorts,
allowGlobalAccess,
allowPscGlobalAccess,
attachedExtensions,
backendService,
baseForwardingRule,
creationTimestamp,
description,
externalManagedBackendBucketMigrationState,
externalManagedBackendBucketMigrationTestingPercentage,
fingerprint,
ipCollection,
ipVersion,
isMirroringCollector,
kind,
labelFingerprint,
labels,
loadBalancingScheme,
metadataFilters,
network,
networkTier,
noAutomateDnsZone,
portRange,
ports,
pscConnectionId,
pscConnectionStatus,
region,
selfLink,
selfLinkWithId,
serviceDirectoryRegistrations,
serviceLabel,
serviceName,
sourceIpRanges,
subnetwork,
target
FROM google.compute.forwarding_rules
WHERE project = '{{ project }}' -- required
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND orderBy = '{{ orderBy }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

`INSERT` examples

insert
Manifest

Creates a GlobalForwardingRule resource in the specified project using
the data included in the request.

INSERT INTO google.compute.forwarding_rules (
data__name,
data__externalManagedBackendBucketMigrationTestingPercentage,
data__allowPscGlobalAccess,
data__target,
data__allowGlobalAccess,
data__description,
data__id,
data__ipCollection,
data__isMirroringCollector,
data__metadataFilters,
data__ipVersion,
data__allPorts,
data__labelFingerprint,
data__IPAddress,
data__loadBalancingScheme,
data__externalManagedBackendBucketMigrationState,
data__ports,
data__labels,
data__IPProtocol,
data__portRange,
data__selfLink,
data__networkTier,
data__pscConnectionId,
data__noAutomateDnsZone,
data__fingerprint,
data__serviceLabel,
data__serviceDirectoryRegistrations,
data__serviceName,
data__subnetwork,
data__backendService,
data__sourceIpRanges,
data__network,
project,
requestId
)
SELECT 
'{{ name }}',
{{ externalManagedBackendBucketMigrationTestingPercentage }},
{{ allowPscGlobalAccess }},
'{{ target }}',
{{ allowGlobalAccess }},
'{{ description }}',
'{{ id }}',
'{{ ipCollection }}',
{{ isMirroringCollector }},
'{{ metadataFilters }}',
'{{ ipVersion }}',
{{ allPorts }},
'{{ labelFingerprint }}',
'{{ IPAddress }}',
'{{ loadBalancingScheme }}',
'{{ externalManagedBackendBucketMigrationState }}',
'{{ ports }}',
'{{ labels }}',
'{{ IPProtocol }}',
'{{ portRange }}',
'{{ selfLink }}',
'{{ networkTier }}',
'{{ pscConnectionId }}',
{{ noAutomateDnsZone }},
'{{ fingerprint }}',
'{{ serviceLabel }}',
'{{ serviceDirectoryRegistrations }}',
'{{ serviceName }}',
'{{ subnetwork }}',
'{{ backendService }}',
'{{ sourceIpRanges }}',
'{{ network }}',
'{{ project }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

# Description fields are for documentation purposes
- name: forwarding_rules
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the forwarding_rules resource.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource; provided by the client when the resource is created.
      The name must be 1-63 characters long, and comply withRFC1035.
      Specifically, the name must be 1-63 characters long and match the regular
      expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      character must be a lowercase letter, and all following characters must
      be a dash, lowercase letter, or digit, except the last character, which
      cannot be a dash.
      For Private Service Connect forwarding rules that forward traffic to Google
      APIs, the forwarding rule name must be a 1-20 characters string with
      lowercase letters and numbers and must start with a letter.
  - name: externalManagedBackendBucketMigrationTestingPercentage
    value: {{ externalManagedBackendBucketMigrationTestingPercentage }}
    description: |
      Determines the fraction of requests to backend buckets that should be
      processed by the global external Application Load Balancer.
      The value of this field must be in the range [0, 100].
      This value can only be set if the loadBalancingScheme in the BackendService
      is set to EXTERNAL (when using the classic Application Load Balancer) and
      the migration state is TEST_BY_PERCENTAGE.
  - name: allowPscGlobalAccess
    value: {{ allowPscGlobalAccess }}
    description: |
      This is used in PSC consumer ForwardingRule to control whether the PSC
      endpoint can be accessed from another region.
  - name: target
    value: "{{ target }}"
    description: |
      The URL of the target resource to receive the matched traffic.  For
      regional forwarding rules, this target must be in the same region as the
      forwarding rule. For global forwarding rules, this target must be a global
      load balancing resource.
      The forwarded traffic must be of a type appropriate to the target object.
      -  For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
      -  For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
      -  vpc-sc -  APIs that support VPC Service Controls.
      -  all-apis - All supported Google APIs.
      -  For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.
  - name: allowGlobalAccess
    value: {{ allowGlobalAccess }}
    description: |
      If set to true, clients can access the internal passthrough Network Load
      Balancers, the regional internal Application Load Balancer, and the
      regional internal proxy Network Load Balancer from all regions.
      If false, only allows access from the local region the load balancer is
      located at. Note that for INTERNAL_MANAGED forwarding rules, this field
      cannot be changed after the forwarding rule is created.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: id
    value: "{{ id }}"
    description: |
      [Output Only] The unique identifier for the resource. This identifier is
      defined by the server.
  - name: ipCollection
    value: "{{ ipCollection }}"
    description: |
      Resource reference of a PublicDelegatedPrefix. The PDP must
      be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.
      Use one of the following formats to specify a sub-PDP when creating an IPv6
      NetLB forwarding rule using BYOIP:
      Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
      Partial URL, as in:
      - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
      - regions/region/publicDelegatedPrefixes/sub-pdp-name
  - name: isMirroringCollector
    value: {{ isMirroringCollector }}
    description: |
      Indicates whether or not this load balancer can be used as a collector for
      packet mirroring. To prevent mirroring loops, instances behind this
      load balancer will not have their traffic mirrored even if aPacketMirroring rule applies to them.
      This can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.
  - name: metadataFilters
    description: |
      Opaque filter criteria used by load balancer to restrict routing
      configuration to a limited set of xDS
      compliant clients. In their xDS requests to load balancer, xDS clients
      present node
      metadata. When there is a match, the relevant configuration
      is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)
      referenced by the ForwardingRule are not visible to
      those proxies.
      For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in
      the metadata. If its filterMatchCriteria is set to
      MATCH_ALL, then all of its filterLabels must match with
      corresponding labels provided in the metadata. If multiplemetadataFilters are specified, all of them need to be satisfied
      in order to be considered a match.
      metadataFilters specified here will be applifed before
      those specified in the UrlMap that thisForwardingRule references.
      metadataFilters only applies to Loadbalancers that have
      their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
    value:
      - filterMatchCriteria: "{{ filterMatchCriteria }}"
        filterLabels: "{{ filterLabels }}"
  - name: ipVersion
    value: "{{ ipVersion }}"
    description: |
      The IP Version that will be used by this forwarding rule.  Valid options
      are IPV4 or IPV6.
    valid_values: ['IPV4', 'IPV6', 'UNSPECIFIED_VERSION']
  - name: allPorts
    value: {{ allPorts }}
    description: |
      The ports, portRange, and allPorts
      fields are mutually exclusive. Only packets addressed to ports in the
      specified range will be forwarded to the backends configured with this
      forwarding rule.
      The allPorts field has the following limitations:
      - It requires that the forwarding rule IPProtocol be TCP,
      UDP, SCTP, or L3_DEFAULT.
      - It's applicable only to the following products: internal passthrough
      Network Load Balancers, backend service-based external passthrough Network
      Load Balancers, and internal and external protocol forwarding.
      - Set this field to true to allow packets addressed to any port or
      packets lacking destination port information (for example, UDP fragments
      after the first fragment) to be forwarded to the backends configured with
      this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.
  - name: labelFingerprint
    value: "{{ labelFingerprint }}"
    description: |
      A fingerprint for the labels being applied to this resource, which is
      essentially a hash of the labels set used for optimistic locking. The
      fingerprint is initially generated by Compute Engine and changes after
      every request to modify or update labels. You must always provide an
      up-to-date fingerprint hash in order to update or change labels,
      otherwise the request will fail with error412 conditionNotMet.
      To see the latest fingerprint, make a get() request to
      retrieve a ForwardingRule.
  - name: IPAddress
    value: "{{ IPAddress }}"
    description: |
      IP address for which this forwarding rule accepts traffic. When a client
      sends traffic to this IP address, the forwarding rule directs the traffic
      to the referenced target or backendService.
      While creating a forwarding rule, specifying an IPAddress is
      required under the following circumstances:
      - When the target is set to targetGrpcProxy andvalidateForProxyless is set to true, theIPAddress should be set to 0.0.0.0.
      - When the target is a Private Service Connect Google APIs
      bundle, you must specify an IPAddress.
      Otherwise, you can optionally specify an IP address that references an
      existing static (reserved) IP address resource. When omitted, Google Cloud
      assigns an ephemeral IP address.
      Use one of the following formats to specify an IP address while creating a
      forwarding rule:
      * IP address number, as in `100.1.2.3`
      * IPv6 address range, as in `2600:1234::/96`
      * Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name
      * Partial URL or by name, as in:
      - projects/project_id/regions/region/addresses/address-name
      - regions/region/addresses/address-name
      - global/addresses/address-name
      - address-name
      The forwarding rule's target or backendService,
      and in most cases, also the loadBalancingScheme, determine the
      type of IP address that you can use. For detailed information, see
      [IP address
      specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
      When reading an IPAddress, the API always returns the IP
      address number.
  - name: loadBalancingScheme
    value: "{{ loadBalancingScheme }}"
    description: |
      Specifies the forwarding rule type.
      For more information about forwarding rules, refer to
      Forwarding rule concepts.
    valid_values: ['EXTERNAL', 'EXTERNAL_MANAGED', 'INTERNAL', 'INTERNAL_MANAGED', 'INTERNAL_SELF_MANAGED', 'INVALID']
  - name: externalManagedBackendBucketMigrationState
    value: "{{ externalManagedBackendBucketMigrationState }}"
    description: |
      Specifies the canary migration state for the backend buckets attached to
      this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and
      TEST_ALL_TRAFFIC.
      To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
      changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
      the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
      TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets
      attached to this forwarding rule by percentage using
      externalManagedBackendBucketMigrationTestingPercentage.
      Rolling back a migration requires the states to be set in reverse order. So
      changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
      be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
      TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
      EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
    valid_values: ['PREPARE', 'TEST_ALL_TRAFFIC', 'TEST_BY_PERCENTAGE']
  - name: ports
    value:
      - "{{ ports }}"
    description: |
      The ports, portRange, and allPorts
      fields are mutually exclusive. Only packets addressed to ports in the
      specified range will be forwarded to the backends configured with this
      forwarding rule.
      The ports field has the following limitations:
      - It requires that the forwarding rule IPProtocol be TCP,
      UDP, or SCTP, and
      - It's applicable only to the following products: internal passthrough
      Network Load Balancers, backend service-based external passthrough Network
      Load Balancers, and internal protocol forwarding.
      - You can specify a list of up to five ports by number, separated by
      commas. The ports can be contiguous or discontiguous.
      For external forwarding rules, two or more forwarding rules cannot use the
      same [IPAddress, IPProtocol] pair if they share at least one
      port number.
      For internal forwarding rules within the same VPC network, two or more
      forwarding rules cannot use the same [IPAddress, IPProtocol]
      pair if they share at least one port number.
      @pattern: \d+(?:-\d+)?
  - name: labels
    value: "{{ labels }}"
    description: |
      Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
      Label values may be empty.
  - name: IPProtocol
    value: "{{ IPProtocol }}"
    description: |
      The IP protocol to which this rule applies.
      For protocol forwarding, valid
      options are TCP, UDP, ESP,AH, SCTP, ICMP andL3_DEFAULT.
      The valid IP protocols are different for different load balancing products
      as described in [Load balancing
      features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
    valid_values: ['AH', 'ESP', 'ICMP', 'L3_DEFAULT', 'SCTP', 'TCP', 'UDP']
  - name: portRange
    value: "{{ portRange }}"
    description: |
      The ports, portRange, and allPorts
      fields are mutually exclusive. Only packets addressed to ports in the
      specified range will be forwarded to the backends configured with this
      forwarding rule.
      The portRange field has the following limitations:
      - It requires that the forwarding rule IPProtocol be TCP,
      UDP, or SCTP, and
      - It's applicable only to the following products: external passthrough
      Network Load Balancers, internal and external proxy Network Load Balancers,
      internal and external Application Load Balancers, external protocol
      forwarding, and Classic VPN.
      - Some products have restrictions on what ports can be used. See
      port specifications for details.
      For external forwarding rules, two or more forwarding rules cannot use the
      same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges.
      For internal forwarding rules within the same VPC network, two or more
      forwarding rules cannot use the same [IPAddress, IPProtocol]
      pair, and cannot have overlapping portRanges.
      @pattern: \d+(?:-\d+)?
  - name: selfLink
    value: "{{ selfLink }}"
    description: |
      [Output Only] Server-defined URL for the resource.
  - name: networkTier
    value: "{{ networkTier }}"
    description: |
      This signifies the networking tier used for configuring
      this load balancer and can only take the following values:PREMIUM, STANDARD.
      For regional ForwardingRule, the valid values are PREMIUM andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM.
      If this field is not specified, it is assumed to be PREMIUM.
      If IPAddress is specified, this value must be equal to the
      networkTier of the Address.
    valid_values: ['FIXED_STANDARD', 'PREMIUM', 'STANDARD', 'STANDARD_OVERRIDES_FIXED_STANDARD']
  - name: pscConnectionId
    value: "{{ pscConnectionId }}"
    description: |
      [Output Only] The PSC connection id of the PSC forwarding rule.
  - name: noAutomateDnsZone
    value: {{ noAutomateDnsZone }}
    description: |
      This is used in PSC consumer ForwardingRule to control whether it should
      try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use
      this field. Once set, this field is not mutable.
  - name: fingerprint
    value: "{{ fingerprint }}"
    description: |
      Fingerprint of this resource. A hash of the contents stored in this object.
      This field is used in optimistic locking. This field will be ignored when
      inserting a ForwardingRule. Include the fingerprint in patch request to
      ensure that you do not overwrite changes that were applied from another
      concurrent request.
      To see the latest fingerprint, make a get() request to
      retrieve a ForwardingRule.
  - name: serviceLabel
    value: "{{ serviceLabel }}"
    description: |
      An optional prefix to the service name for this forwarding rule.
      If specified, the prefix is the first label of the fully qualified service
      name.
      The label must be 1-63 characters long, and comply withRFC1035.
      Specifically, the label must be 1-63 characters long and match the regular
      expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      character must be a lowercase letter, and all following characters must
      be a dash, lowercase letter, or digit, except the last character, which
      cannot be a dash.
      This field is only used for internal load balancing.
  - name: serviceDirectoryRegistrations
    description: |
      Service Directory resources to register this forwarding rule with.
      Currently, only supports a single Service Directory resource.
    value:
      - namespace: "{{ namespace }}"
        service: "{{ service }}"
        serviceDirectoryRegion: "{{ serviceDirectoryRegion }}"
  - name: serviceName
    value: "{{ serviceName }}"
    description: |
      [Output Only]
      The internal fully qualified service name for this forwarding rule.
      This field is only used for internal load balancing.
  - name: subnetwork
    value: "{{ subnetwork }}"
    description: |
      This field identifies the subnetwork that the load balanced IP should
      belong to for this forwarding rule, used with internal load balancers and
      external passthrough Network Load Balancers with IPv6.
      If the network specified is in auto subnet mode, this field is optional.
      However, a subnetwork must be specified if the network is in custom subnet
      mode or when creating external forwarding rule with IPv6.
  - name: backendService
    value: "{{ backendService }}"
    description: |
      Identifies the backend service to which the forwarding rule sends traffic.
      Required for internal and external passthrough Network Load Balancers;
      must be omitted for all other load balancer types.
  - name: sourceIpRanges
    value:
      - "{{ sourceIpRanges }}"
    description: |
      If not empty, this forwarding rule will only forward the traffic when the
      source IP address matches one of the IP addresses or CIDR ranges set here.
      Note that a forwarding rule can only have up to 64 source IP ranges, and
      this field can only be used with a regional forwarding rule whose scheme isEXTERNAL.
      Each source_ip_range entry should be either an IP address (for
      example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
  - name: network
    value: "{{ network }}"
    description: |
      This field is not used for global external load balancing.
      For internal passthrough Network Load Balancers, this field identifies the
      network that the load balanced IP should belong to for this forwarding
      rule.
      If the subnetwork is specified, the network of the subnetwork will be used.
      If neither subnetwork nor this field is specified, the default network will
      be used.
      For Private Service Connect forwarding rules that forward traffic to Google
      APIs, a network must be provided.
  - name: requestId
    value: "{{ requestId }}"

`UPDATE` examples

patch

Updates the specified forwarding rule with the data included in the
request. This method supportsPATCH
semantics and uses theJSON merge
patch format and processing rules. Currently, you can only
patch the network_tier field.

UPDATE google.compute.forwarding_rules
SET 
data__name = '{{ name }}',
data__externalManagedBackendBucketMigrationTestingPercentage = {{ externalManagedBackendBucketMigrationTestingPercentage }},
data__allowPscGlobalAccess = {{ allowPscGlobalAccess }},
data__target = '{{ target }}',
data__allowGlobalAccess = {{ allowGlobalAccess }},
data__description = '{{ description }}',
data__id = '{{ id }}',
data__ipCollection = '{{ ipCollection }}',
data__isMirroringCollector = {{ isMirroringCollector }},
data__metadataFilters = '{{ metadataFilters }}',
data__ipVersion = '{{ ipVersion }}',
data__allPorts = {{ allPorts }},
data__labelFingerprint = '{{ labelFingerprint }}',
data__IPAddress = '{{ IPAddress }}',
data__loadBalancingScheme = '{{ loadBalancingScheme }}',
data__externalManagedBackendBucketMigrationState = '{{ externalManagedBackendBucketMigrationState }}',
data__ports = '{{ ports }}',
data__labels = '{{ labels }}',
data__IPProtocol = '{{ IPProtocol }}',
data__portRange = '{{ portRange }}',
data__selfLink = '{{ selfLink }}',
data__networkTier = '{{ networkTier }}',
data__pscConnectionId = '{{ pscConnectionId }}',
data__noAutomateDnsZone = {{ noAutomateDnsZone }},
data__fingerprint = '{{ fingerprint }}',
data__serviceLabel = '{{ serviceLabel }}',
data__serviceDirectoryRegistrations = '{{ serviceDirectoryRegistrations }}',
data__serviceName = '{{ serviceName }}',
data__subnetwork = '{{ subnetwork }}',
data__backendService = '{{ backendService }}',
data__sourceIpRanges = '{{ sourceIpRanges }}',
data__network = '{{ network }}'
WHERE 
project = '{{ project }}' --required
AND forwardingRule = '{{ forwardingRule }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

`DELETE` examples

delete

Deletes the specified GlobalForwardingRule resource.

DELETE FROM google.compute.forwarding_rules
WHERE project = '{{ project }}' --required
AND forwardingRule = '{{ forwardingRule }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods

set_labels
set_target

Sets the labels on the specified resource. To learn more about labels,
read the
Labeling resources documentation.

EXEC google.compute.forwarding_rules.set_labels 
@project='{{ project }}' --required, 
@resource='{{ resource }}' --required 
@@json=
'{
"labels": "{{ labels }}", 
"labelFingerprint": "{{ labelFingerprint }}"
}'
;

Changes target URL for the GlobalForwardingRule resource. The new target
should be of the same type as the old target.

EXEC google.compute.forwarding_rules.set_target 
@project='{{ project }}' --required, 
@forwardingRule='{{ forwardingRule }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"target": "{{ target }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​