firewall_endpoints

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

Overview

Name	firewall_endpoints
Type	Resource
Id	google.networksecurity.firewall_endpoints

Fields

The following fields are returned by SELECT queries:

organizations_locations_firewall_endpoints_get

Successful response

Name	Datatype	Description
name	string	Immutable. Identifier. Name of resource.
associatedNetworks	array	Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.
associations	array	Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.
billingProjectId	string	Required. Project to bill on endpoint uptime usage.
createTime	string (google-datetime)	Output only. Create time stamp.
description	string	Optional. Description of the firewall endpoint. Max length 2048 characters.
labels	object	Optional. Labels as key value pairs
reconciling	boolean	Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
satisfiesPzi	boolean	Output only. [Output Only] Reserved for future use.
satisfiesPzs	boolean	Output only. [Output Only] Reserved for future use.
state	string	Output only. Current state of the endpoint.
updateTime	string (google-datetime)	Output only. Update time stamp

organizations_locations_firewall_endpoints_list

Successful response

Name	Datatype	Description
name	string	Immutable. Identifier. Name of resource.
associatedNetworks	array	Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.
associations	array	Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.
billingProjectId	string	Required. Project to bill on endpoint uptime usage.
createTime	string (google-datetime)	Output only. Create time stamp.
description	string	Optional. Description of the firewall endpoint. Max length 2048 characters.
labels	object	Optional. Labels as key value pairs
reconciling	boolean	Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
satisfiesPzi	boolean	Output only. [Output Only] Reserved for future use.
satisfiesPzs	boolean	Output only. [Output Only] Reserved for future use.
state	string	Output only. Current state of the endpoint.
updateTime	string (google-datetime)	Output only. Update time stamp

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_locations_firewall_endpoints_get	select	organizationsId, locationsId, firewallEndpointsId		Gets details of a single Endpoint.
organizations_locations_firewall_endpoints_list	select	organizationsId, locationsId	pageSize, pageToken, filter, orderBy	Lists FirewallEndpoints in a given project and location.
organizations_locations_firewall_endpoints_create	insert	organizationsId, locationsId	firewallEndpointId, requestId	Creates a new FirewallEndpoint in a given project and location.
organizations_locations_firewall_endpoints_patch	update	organizationsId, locationsId, firewallEndpointsId	updateMask, requestId	Update a single Endpoint.
organizations_locations_firewall_endpoints_delete	delete	organizationsId, locationsId, firewallEndpointsId	requestId	Deletes a single Endpoint.

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
firewallEndpointsId	string
locationsId	string
organizationsId	string
filter	string
firewallEndpointId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

organizations_locations_firewall_endpoints_get

Gets details of a single Endpoint.

SELECT
name,
associatedNetworks,
associations,
billingProjectId,
createTime,
description,
labels,
reconciling,
satisfiesPzi,
satisfiesPzs,
state,
updateTime
FROM google.networksecurity.firewall_endpoints
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND firewallEndpointsId = '{{ firewallEndpointsId }}' -- required;

organizations_locations_firewall_endpoints_list

Lists FirewallEndpoints in a given project and location.

SELECT
name,
associatedNetworks,
associations,
billingProjectId,
createTime,
description,
labels,
reconciling,
satisfiesPzi,
satisfiesPzs,
state,
updateTime
FROM google.networksecurity.firewall_endpoints
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

organizations_locations_firewall_endpoints_create

Creates a new FirewallEndpoint in a given project and location.

INSERT INTO google.networksecurity.firewall_endpoints (
data__name,
data__description,
data__labels,
data__billingProjectId,
organizationsId,
locationsId,
firewallEndpointId,
requestId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ labels }}',
'{{ billingProjectId }}',
'{{ organizationsId }}',
'{{ locationsId }}',
'{{ firewallEndpointId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: firewall_endpoints
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the firewall_endpoints resource.
    - name: locationsId
      value: string
      description: Required parameter for the firewall_endpoints resource.
    - name: name
      value: string
      description: >
        Immutable. Identifier. Name of resource.
        
    - name: description
      value: string
      description: >
        Optional. Description of the firewall endpoint. Max length 2048 characters.
        
    - name: labels
      value: object
      description: >
        Optional. Labels as key value pairs
        
    - name: billingProjectId
      value: string
      description: >
        Required. Project to bill on endpoint uptime usage.
        
    - name: firewallEndpointId
      value: string
    - name: requestId
      value: string

UPDATE examples

organizations_locations_firewall_endpoints_patch

Update a single Endpoint.

UPDATE google.networksecurity.firewall_endpoints
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__billingProjectId = '{{ billingProjectId }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND firewallEndpointsId = '{{ firewallEndpointsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

organizations_locations_firewall_endpoints_delete

Deletes a single Endpoint.

DELETE FROM google.networksecurity.firewall_endpoints
WHERE organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND firewallEndpointsId = '{{ firewallEndpointsId }}' --required
AND requestId = '{{ requestId }}';