client_tls_policies

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

Overview

Name	client_tls_policies
Type	Resource
Id	google.networksecurity.client_tls_policies

Fields

The following fields are returned by SELECT queries:

projects_locations_client_tls_policies_get

Successful response

Name	Datatype	Description
name	string	Required. Name of the ClientTlsPolicy resource. It matches the pattern projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}
clientCertificate	object	Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. (id: GoogleCloudNetworksecurityV1CertificateProvider)
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. Free-text description of the resource.
labels	object	Optional. Set of label tags associated with the resource.
serverValidationCa	array	Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate.
sni	string	Optional. Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.

projects_locations_client_tls_policies_list

Successful response

Name	Datatype	Description
name	string	Required. Name of the ClientTlsPolicy resource. It matches the pattern projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}
clientCertificate	object	Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. (id: GoogleCloudNetworksecurityV1CertificateProvider)
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. Free-text description of the resource.
labels	object	Optional. Set of label tags associated with the resource.
serverValidationCa	array	Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate.
sni	string	Optional. Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_client_tls_policies_get	select	projectsId, locationsId, clientTlsPoliciesId		Gets details of a single ClientTlsPolicy.
projects_locations_client_tls_policies_list	select	projectsId, locationsId	pageSize, pageToken	Lists ClientTlsPolicies in a given project and location.
projects_locations_client_tls_policies_create	insert	projectsId, locationsId	clientTlsPolicyId	Creates a new ClientTlsPolicy in a given project and location.
projects_locations_client_tls_policies_patch	update	projectsId, locationsId, clientTlsPoliciesId	updateMask	Updates the parameters of a single ClientTlsPolicy.
projects_locations_client_tls_policies_delete	delete	projectsId, locationsId, clientTlsPoliciesId		Deletes a single ClientTlsPolicy.

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

SELECT examples

projects_locations_client_tls_policies_get

Gets details of a single ClientTlsPolicy.

SELECT
name,
clientCertificate,
createTime,
description,
labels,
serverValidationCa,
sni,
updateTime
FROM google.networksecurity.client_tls_policies
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND clientTlsPoliciesId = '{{ clientTlsPoliciesId }}' -- required;

projects_locations_client_tls_policies_list

Lists ClientTlsPolicies in a given project and location.

SELECT
name,
clientCertificate,
createTime,
description,
labels,
serverValidationCa,
sni,
updateTime
FROM google.networksecurity.client_tls_policies
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_locations_client_tls_policies_create

Creates a new ClientTlsPolicy in a given project and location.

INSERT INTO google.networksecurity.client_tls_policies (
data__name,
data__description,
data__labels,
data__sni,
data__clientCertificate,
data__serverValidationCa,
projectsId,
locationsId,
clientTlsPolicyId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ labels }}',
'{{ sni }}',
'{{ clientCertificate }}',
'{{ serverValidationCa }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ clientTlsPolicyId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: client_tls_policies
  props:
    - name: projectsId
      value: string
      description: Required parameter for the client_tls_policies resource.
    - name: locationsId
      value: string
      description: Required parameter for the client_tls_policies resource.
    - name: name
      value: string
      description: >
        Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}`
        
    - name: description
      value: string
      description: >
        Optional. Free-text description of the resource.
        
    - name: labels
      value: object
      description: >
        Optional. Set of label tags associated with the resource.
        
    - name: sni
      value: string
      description: >
        Optional. Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
        
    - name: clientCertificate
      value: object
      description: >
        Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS.
        
    - name: serverValidationCa
      value: array
      description: >
        Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate.
        
    - name: clientTlsPolicyId
      value: string

UPDATE examples

projects_locations_client_tls_policies_patch

Updates the parameters of a single ClientTlsPolicy.

UPDATE google.networksecurity.client_tls_policies
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__sni = '{{ sni }}',
data__clientCertificate = '{{ clientCertificate }}',
data__serverValidationCa = '{{ serverValidationCa }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND clientTlsPoliciesId = '{{ clientTlsPoliciesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_client_tls_policies_delete

Deletes a single ClientTlsPolicy.

DELETE FROM google.networksecurity.client_tls_policies
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND clientTlsPoliciesId = '{{ clientTlsPoliciesId }}' --required;