firewall_endpoint_associations

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

Overview

Name	firewall_endpoint_associations
Type	Resource
Id	google.networksecurity.firewall_endpoint_associations

Fields

The following fields are returned by SELECT queries:

projects_locations_firewall_endpoint_associations_get

Successful response

Name	Datatype	Description
name	string	Immutable. Identifier. name of resource
createTime	string (google-datetime)	Output only. Create time stamp
disabled	boolean	Optional. Whether the association is disabled. True indicates that traffic won't be intercepted
firewallEndpoint	string	Required. The URL of the FirewallEndpoint that is being associated.
labels	object	Optional. Labels as key value pairs
network	string	Required. The URL of the network that is being associated.
reconciling	boolean	Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
state	string	Output only. Current state of the association.
tlsInspectionPolicy	string	Optional. The URL of the TlsInspectionPolicy that is being associated.
updateTime	string (google-datetime)	Output only. Update time stamp

projects_locations_firewall_endpoint_associations_list

Successful response

Name	Datatype	Description
name	string	Immutable. Identifier. name of resource
createTime	string (google-datetime)	Output only. Create time stamp
disabled	boolean	Optional. Whether the association is disabled. True indicates that traffic won't be intercepted
firewallEndpoint	string	Required. The URL of the FirewallEndpoint that is being associated.
labels	object	Optional. Labels as key value pairs
network	string	Required. The URL of the network that is being associated.
reconciling	boolean	Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
state	string	Output only. Current state of the association.
tlsInspectionPolicy	string	Optional. The URL of the TlsInspectionPolicy that is being associated.
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_endpoint_associations_get	select	projectsId, locationsId, firewallEndpointAssociationsId		Gets details of a single FirewallEndpointAssociation.
projects_locations_firewall_endpoint_associations_list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists Associations in a given project and location.
projects_locations_firewall_endpoint_associations_create	insert	projectsId, locationsId	firewallEndpointAssociationId, requestId	Creates a new FirewallEndpointAssociation in a given project and location.
projects_locations_firewall_endpoint_associations_patch	update	projectsId, locationsId, firewallEndpointAssociationsId	updateMask, requestId	Update a single FirewallEndpointAssociation.
projects_locations_firewall_endpoint_associations_delete	delete	projectsId, locationsId, firewallEndpointAssociationsId	requestId	Deletes a single FirewallEndpointAssociation.

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
firewallEndpointAssociationsId	string
locationsId	string
projectsId	string
filter	string
firewallEndpointAssociationId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_firewall_endpoint_associations_get

Gets details of a single FirewallEndpointAssociation.

SELECT
name,
createTime,
disabled,
firewallEndpoint,
labels,
network,
reconciling,
state,
tlsInspectionPolicy,
updateTime
FROM google.networksecurity.firewall_endpoint_associations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND firewallEndpointAssociationsId = '{{ firewallEndpointAssociationsId }}' -- required;

projects_locations_firewall_endpoint_associations_list

Lists Associations in a given project and location.

SELECT
name,
createTime,
disabled,
firewallEndpoint,
labels,
network,
reconciling,
state,
tlsInspectionPolicy,
updateTime
FROM google.networksecurity.firewall_endpoint_associations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

projects_locations_firewall_endpoint_associations_create

Creates a new FirewallEndpointAssociation in a given project and location.

INSERT INTO google.networksecurity.firewall_endpoint_associations (
data__name,
data__labels,
data__network,
data__firewallEndpoint,
data__tlsInspectionPolicy,
data__disabled,
projectsId,
locationsId,
firewallEndpointAssociationId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ network }}',
'{{ firewallEndpoint }}',
'{{ tlsInspectionPolicy }}',
{{ disabled }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ firewallEndpointAssociationId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: firewall_endpoint_associations
  props:
    - name: projectsId
      value: string
      description: Required parameter for the firewall_endpoint_associations resource.
    - name: locationsId
      value: string
      description: Required parameter for the firewall_endpoint_associations resource.
    - name: name
      value: string
      description: >
        Immutable. Identifier. name of resource
        
    - name: labels
      value: object
      description: >
        Optional. Labels as key value pairs
        
    - name: network
      value: string
      description: >
        Required. The URL of the network that is being associated.
        
    - name: firewallEndpoint
      value: string
      description: >
        Required. The URL of the FirewallEndpoint that is being associated.
        
    - name: tlsInspectionPolicy
      value: string
      description: >
        Optional. The URL of the TlsInspectionPolicy that is being associated.
        
    - name: disabled
      value: boolean
      description: >
        Optional. Whether the association is disabled. True indicates that traffic won't be intercepted
        
    - name: firewallEndpointAssociationId
      value: string
    - name: requestId
      value: string

UPDATE examples

projects_locations_firewall_endpoint_associations_patch

Update a single FirewallEndpointAssociation.

UPDATE google.networksecurity.firewall_endpoint_associations
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__network = '{{ network }}',
data__firewallEndpoint = '{{ firewallEndpoint }}',
data__tlsInspectionPolicy = '{{ tlsInspectionPolicy }}',
data__disabled = {{ disabled }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND firewallEndpointAssociationsId = '{{ firewallEndpointAssociationsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_firewall_endpoint_associations_delete

Deletes a single FirewallEndpointAssociation.

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