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

The following fields are returned by SELECT queries:

get
list
aggregated_list

Name	Datatype	Description
`id`	`string (uint64)`	Output only. [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.
`annotations`	`object`	Optional. Metadata defined as annotations on the network endpoint group.
`appEngine`	`object`	Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. (id: NetworkEndpointGroupAppEngine)
`cloudFunction`	`object`	Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. (id: NetworkEndpointGroupCloudFunction)
`cloudRun`	`object`	Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. (id: NetworkEndpointGroupCloudRun)
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp inRFC3339 text format.
`defaultPort`	`integer (int32)`	The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`kind`	`string`	Output only. [Output Only] Type of the resource. Alwayscompute#networkEndpointGroup for network endpoint group. (default: compute#networkEndpointGroup)
`network`	`string`	The URL of the network to which all network endpoints in the NEG belong. For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT, if this field is not specified, a default network will be used. This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for global NEGs. For all other network endpoint types, this field is required.
`networkEndpointType`	`string`	Type of network endpoints in this network endpoint group. Can be one ofGCE_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. (GCE_VM_IP, GCE_VM_IP_PORT, GCE_VM_IP_PORTMAP, INTERNET_FQDN_PORT, INTERNET_IP_PORT, NON_GCP_PRIVATE_IP_PORT, PRIVATE_SERVICE_CONNECT, SERVERLESS)
`pscData`	`object`	Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT. (id: NetworkEndpointGroupPscData)
`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. Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT.
`region`	`string`	Output only. [Output Only] The URL of theregion where the network endpoint group is located.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for the resource.
`size`	`integer (int32)`	Output only. [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. [Output Only] The URL of thezone where the network endpoint group is located.

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`items`	`array`	A list of NetworkEndpointGroup resources.
`kind`	`string`	Output only. [Output Only] The resource type, which is alwayscompute#networkEndpointGroupList for network endpoint group lists. (default: compute#networkEndpointGroupList)
`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. [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.
`annotations`	`object`	Optional. Metadata defined as annotations on the network endpoint group.
`appEngine`	`object`	Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. (id: NetworkEndpointGroupAppEngine)
`cloudFunction`	`object`	Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. (id: NetworkEndpointGroupCloudFunction)
`cloudRun`	`object`	Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. (id: NetworkEndpointGroupCloudRun)
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp inRFC3339 text format.
`defaultPort`	`integer (int32)`	The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`kind`	`string`	Output only. [Output Only] Type of the resource. Alwayscompute#networkEndpointGroup for network endpoint group. (default: compute#networkEndpointGroup)
`network`	`string`	The URL of the network to which all network endpoints in the NEG belong. For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT, if this field is not specified, a default network will be used. This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for global NEGs. For all other network endpoint types, this field is required.
`networkEndpointType`	`string`	Type of network endpoints in this network endpoint group. Can be one ofGCE_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. (GCE_VM_IP, GCE_VM_IP_PORT, GCE_VM_IP_PORTMAP, INTERNET_FQDN_PORT, INTERNET_IP_PORT, NON_GCP_PRIVATE_IP_PORT, PRIVATE_SERVICE_CONNECT, SERVERLESS)
`pscData`	`object`	Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT. (id: NetworkEndpointGroupPscData)
`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. Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT.
`region`	`string`	Output only. [Output Only] The URL of theregion where the network endpoint group is located.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for the resource.
`size`	`integer (int32)`	Output only. [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. [Output Only] The URL of thezone where the network endpoint group is located.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`project`, `zone`, `networkEndpointGroup`		Returns the specified network endpoint group.
`list`	`select`	`project`, `zone`	`orderBy`, `filter`, `maxResults`, `pageToken`, `returnPartialSuccess`	Retrieves the list of network endpoint groups that are located in the specified project and zone.
`aggregated_list`	`select`	`project`	`maxResults`, `pageToken`, `filter`, `serviceProjectNumber`, `includeAllScopes`, `orderBy`, `returnPartialSuccess`	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`.
`insert`	`insert`	`project`, `zone`	`requestId`	Creates a network endpoint group in the specified project using the parameters that are included in the request. Note: Use the following APIs to manage network endpoint groups: - To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity NEGs): zonal API - To manage NEGs with regional scope (such as regional internet NEGs, serverless NEGs, Private Service Connect NEGs): regional API - To manage NEGs with global scope (such as global internet NEGs):global API
`delete`	`delete`	`project`, `zone`, `networkEndpointGroup`	`requestId`	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`	`project`, `zone`, `networkEndpointGroup`	`requestId`	Attach a list of network endpoints to the specified network endpoint group.
`detach_network_endpoints`	`exec`	`project`, `zone`, `networkEndpointGroup`	`requestId`	Detach a list of network endpoints from the specified network endpoint group.

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
`networkEndpointGroup`	`string`
`project`	`string`
`zone`	`string`
`filter`	`string`
`includeAllScopes`	`boolean`
`maxResults`	`integer (uint32)`
`orderBy`	`string`
`pageToken`	`string`
`requestId`	`string`
`returnPartialSuccess`	`boolean`
`serviceProjectNumber`	`string (int64)`

`SELECT` examples

get
list
aggregated_list

Returns the specified network endpoint group.

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

Retrieves the list of network endpoint groups that are located in the
specified project and zone.

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

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,
annotations,
appEngine,
cloudFunction,
cloudRun,
creationTimestamp,
defaultPort,
description,
kind,
network,
networkEndpointType,
pscData,
pscTargetService,
region,
selfLink,
size,
subnetwork,
zone
FROM google.compute.network_endpoint_groups
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 network endpoint group in the specified project using the
parameters that are included in the request.

Note: Use the following APIs to manage network endpoint groups:

-
To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
NEGs): zonal
API
-
To manage NEGs with regional scope (such as regional internet NEGs,
serverless NEGs, Private Service Connect NEGs): regional
API
-
To manage NEGs with global scope (such as global internet NEGs):global
API

INSERT INTO google.compute.network_endpoint_groups (
data__cloudFunction,
data__description,
data__name,
data__defaultPort,
data__network,
data__annotations,
data__appEngine,
data__pscData,
data__networkEndpointType,
data__subnetwork,
data__cloudRun,
data__pscTargetService,
project,
zone,
requestId
)
SELECT 
'{{ cloudFunction }}',
'{{ description }}',
'{{ name }}',
{{ defaultPort }},
'{{ network }}',
'{{ annotations }}',
'{{ appEngine }}',
'{{ pscData }}',
'{{ networkEndpointType }}',
'{{ subnetwork }}',
'{{ cloudRun }}',
'{{ pscTargetService }}',
'{{ project }}',
'{{ zone }}',
'{{ 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: network_endpoint_groups
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the network_endpoint_groups resource.
  - name: zone
    value: "{{ zone }}"
    description: Required parameter for the network_endpoint_groups resource.
  - name: cloudFunction
    description: |
      Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.
    value:
      function: "{{ function }}"
      urlMask: "{{ urlMask }}"
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the 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.
  - name: defaultPort
    value: {{ defaultPort }}
    description: |
      The default port used if the port number is not specified in the network
      endpoint.
      Optional. If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this
      field must not be specified.
  - name: network
    value: "{{ network }}"
    description: |
      The URL of the network to which all network endpoints in the NEG belong.
      For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT,
      if this field is not specified, a default network will be used.
      This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for
      global NEGs.
      For all other network endpoint types, this field is required.
  - name: annotations
    value: "{{ annotations }}"
    description: |
      Optional. Metadata defined as annotations on the network endpoint group.
  - name: appEngine
    description: |
      Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.
    value:
      urlMask: "{{ urlMask }}"
      version: "{{ version }}"
      service: "{{ service }}"
  - name: pscData
    description: |
      Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT.
    value:
      consumerPscAddress: "{{ consumerPscAddress }}"
      producerPort: {{ producerPort }}
      pscConnectionId: "{{ pscConnectionId }}"
      pscConnectionStatus: "{{ pscConnectionStatus }}"
  - name: networkEndpointType
    value: "{{ networkEndpointType }}"
    description: |
      Type of network endpoints in this network endpoint group. Can be one ofGCE_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.
    valid_values: ['GCE_VM_IP', 'GCE_VM_IP_PORT', 'GCE_VM_IP_PORTMAP', 'INTERNET_FQDN_PORT', 'INTERNET_IP_PORT', 'NON_GCP_PRIVATE_IP_PORT', 'PRIVATE_SERVICE_CONNECT', 'SERVERLESS']
  - name: subnetwork
    value: "{{ subnetwork }}"
    description: |
      Optional URL of the subnetwork to which all network endpoints in the NEG
      belong.
  - name: cloudRun
    description: |
      Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.
    value:
      service: "{{ service }}"
      tag: "{{ tag }}"
      urlMask: "{{ urlMask }}"
  - name: pscTargetService
    value: "{{ pscTargetService }}"
    description: |
      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.
      Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT.
  - name: requestId
    value: "{{ requestId }}"

`DELETE` examples

delete

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.

DELETE FROM google.compute.network_endpoint_groups
WHERE project = '{{ project }}' --required
AND zone = '{{ zone }}' --required
AND networkEndpointGroup = '{{ networkEndpointGroup }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods

attach_network_endpoints
detach_network_endpoints

Attach a list of network endpoints to the specified network endpoint group.

EXEC google.compute.network_endpoint_groups.attach_network_endpoints 
@project='{{ project }}' --required, 
@zone='{{ zone }}' --required, 
@networkEndpointGroup='{{ networkEndpointGroup }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"networkEndpoints": "{{ networkEndpoints }}"
}'
;

Detach a list of network endpoints from the specified network endpoint
group.

EXEC google.compute.network_endpoint_groups.detach_network_endpoints 
@project='{{ project }}' --required, 
@zone='{{ zone }}' --required, 
@networkEndpointGroup='{{ networkEndpointGroup }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"networkEndpoints": "{{ networkEndpoints }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​

Lifecycle Methods​