managed_zones

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

Overview

Name	managed_zones
Type	Resource
Id	google.dns.managed_zones

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string (uint64)	Unique identifier for the resource; defined by the server (output only)
name	string	User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
cloudLoggingConfig	object	Cloud Logging configurations for publicly visible zones. (id: ManagedZoneCloudLoggingConfig)
creationTime	string	The time that this resource was created on the server. This is in RFC3339 text format. Output only.
description	string	A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
dnsName	string	The DNS name of this managed zone, for instance "example.com.".
dnssecConfig	object	DNSSEC configuration. (id: ManagedZoneDnsSecConfig)
forwardingConfig	object	The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to. (id: ManagedZoneForwardingConfig)
kind	string	(default: dns#managedZone)
labels	object	User labels.
nameServerSet	string	Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
nameServers	array	Delegate your managed_zone to these virtual name servers; defined by the server (output only)
peeringConfig	object	The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with. (id: ManagedZonePeeringConfig)
privateVisibilityConfig	object	For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. (id: ManagedZonePrivateVisibilityConfig)
reverseLookupConfig	object	The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config. (id: ManagedZoneReverseLookupConfig)
serviceDirectoryConfig	object	This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones. (id: ManagedZoneServiceDirectoryConfig)
visibility	string	The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.

list

Successful response

Name	Datatype	Description
id	string (uint64)	Unique identifier for the resource; defined by the server (output only)
name	string	User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
cloudLoggingConfig	object	Cloud Logging configurations for publicly visible zones. (id: ManagedZoneCloudLoggingConfig)
creationTime	string	The time that this resource was created on the server. This is in RFC3339 text format. Output only.
description	string	A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
dnsName	string	The DNS name of this managed zone, for instance "example.com.".
dnssecConfig	object	DNSSEC configuration. (id: ManagedZoneDnsSecConfig)
forwardingConfig	object	The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to. (id: ManagedZoneForwardingConfig)
kind	string	(default: dns#managedZone)
labels	object	User labels.
nameServerSet	string	Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
nameServers	array	Delegate your managed_zone to these virtual name servers; defined by the server (output only)
peeringConfig	object	The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with. (id: ManagedZonePeeringConfig)
privateVisibilityConfig	object	For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. (id: ManagedZonePrivateVisibilityConfig)
reverseLookupConfig	object	The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config. (id: ManagedZoneReverseLookupConfig)
serviceDirectoryConfig	object	This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones. (id: ManagedZoneServiceDirectoryConfig)
visibility	string	The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, managedZone	clientOperationId	Fetches the representation of an existing ManagedZone.
list	select	project	maxResults, pageToken, dnsName	Enumerates ManagedZones that have been created but not yet deleted.
create	insert	project	clientOperationId	Creates a new ManagedZone.
patch	update	project, managedZone	clientOperationId	Applies a partial update to an existing ManagedZone.
update	replace	project, managedZone	clientOperationId	Updates an existing ManagedZone.
delete	delete	project, managedZone	clientOperationId	Deletes a previously created ManagedZone.

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

SELECT examples

get

Fetches the representation of an existing ManagedZone.

SELECT
id,
name,
cloudLoggingConfig,
creationTime,
description,
dnsName,
dnssecConfig,
forwardingConfig,
kind,
labels,
nameServerSet,
nameServers,
peeringConfig,
privateVisibilityConfig,
reverseLookupConfig,
serviceDirectoryConfig,
visibility
FROM google.dns.managed_zones
WHERE project = '{{ project }}' -- required
AND managedZone = '{{ managedZone }}' -- required
AND clientOperationId = '{{ clientOperationId }}';

list

Enumerates ManagedZones that have been created but not yet deleted.

SELECT
id,
name,
cloudLoggingConfig,
creationTime,
description,
dnsName,
dnssecConfig,
forwardingConfig,
kind,
labels,
nameServerSet,
nameServers,
peeringConfig,
privateVisibilityConfig,
reverseLookupConfig,
serviceDirectoryConfig,
visibility
FROM google.dns.managed_zones
WHERE project = '{{ project }}' -- required
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND dnsName = '{{ dnsName }}';

INSERT examples

create

Creates a new ManagedZone.

INSERT INTO google.dns.managed_zones (
data__name,
data__dnsName,
data__description,
data__id,
data__nameServers,
data__creationTime,
data__dnssecConfig,
data__nameServerSet,
data__visibility,
data__privateVisibilityConfig,
data__forwardingConfig,
data__labels,
data__peeringConfig,
data__reverseLookupConfig,
data__serviceDirectoryConfig,
data__cloudLoggingConfig,
data__kind,
project,
clientOperationId
)
SELECT 
'{{ name }}',
'{{ dnsName }}',
'{{ description }}',
'{{ id }}',
'{{ nameServers }}',
'{{ creationTime }}',
'{{ dnssecConfig }}',
'{{ nameServerSet }}',
'{{ visibility }}',
'{{ privateVisibilityConfig }}',
'{{ forwardingConfig }}',
'{{ labels }}',
'{{ peeringConfig }}',
'{{ reverseLookupConfig }}',
'{{ serviceDirectoryConfig }}',
'{{ cloudLoggingConfig }}',
'{{ kind }}',
'{{ project }}',
'{{ clientOperationId }}'
RETURNING
id,
name,
cloudLoggingConfig,
creationTime,
description,
dnsName,
dnssecConfig,
forwardingConfig,
kind,
labels,
nameServerSet,
nameServers,
peeringConfig,
privateVisibilityConfig,
reverseLookupConfig,
serviceDirectoryConfig,
visibility
;

Manifest

# Description fields are for documentation purposes
- name: managed_zones
  props:
    - name: project
      value: string
      description: Required parameter for the managed_zones resource.
    - name: name
      value: string
      description: >
        User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
        
    - name: dnsName
      value: string
      description: >
        The DNS name of this managed zone, for instance "example.com.".
        
    - name: description
      value: string
      description: >
        A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
        
    - name: id
      value: string
      description: >
        Unique identifier for the resource; defined by the server (output only)
        
    - name: nameServers
      value: array
      description: >
        Delegate your managed_zone to these virtual name servers; defined by the server (output only)
        
    - name: creationTime
      value: string
      description: >
        The time that this resource was created on the server. This is in RFC3339 text format. Output only.
        
    - name: dnssecConfig
      value: object
      description: >
        DNSSEC configuration.
        
    - name: nameServerSet
      value: string
      description: >
        Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
        
    - name: visibility
      value: string
      description: >
        The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
        
      valid_values: ['public', 'private']
    - name: privateVisibilityConfig
      value: object
      description: >
        For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
        
    - name: forwardingConfig
      value: object
      description: >
        The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
        
    - name: labels
      value: object
      description: >
        User labels.
        
    - name: peeringConfig
      value: object
      description: >
        The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
        
    - name: reverseLookupConfig
      value: object
      description: >
        The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
        
    - name: serviceDirectoryConfig
      value: object
      description: >
        This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
        
    - name: cloudLoggingConfig
      value: object
      description: >
        Cloud Logging configurations for publicly visible zones.
        
    - name: kind
      value: string
      default: dns#managedZone
    - name: clientOperationId
      value: string

UPDATE examples

patch

Applies a partial update to an existing ManagedZone.

UPDATE google.dns.managed_zones
SET 
data__name = '{{ name }}',
data__dnsName = '{{ dnsName }}',
data__description = '{{ description }}',
data__id = '{{ id }}',
data__nameServers = '{{ nameServers }}',
data__creationTime = '{{ creationTime }}',
data__dnssecConfig = '{{ dnssecConfig }}',
data__nameServerSet = '{{ nameServerSet }}',
data__visibility = '{{ visibility }}',
data__privateVisibilityConfig = '{{ privateVisibilityConfig }}',
data__forwardingConfig = '{{ forwardingConfig }}',
data__labels = '{{ labels }}',
data__peeringConfig = '{{ peeringConfig }}',
data__reverseLookupConfig = '{{ reverseLookupConfig }}',
data__serviceDirectoryConfig = '{{ serviceDirectoryConfig }}',
data__cloudLoggingConfig = '{{ cloudLoggingConfig }}',
data__kind = '{{ kind }}'
WHERE 
project = '{{ project }}' --required
AND managedZone = '{{ managedZone }}' --required
AND clientOperationId = '{{ clientOperationId}}'
RETURNING
id,
dnsKeyContext,
kind,
startTime,
status,
type,
user,
zoneContext;

REPLACE examples

update

Updates an existing ManagedZone.

REPLACE google.dns.managed_zones
SET 
data__name = '{{ name }}',
data__dnsName = '{{ dnsName }}',
data__description = '{{ description }}',
data__id = '{{ id }}',
data__nameServers = '{{ nameServers }}',
data__creationTime = '{{ creationTime }}',
data__dnssecConfig = '{{ dnssecConfig }}',
data__nameServerSet = '{{ nameServerSet }}',
data__visibility = '{{ visibility }}',
data__privateVisibilityConfig = '{{ privateVisibilityConfig }}',
data__forwardingConfig = '{{ forwardingConfig }}',
data__labels = '{{ labels }}',
data__peeringConfig = '{{ peeringConfig }}',
data__reverseLookupConfig = '{{ reverseLookupConfig }}',
data__serviceDirectoryConfig = '{{ serviceDirectoryConfig }}',
data__cloudLoggingConfig = '{{ cloudLoggingConfig }}',
data__kind = '{{ kind }}'
WHERE 
project = '{{ project }}' --required
AND managedZone = '{{ managedZone }}' --required
AND clientOperationId = '{{ clientOperationId}}'
RETURNING
id,
dnsKeyContext,
kind,
startTime,
status,
type,
user,
zoneContext;

DELETE examples

delete

Deletes a previously created ManagedZone.

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