Reference documentation and code samples for the Compute Engine v1 API enum TCPHealthCheck.Types.PortSpecification.
Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.
A value indicating that the enum field is not set.
UseFixedPort
The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.
UseNamedPort
Not supported.
UseServingPort
For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-08 UTC."],[[["\u003cp\u003eThis document provides versioned reference documentation for the \u003ccode\u003eTCPHealthCheck.Types.PortSpecification\u003c/code\u003e enum within the Google Cloud Compute Engine v1 API, with versions ranging from 1.0.0 to the latest version 3.6.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eTCPHealthCheck.Types.PortSpecification\u003c/code\u003e enum details the different methods for specifying a port for health checking, which are: \u003ccode\u003eUseFixedPort\u003c/code\u003e, \u003ccode\u003eUseNamedPort\u003c/code\u003e, and \u003ccode\u003eUseServingPort\u003c/code\u003e, with \u003ccode\u003eUndefinedPortSpecification\u003c/code\u003e as a value for when the field is not set.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eUseFixedPort\u003c/code\u003e allows direct specification of a port for health checking, \u003ccode\u003eUseNamedPort\u003c/code\u003e is not currently supported, and \u003ccode\u003eUseServingPort\u003c/code\u003e uses the port from the network endpoint or instance group configuration.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of this document is for version 3.6.0 which is shown at the top of the list of documented version numbers, with many previous versions going back to version 1.0.0.\u003c/p\u003e\n"]]],[],null,[]]
