zones

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

Overview

Name	zones
Type	Resource
Id	google.compute.zones

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	string	[Output Only] Name of the resource.
availableCpuPlatforms	array	[Output Only] Available cpu/platform selections for the zone.
creationTimestamp	string	[Output Only] Creation timestamp inRFC3339 text format.
deprecated	object	[Output Only] The deprecation status associated with this zone. (id: DeprecationStatus)
description	string	[Output Only] Textual description of the resource.
kind	string	Output only. [Output Only] Type of the resource. Always compute#zone for zones. (default: compute#zone)
region	string	[Output Only] Full URL reference to the region which hosts the zone.
resourceStatus	object	(id: ZoneResourceStatus)
selfLink	string	[Output Only] Server-defined URL for the resource.
status	string	[Output Only] Status of the zone, either UP orDOWN. (DOWN, UP)
supportsPzs	boolean	Output only. [Output Only] Reserved for future use.

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of Zone resources.
kind	string	Output only. Type of resource. (default: compute#zoneList)
nextPageToken	string	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLink	string	Output only. [Output Only] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, zone		Returns the specified Zone resource.
list	select	project	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Retrieves the list of Zone resources available to the specified project.

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
project	string
zone	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
returnPartialSuccess	boolean

SELECT examples

get

Returns the specified Zone resource.

SELECT
id,
name,
availableCpuPlatforms,
creationTimestamp,
deprecated,
description,
kind,
region,
resourceStatus,
selfLink,
status,
supportsPzs
FROM google.compute.zones
WHERE project = '{{ project }}' -- required
AND zone = '{{ zone }}' -- required
;

list

Retrieves the list of Zone resources available to the specified project.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.zones
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;