dns_threat_detectors

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

Overview

Name	dns_threat_detectors
Type	Resource
Id	google.networksecurity.dns_threat_detectors

Fields

The following fields are returned by SELECT queries:

projects_locations_dns_threat_detectors_get

Name	Datatype	Description
name	string	Immutable. Identifier. Name of the DnsThreatDetector resource.
createTime	string (google-datetime)	Output only. Create time stamp.
excludedNetworks	array	Optional. A list of network resource names which aren't monitored by this DnsThreatDetector. Example: projects/PROJECT_ID/global/networks/NETWORK_NAME.
labels	object	Optional. Any labels associated with the DnsThreatDetector, listed as key value pairs.
provider	string	Required. The provider used for DNS threat analysis. (PROVIDER_UNSPECIFIED, INFOBLOX)
updateTime	string (google-datetime)	Output only. Update time stamp.

projects_locations_dns_threat_detectors_list

Name	Datatype	Description
name	string	Immutable. Identifier. Name of the DnsThreatDetector resource.
createTime	string (google-datetime)	Output only. Create time stamp.
excludedNetworks	array	Optional. A list of network resource names which aren't monitored by this DnsThreatDetector. Example: projects/PROJECT_ID/global/networks/NETWORK_NAME.
labels	object	Optional. Any labels associated with the DnsThreatDetector, listed as key value pairs.
provider	string	Required. The provider used for DNS threat analysis. (PROVIDER_UNSPECIFIED, INFOBLOX)
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_dns_threat_detectors_get	select	projectsId, locationsId, dnsThreatDetectorsId		Gets the details of a single DnsThreatDetector.
projects_locations_dns_threat_detectors_list	select	projectsId, locationsId	pageSize, pageToken	Lists DnsThreatDetectors in a given project and location.
projects_locations_dns_threat_detectors_create	insert	projectsId, locationsId	dnsThreatDetectorId	Creates a new DnsThreatDetector in a given project and location.
projects_locations_dns_threat_detectors_patch	update	projectsId, locationsId, dnsThreatDetectorsId	updateMask	Updates a single DnsThreatDetector.
projects_locations_dns_threat_detectors_delete	delete	projectsId, locationsId, dnsThreatDetectorsId		Deletes a single DnsThreatDetector.

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

SELECT examples

projects_locations_dns_threat_detectors_get

Gets the details of a single DnsThreatDetector.

SELECT
name,
createTime,
excludedNetworks,
labels,
provider,
updateTime
FROM google.networksecurity.dns_threat_detectors
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dnsThreatDetectorsId = '{{ dnsThreatDetectorsId }}' -- required
;

projects_locations_dns_threat_detectors_list

Lists DnsThreatDetectors in a given project and location.

SELECT
name,
createTime,
excludedNetworks,
labels,
provider,
updateTime
FROM google.networksecurity.dns_threat_detectors
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

projects_locations_dns_threat_detectors_create

Creates a new DnsThreatDetector in a given project and location.

INSERT INTO google.networksecurity.dns_threat_detectors (
data__name,
data__provider,
data__labels,
data__excludedNetworks,
projectsId,
locationsId,
dnsThreatDetectorId
)
SELECT 
'{{ name }}',
'{{ provider }}',
'{{ labels }}',
'{{ excludedNetworks }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ dnsThreatDetectorId }}'
RETURNING
name,
createTime,
excludedNetworks,
labels,
provider,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: dns_threat_detectors
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the dns_threat_detectors resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the dns_threat_detectors resource.
  - name: name
    value: "{{ name }}"
    description: |
      Immutable. Identifier. Name of the DnsThreatDetector resource.
  - name: provider
    value: "{{ provider }}"
    description: |
      Required. The provider used for DNS threat analysis.
    valid_values: ['PROVIDER_UNSPECIFIED', 'INFOBLOX']
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Any labels associated with the DnsThreatDetector, listed as key value pairs.
  - name: excludedNetworks
    value:
      - "{{ excludedNetworks }}"
    description: |
      Optional. A list of network resource names which aren't monitored by this DnsThreatDetector. Example: `projects/PROJECT_ID/global/networks/NETWORK_NAME`.
  - name: dnsThreatDetectorId
    value: "{{ dnsThreatDetectorId }}"

UPDATE examples

projects_locations_dns_threat_detectors_patch

Updates a single DnsThreatDetector.

UPDATE google.networksecurity.dns_threat_detectors
SET 
data__name = '{{ name }}',
data__provider = '{{ provider }}',
data__labels = '{{ labels }}',
data__excludedNetworks = '{{ excludedNetworks }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dnsThreatDetectorsId = '{{ dnsThreatDetectorsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
excludedNetworks,
labels,
provider,
updateTime;

DELETE examples

projects_locations_dns_threat_detectors_delete

Deletes a single DnsThreatDetector.

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