dns_zones

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

Overview

Name	dns_zones
Type	Resource
Id	google.apigee.dns_zones

Fields

The following fields are returned by SELECT queries:

organizations_dns_zones_get

Successful response

Name	Datatype	Description
name	string	Identifier. Unique name for the resource. Defined by the server Format: "organizations/{organization}/dnsZones/{dns_zone}".
createTime	string (google-datetime)	Output only. The time that this resource was created on the server.
description	string	Required. Description of the resource. String of at most 1024 characters associated with this resource for the user's convenience.
domain	string	Required. The domain name for hosts in this private zone, for instance "example.com.".
peeringConfig	object	DNS PEERING zone configuration. (id: GoogleCloudApigeeV1DnsZonePeeringConfig)
state	string	Output only. State of the DNS Peering. Values other than ACTIVE mean the resource is not ready to use.
updateTime	string (google-datetime)	Output only. The time that this resource was updated on the server.

organizations_dns_zones_list

Successful response

Name	Datatype	Description
name	string	Identifier. Unique name for the resource. Defined by the server Format: "organizations/{organization}/dnsZones/{dns_zone}".
createTime	string (google-datetime)	Output only. The time that this resource was created on the server.
description	string	Required. Description of the resource. String of at most 1024 characters associated with this resource for the user's convenience.
domain	string	Required. The domain name for hosts in this private zone, for instance "example.com.".
peeringConfig	object	DNS PEERING zone configuration. (id: GoogleCloudApigeeV1DnsZonePeeringConfig)
state	string	Output only. State of the DNS Peering. Values other than ACTIVE mean the resource is not ready to use.
updateTime	string (google-datetime)	Output only. The time that this resource was updated on the server.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_dns_zones_get	select	organizationsId, dnsZonesId		Fetches the representation of an existing DNS zone.
organizations_dns_zones_list	select	organizationsId	pageSize, pageToken	Enumerates DNS zones that have been created but not yet deleted.
organizations_dns_zones_create	insert	organizationsId	dnsZoneId	Creates a new DNS zone.
organizations_dns_zones_delete	delete	organizationsId, dnsZonesId		Deletes a previously created DNS zone.

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
dnsZonesId	string
organizationsId	string
dnsZoneId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

organizations_dns_zones_get

Fetches the representation of an existing DNS zone.

SELECT
name,
createTime,
description,
domain,
peeringConfig,
state,
updateTime
FROM google.apigee.dns_zones
WHERE organizationsId = '{{ organizationsId }}' -- required
AND dnsZonesId = '{{ dnsZonesId }}' -- required;

organizations_dns_zones_list

Enumerates DNS zones that have been created but not yet deleted.

SELECT
name,
createTime,
description,
domain,
peeringConfig,
state,
updateTime
FROM google.apigee.dns_zones
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

organizations_dns_zones_create

Creates a new DNS zone.

INSERT INTO google.apigee.dns_zones (
data__name,
data__description,
data__domain,
data__peeringConfig,
organizationsId,
dnsZoneId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ domain }}',
'{{ peeringConfig }}',
'{{ organizationsId }}',
'{{ dnsZoneId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: dns_zones
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the dns_zones resource.
    - name: name
      value: string
      description: >
        Identifier. Unique name for the resource. Defined by the server Format: "organizations/{organization}/dnsZones/{dns_zone}".
        
    - name: description
      value: string
      description: >
        Required. Description of the resource. String of at most 1024 characters associated with this resource for the user's convenience.
        
    - name: domain
      value: string
      description: >
        Required. The domain name for hosts in this private zone, for instance "example.com.".
        
    - name: peeringConfig
      value: object
      description: >
        DNS PEERING zone configuration.
        
    - name: dnsZoneId
      value: string

DELETE examples

organizations_dns_zones_delete

Deletes a previously created DNS zone.

DELETE FROM google.apigee.dns_zones
WHERE organizationsId = '{{ organizationsId }}' --required
AND dnsZonesId = '{{ dnsZonesId }}' --required;