backend_authentication_configs

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

Overview

Name	backend_authentication_configs
Type	Resource
Id	google.networksecurity.backend_authentication_configs

Fields

The following fields are returned by SELECT queries:

projects_locations_backend_authentication_configs_get

Successful response

Name	Datatype	Description
name	string	Required. Name of the BackendAuthenticationConfig resource. It matches the pattern projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}
clientCertificate	string	Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project}/locations/{location}/certificates/{certificate}". Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. Free-text description of the resource.
etag	string	Output only. Etag of the resource.
labels	object	Set of label tags associated with the resource.
trustConfig	string	Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com namespace. This is a relative resource path following the form "projects/{project}/locations/{location}/trustConfigs/{trust_config}". A BackendService uses the chain of trust represented by this TrustConfig, if specified, to validate the server certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS.
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.
wellKnownRoots	string	Well known roots to use for server certificate validation.

projects_locations_backend_authentication_configs_list

Successful response

Name	Datatype	Description
name	string	Required. Name of the BackendAuthenticationConfig resource. It matches the pattern projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}
clientCertificate	string	Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project}/locations/{location}/certificates/{certificate}". Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. Free-text description of the resource.
etag	string	Output only. Etag of the resource.
labels	object	Set of label tags associated with the resource.
trustConfig	string	Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com namespace. This is a relative resource path following the form "projects/{project}/locations/{location}/trustConfigs/{trust_config}". A BackendService uses the chain of trust represented by this TrustConfig, if specified, to validate the server certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS.
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.
wellKnownRoots	string	Well known roots to use for server certificate validation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_backend_authentication_configs_get	select	projectsId, locationsId, backendAuthenticationConfigsId		Gets details of a single BackendAuthenticationConfig to BackendAuthenticationConfig.
projects_locations_backend_authentication_configs_list	select	projectsId, locationsId	pageSize, pageToken	Lists BackendAuthenticationConfigs in a given project and location.
projects_locations_backend_authentication_configs_create	insert	projectsId, locationsId	backendAuthenticationConfigId	Creates a new BackendAuthenticationConfig in a given project and location.
projects_locations_backend_authentication_configs_patch	update	projectsId, locationsId, backendAuthenticationConfigsId	updateMask	Updates the parameters of a single BackendAuthenticationConfig to BackendAuthenticationConfig.
projects_locations_backend_authentication_configs_delete	delete	projectsId, locationsId, backendAuthenticationConfigsId	etag	Deletes a single BackendAuthenticationConfig to BackendAuthenticationConfig.

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
backendAuthenticationConfigsId	string
locationsId	string
projectsId	string
backendAuthenticationConfigId	string
etag	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_backend_authentication_configs_get

Gets details of a single BackendAuthenticationConfig to BackendAuthenticationConfig.

SELECT
name,
clientCertificate,
createTime,
description,
etag,
labels,
trustConfig,
updateTime,
wellKnownRoots
FROM google.networksecurity.backend_authentication_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND backendAuthenticationConfigsId = '{{ backendAuthenticationConfigsId }}' -- required;

projects_locations_backend_authentication_configs_list

Lists BackendAuthenticationConfigs in a given project and location.

SELECT
name,
clientCertificate,
createTime,
description,
etag,
labels,
trustConfig,
updateTime,
wellKnownRoots
FROM google.networksecurity.backend_authentication_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_locations_backend_authentication_configs_create

Creates a new BackendAuthenticationConfig in a given project and location.

INSERT INTO google.networksecurity.backend_authentication_configs (
data__name,
data__description,
data__labels,
data__clientCertificate,
data__trustConfig,
data__wellKnownRoots,
projectsId,
locationsId,
backendAuthenticationConfigId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ labels }}',
'{{ clientCertificate }}',
'{{ trustConfig }}',
'{{ wellKnownRoots }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ backendAuthenticationConfigId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: backend_authentication_configs
  props:
    - name: projectsId
      value: string
      description: Required parameter for the backend_authentication_configs resource.
    - name: locationsId
      value: string
      description: Required parameter for the backend_authentication_configs resource.
    - name: name
      value: string
      description: >
        Required. Name of the BackendAuthenticationConfig resource. It matches the pattern `projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}`
        
    - name: description
      value: string
      description: >
        Optional. Free-text description of the resource.
        
    - name: labels
      value: object
      description: >
        Set of label tags associated with the resource.
        
    - name: clientCertificate
      value: string
      description: >
        Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project}/locations/{location}/certificates/{certificate}". Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope.
        
    - name: trustConfig
      value: string
      description: >
        Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com namespace. This is a relative resource path following the form "projects/{project}/locations/{location}/trustConfigs/{trust_config}". A BackendService uses the chain of trust represented by this TrustConfig, if specified, to validate the server certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS.
        
    - name: wellKnownRoots
      value: string
      description: >
        Well known roots to use for server certificate validation.
        
      valid_values: ['WELL_KNOWN_ROOTS_UNSPECIFIED', 'NONE', 'PUBLIC_ROOTS']
    - name: backendAuthenticationConfigId
      value: string

UPDATE examples

projects_locations_backend_authentication_configs_patch

Updates the parameters of a single BackendAuthenticationConfig to BackendAuthenticationConfig.

UPDATE google.networksecurity.backend_authentication_configs
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__clientCertificate = '{{ clientCertificate }}',
data__trustConfig = '{{ trustConfig }}',
data__wellKnownRoots = '{{ wellKnownRoots }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND backendAuthenticationConfigsId = '{{ backendAuthenticationConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_backend_authentication_configs_delete

Deletes a single BackendAuthenticationConfig to BackendAuthenticationConfig.

DELETE FROM google.networksecurity.backend_authentication_configs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND backendAuthenticationConfigsId = '{{ backendAuthenticationConfigsId }}' --required
AND etag = '{{ etag }}';