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:

projects_locations_firewall_endpoints_get

Name	Datatype	Description
name	string	Immutable. Identifier. Name of resource.
associatedNetworks	array	Output only. Deprecated: 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	Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.
createTime	string (google-datetime)	Output only. Create time stamp.
description	string	Optional. Description of the firewall endpoint. Max length 2048 characters.
endpointSettings	object	Optional. Settings for the endpoint. (id: FirewallEndpointEndpointSettings)
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. (STATE_UNSPECIFIED, CREATING, ACTIVE, DELETING, INACTIVE)
updateTime	string (google-datetime)	Output only. Update time stamp

organizations_locations_firewall_endpoints_get

Name	Datatype	Description
name	string	Immutable. Identifier. Name of resource.
associatedNetworks	array	Output only. Deprecated: 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	Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.
createTime	string (google-datetime)	Output only. Create time stamp.
description	string	Optional. Description of the firewall endpoint. Max length 2048 characters.
endpointSettings	object	Optional. Settings for the endpoint. (id: FirewallEndpointEndpointSettings)
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. (STATE_UNSPECIFIED, CREATING, ACTIVE, DELETING, INACTIVE)
updateTime	string (google-datetime)	Output only. Update time stamp

projects_locations_firewall_endpoints_list

Name	Datatype	Description
name	string	Immutable. Identifier. Name of resource.
associatedNetworks	array	Output only. Deprecated: 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	Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.
createTime	string (google-datetime)	Output only. Create time stamp.
description	string	Optional. Description of the firewall endpoint. Max length 2048 characters.
endpointSettings	object	Optional. Settings for the endpoint. (id: FirewallEndpointEndpointSettings)
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. (STATE_UNSPECIFIED, CREATING, ACTIVE, DELETING, INACTIVE)
updateTime	string (google-datetime)	Output only. Update time stamp

organizations_locations_firewall_endpoints_list

Name	Datatype	Description
name	string	Immutable. Identifier. Name of resource.
associatedNetworks	array	Output only. Deprecated: 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	Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.
createTime	string (google-datetime)	Output only. Create time stamp.
description	string	Optional. Description of the firewall endpoint. Max length 2048 characters.
endpointSettings	object	Optional. Settings for the endpoint. (id: FirewallEndpointEndpointSettings)
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. (STATE_UNSPECIFIED, CREATING, ACTIVE, DELETING, INACTIVE)
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
projects_locations_firewall_endpoints_get	select	projectsId, locationsId, firewallEndpointsId		Gets details of a single project Endpoint.
organizations_locations_firewall_endpoints_get	select	organizationsId, locationsId, firewallEndpointsId		Gets details of a single org Endpoint.
projects_locations_firewall_endpoints_list	select	projectsId, locationsId	pageSize, filter, pageToken, orderBy	Lists FirewallEndpoints in a given project and location.
organizations_locations_firewall_endpoints_list	select	organizationsId, locationsId	pageToken, orderBy, filter, pageSize	Lists FirewallEndpoints in a given organization and location.
projects_locations_firewall_endpoints_create	insert	projectsId, locationsId	requestId, firewallEndpointId	Creates a new FirewallEndpoint in a given project and location.
organizations_locations_firewall_endpoints_create	insert	organizationsId, locationsId	firewallEndpointId, requestId	Creates a new FirewallEndpoint in a given organization and location.
projects_locations_firewall_endpoints_patch	update	projectsId, locationsId, firewallEndpointsId	updateMask, requestId	Update a single project Endpoint.
organizations_locations_firewall_endpoints_patch	update	organizationsId, locationsId, firewallEndpointsId	updateMask, requestId	Update a single org Endpoint.
projects_locations_firewall_endpoints_delete	delete	projectsId, locationsId, firewallEndpointsId	requestId	Deletes a single project Endpoint.
organizations_locations_firewall_endpoints_delete	delete	organizationsId, locationsId, firewallEndpointsId	requestId	Deletes a single org 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
projectsId	string
filter	string
firewallEndpointId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_firewall_endpoints_get

Gets details of a single project Endpoint.

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

organizations_locations_firewall_endpoints_get

Gets details of a single org Endpoint.

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

projects_locations_firewall_endpoints_list

Lists FirewallEndpoints in a given project and location.

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

organizations_locations_firewall_endpoints_list

Lists FirewallEndpoints in a given organization and location.

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

INSERT examples

projects_locations_firewall_endpoints_create

Creates a new FirewallEndpoint in a given project and location.

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

organizations_locations_firewall_endpoints_create

Creates a new FirewallEndpoint in a given organization and location.

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

Manifest

# Description fields are for documentation purposes
- name: firewall_endpoints
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the firewall_endpoints resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the firewall_endpoints resource.
  - name: organizationsId
    value: "{{ organizationsId }}"
    description: Required parameter for the firewall_endpoints resource.
  - name: billingProjectId
    value: "{{ billingProjectId }}"
    description: |
      Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.
  - name: endpointSettings
    description: |
      Optional. Settings for the endpoint.
    value:
      jumboFramesEnabled: {{ jumboFramesEnabled }}
  - name: name
    value: "{{ name }}"
    description: |
      Immutable. Identifier. Name of resource.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. Description of the firewall endpoint. Max length 2048 characters.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Labels as key value pairs
  - name: requestId
    value: "{{ requestId }}"
  - name: firewallEndpointId
    value: "{{ firewallEndpointId }}"

UPDATE examples

projects_locations_firewall_endpoints_patch

Update a single project Endpoint.

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

organizations_locations_firewall_endpoints_patch

Update a single org Endpoint.

UPDATE google.networksecurity.firewall_endpoints
SET 
data__billingProjectId = '{{ billingProjectId }}',
data__endpointSettings = '{{ endpointSettings }}',
data__name = '{{ name }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}'
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

projects_locations_firewall_endpoints_delete

Deletes a single project Endpoint.

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

organizations_locations_firewall_endpoints_delete

Deletes a single org Endpoint.

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