policies

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

Overview

Name	policies
Type	Resource
Id	google.dns.policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (uint64)	Unique identifier for the resource; defined by the server (output only).
name	string	User-assigned name for this policy.
alternativeNameServerConfig	object	Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. (id: PolicyAlternativeNameServerConfig)
description	string	A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
dns64Config	object	Configurations related to DNS64 for this policy. (id: PolicyDns64Config)
enableInboundForwarding	boolean	Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.
enableLogging	boolean	Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
kind	string	(default: dns#policy)
networks	array	List of network names specifying networks to which this policy is applied.

list

Name	Datatype	Description
id	string (uint64)	Unique identifier for the resource; defined by the server (output only).
name	string	User-assigned name for this policy.
alternativeNameServerConfig	object	Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. (id: PolicyAlternativeNameServerConfig)
description	string	A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
dns64Config	object	Configurations related to DNS64 for this policy. (id: PolicyDns64Config)
enableInboundForwarding	boolean	Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.
enableLogging	boolean	Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
kind	string	(default: dns#policy)
networks	array	List of network names specifying networks to which this policy is applied.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, policy	clientOperationId	Fetches the representation of an existing policy.
list	select	project	maxResults, pageToken	Enumerates all policies associated with a project.
create	insert	project	clientOperationId	Creates a new policy.
patch	update	project, policy	clientOperationId	Applies a partial update to an existing policy.
update	replace	project, policy	clientOperationId	Updates an existing policy.
delete	delete	project, policy	clientOperationId	Deletes a previously created policy. Fails if the policy is still being referenced by a network.

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
policy	string
project	string
clientOperationId	string
maxResults	integer (int32)
pageToken	string

SELECT examples

get

Fetches the representation of an existing policy.

SELECT
id,
name,
alternativeNameServerConfig,
description,
dns64Config,
enableInboundForwarding,
enableLogging,
kind,
networks
FROM google.dns.policies
WHERE project = '{{ project }}' -- required
AND policy = '{{ policy }}' -- required
AND clientOperationId = '{{ clientOperationId }}'
;

list

Enumerates all policies associated with a project.

SELECT
id,
name,
alternativeNameServerConfig,
description,
dns64Config,
enableInboundForwarding,
enableLogging,
kind,
networks
FROM google.dns.policies
WHERE project = '{{ project }}' -- required
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a new policy.

INSERT INTO google.dns.policies (
data__alternativeNameServerConfig,
data__description,
data__dns64Config,
data__enableInboundForwarding,
data__enableLogging,
data__id,
data__kind,
data__name,
data__networks,
project,
clientOperationId
)
SELECT 
'{{ alternativeNameServerConfig }}',
'{{ description }}',
'{{ dns64Config }}',
{{ enableInboundForwarding }},
{{ enableLogging }},
'{{ id }}',
'{{ kind }}',
'{{ name }}',
'{{ networks }}',
'{{ project }}',
'{{ clientOperationId }}'
RETURNING
id,
name,
alternativeNameServerConfig,
description,
dns64Config,
enableInboundForwarding,
enableLogging,
kind,
networks
;

Manifest

# Description fields are for documentation purposes
- name: policies
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the policies resource.
  - name: alternativeNameServerConfig
    description: |
      Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
    value:
      kind: "{{ kind }}"
      targetNameServers:
        - forwardingPath: "{{ forwardingPath }}"
          ipv4Address: "{{ ipv4Address }}"
          ipv6Address: "{{ ipv6Address }}"
          kind: "{{ kind }}"
  - name: description
    value: "{{ description }}"
    description: |
      A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
  - name: dns64Config
    description: |
      Configurations related to DNS64 for this policy.
    value:
      kind: "{{ kind }}"
      scope:
        allQueries: {{ allQueries }}
        kind: "{{ kind }}"
  - name: enableInboundForwarding
    value: {{ enableInboundForwarding }}
    description: |
      Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.
  - name: enableLogging
    value: {{ enableLogging }}
    description: |
      Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
  - name: id
    value: "{{ id }}"
    description: |
      Unique identifier for the resource; defined by the server (output only).
  - name: kind
    value: "{{ kind }}"
    default: dns#policy
  - name: name
    value: "{{ name }}"
    description: |
      User-assigned name for this policy.
  - name: networks
    description: |
      List of network names specifying networks to which this policy is applied.
    value:
      - kind: "{{ kind }}"
        networkUrl: "{{ networkUrl }}"
  - name: clientOperationId
    value: "{{ clientOperationId }}"

UPDATE examples

patch

Applies a partial update to an existing policy.

UPDATE google.dns.policies
SET 
data__alternativeNameServerConfig = '{{ alternativeNameServerConfig }}',
data__description = '{{ description }}',
data__dns64Config = '{{ dns64Config }}',
data__enableInboundForwarding = {{ enableInboundForwarding }},
data__enableLogging = {{ enableLogging }},
data__id = '{{ id }}',
data__kind = '{{ kind }}',
data__name = '{{ name }}',
data__networks = '{{ networks }}'
WHERE 
project = '{{ project }}' --required
AND policy = '{{ policy }}' --required
AND clientOperationId = '{{ clientOperationId}}'
RETURNING
policy;

REPLACE examples

update

Updates an existing policy.

REPLACE google.dns.policies
SET 
data__alternativeNameServerConfig = '{{ alternativeNameServerConfig }}',
data__description = '{{ description }}',
data__dns64Config = '{{ dns64Config }}',
data__enableInboundForwarding = {{ enableInboundForwarding }},
data__enableLogging = {{ enableLogging }},
data__id = '{{ id }}',
data__kind = '{{ kind }}',
data__name = '{{ name }}',
data__networks = '{{ networks }}'
WHERE 
project = '{{ project }}' --required
AND policy = '{{ policy }}' --required
AND clientOperationId = '{{ clientOperationId}}'
RETURNING
policy;

DELETE examples

delete

Deletes a previously created policy. Fails if the policy is still being referenced by a network.

DELETE FROM google.dns.policies
WHERE project = '{{ project }}' --required
AND policy = '{{ policy }}' --required
AND clientOperationId = '{{ clientOperationId }}'
;