network_endpoint_groups

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

Overview

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

Fields

Name	Datatype	Description
`id`	`string`	[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 with RFC1035. 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.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`annotations`	`object`	Metadata defined as annotations on the network endpoint group.
`appEngine`	`object`	Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.
`cloudFunction`	`object`	Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.
`cloudRun`	`object`	Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG.
`creationTimestamp`	`string`	[Output Only] Creation timestamp in RFC3339 text format.
`defaultPort`	`integer`	The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.
`kind`	`string`	[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
`network`	`string`	The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified.
`networkEndpointType`	`string`	Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP.
`pscData`	`object`	All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT.
`pscTargetService`	`string`	The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com
`region`	`string`	[Output Only] The URL of the region where the network endpoint group is located.
`selfLink`	`string`	[Output Only] Server-defined URL for the resource.
`size`	`integer`	[Output only] Number of network endpoints in the network endpoint group.
`subnetwork`	`string`	Optional URL of the subnetwork to which all network endpoints in the NEG belong.
`zone`	`string`	[Output Only] The URL of the zone where the network endpoint group is located.

Methods

Name	Accessible by	Required Params	Description
`aggregated_list`	`SELECT`	`project`	Retrieves the list of network endpoint groups and sorts them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
`get`	`SELECT`	`networkEndpointGroup, project, zone`	Returns the specified network endpoint group.
`list`	`SELECT`	`project, zone`	Retrieves the list of network endpoint groups that are located in the specified project and zone.
`insert`	`INSERT`	`project, zone`	Creates a network endpoint group in the specified project using the parameters that are included in the request.
`delete`	`DELETE`	`networkEndpointGroup, project, zone`	Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.
`attach_network_endpoints`	`EXEC`	`networkEndpointGroup, project, zone`	Attach a list of network endpoints to the specified network endpoint group.
`detach_network_endpoints`	`EXEC`	`networkEndpointGroup, project, zone`	Detach a list of network endpoints from the specified network endpoint group.

`SELECT` examples

Retrieves the list of network endpoint groups and sorts them by zone. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

SELECT
id,
name,
description,
annotations,
appEngine,
cloudFunction,
cloudRun,
creationTimestamp,
defaultPort,
kind,
network,
networkEndpointType,
pscData,
pscTargetService,
region,
selfLink,
size,
subnetwork,
zone
FROM google.compute.network_endpoint_groups
WHERE project = '{{ project }}';

`INSERT` example

Use the following StackQL query and manifest file to create a new network_endpoint_groups resource.

All Properties
Manifest

/*+ create */
INSERT INTO google.compute.network_endpoint_groups (
project,
zone,
name,
description,
networkEndpointType,
size,
region,
zone,
network,
subnetwork,
defaultPort,
annotations,
cloudRun,
appEngine,
cloudFunction,
pscTargetService,
pscData
)
SELECT 
'{{ project }}',
'{{ zone }}',
'{{ name }}',
'{{ description }}',
'{{ networkEndpointType }}',
'{{ size }}',
'{{ region }}',
'{{ zone }}',
'{{ network }}',
'{{ subnetwork }}',
'{{ defaultPort }}',
'{{ annotations }}',
'{{ cloudRun }}',
'{{ appEngine }}',
'{{ cloudFunction }}',
'{{ pscTargetService }}',
'{{ pscData }}'
;

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: selfLink
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: networkEndpointType
      value: string
    - name: size
      value: integer
    - name: region
      value: string
    - name: zone
      value: string
    - name: network
      value: string
    - name: subnetwork
      value: string
    - name: defaultPort
      value: integer
    - name: annotations
      value: object
    - name: cloudRun
      value:
        - name: service
          value: string
        - name: tag
          value: string
        - name: urlMask
          value: string
    - name: appEngine
      value:
        - name: service
          value: string
        - name: version
          value: string
        - name: urlMask
          value: string
    - name: cloudFunction
      value:
        - name: function
          value: string
        - name: urlMask
          value: string
    - name: pscTargetService
      value: string
    - name: pscData
      value:
        - name: consumerPscAddress
          value: string
        - name: pscConnectionId
          value: string
        - name: pscConnectionStatus
          value: string
        - name: producerPort
          value: integer

`DELETE` example

Deletes the specified network_endpoint_groups resource.

/*+ delete */
DELETE FROM google.compute.network_endpoint_groups
WHERE networkEndpointGroup = '{{ networkEndpointGroup }}'
AND project = '{{ project }}'
AND zone = '{{ zone }}';

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

DELETE example​