projects

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

Overview

Name	projects
Type	Resource
Id	google.compute.projects

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
name	string	The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
cloudArmorTier	string	[Output Only] The Cloud Armor tier for this project. It can be one of the following values: CA_STANDARD, CA_ENTERPRISE_PAYGO. If this field is not specified, it is assumed to be CA_STANDARD.
commonInstanceMetadata	object	Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information. (id: Metadata)
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
defaultNetworkTier	string	This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM.
defaultServiceAccount	string	[Output Only] Default service account used by VMs running in this project.
description	string	An optional textual description of the resource.
enabledFeatures	array	An optional list of restricted features enabled for use on this project.
kind	string	[Output Only] Type of the resource. Always compute#project for projects. (default: compute#project)
quotas	array	[Output Only] Quotas assigned to this project.
selfLink	string	[Output Only] Server-defined URL for the resource.
usageExportLocation	object	An optional naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored. (id: UsageExportLocation)
vmDnsSetting	string	[Output Only] Default internal DNS setting used by VMs running in this project.
xpnProjectStatus	string	[Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project		Returns the specified Project resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the quotas field). To exclude one or more fields, set your request's fields query parameter to only include the fields you need. For example, to only include the id and selfLink fields, add the query parameter ?fields=id,selfLink to your request.
set_common_instance_metadata	exec	project	requestId	Sets metadata common to all instances within the specified project using the data included in the request.
set_usage_export_bucket	exec	project	requestId	Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.
move_instance	exec	project	requestId	Moves an instance and its attached persistent disks from one zone to another. Note: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the known issue. [Deprecated] This method is deprecated. See moving instance across zones instead.
move_disk	exec	project	requestId	Moves a persistent disk from one zone to another.
enable_xpn_host	exec	project	requestId	Enable this project as a shared VPC host project.
disable_xpn_host	exec	project	requestId	Disable this project as a shared VPC host project.
enable_xpn_resource	exec	project	requestId	Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project.
disable_xpn_resource	exec	project	requestId	Disable a service resource (also known as service project) associated with this host project.
set_default_network_tier	exec	project	requestId	Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field.
set_cloud_armor_tier	exec	project	requestId	Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the billing account of the project must be subscribed to Cloud Armor Enterprise. See Subscribing to Cloud Armor Enterprise for more information.

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
requestId	string

SELECT examples

get

Returns the specified Project resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the quotas field). To exclude one or more fields, set your request's fields query parameter to only include the fields you need. For example, to only include the id and selfLink fields, add the query parameter ?fields=id,selfLink to your request.

SELECT
id,
name,
cloudArmorTier,
commonInstanceMetadata,
creationTimestamp,
defaultNetworkTier,
defaultServiceAccount,
description,
enabledFeatures,
kind,
quotas,
selfLink,
usageExportLocation,
vmDnsSetting,
xpnProjectStatus
FROM google.compute.projects
WHERE project = '{{ project }}' -- required;

Lifecycle Methods

set_common_instance_metadata

Sets metadata common to all instances within the specified project using the data included in the request.

EXEC google.compute.projects.set_common_instance_metadata 
@project='{{ project }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"kind": "{{ kind }}", 
"fingerprint": "{{ fingerprint }}", 
"items": "{{ items }}"
}';

set_usage_export_bucket

Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

EXEC google.compute.projects.set_usage_export_bucket 
@project='{{ project }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"bucketName": "{{ bucketName }}", 
"reportNamePrefix": "{{ reportNamePrefix }}"
}';

move_instance

Moves an instance and its attached persistent disks from one zone to another. Note: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the known issue. [Deprecated] This method is deprecated. See moving instance across zones instead.

EXEC google.compute.projects.move_instance 
@project='{{ project }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"targetInstance": "{{ targetInstance }}", 
"destinationZone": "{{ destinationZone }}"
}';

move_disk

Moves a persistent disk from one zone to another.

EXEC google.compute.projects.move_disk 
@project='{{ project }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"targetDisk": "{{ targetDisk }}", 
"destinationZone": "{{ destinationZone }}"
}';

enable_xpn_host

Enable this project as a shared VPC host project.

EXEC google.compute.projects.enable_xpn_host 
@project='{{ project }}' --required, 
@requestId='{{ requestId }}';

disable_xpn_host

Disable this project as a shared VPC host project.

EXEC google.compute.projects.disable_xpn_host 
@project='{{ project }}' --required, 
@requestId='{{ requestId }}';

enable_xpn_resource

Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project.

EXEC google.compute.projects.enable_xpn_resource 
@project='{{ project }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"xpnResource": "{{ xpnResource }}"
}';

disable_xpn_resource

Disable a service resource (also known as service project) associated with this host project.

EXEC google.compute.projects.disable_xpn_resource 
@project='{{ project }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"xpnResource": "{{ xpnResource }}"
}';

set_default_network_tier

Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field.

EXEC google.compute.projects.set_default_network_tier 
@project='{{ project }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"networkTier": "{{ networkTier }}"
}';

set_cloud_armor_tier

Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the billing account of the project must be subscribed to Cloud Armor Enterprise. See Subscribing to Cloud Armor Enterprise for more information.

EXEC google.compute.projects.set_cloud_armor_tier 
@project='{{ project }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"cloudArmorTier": "{{ cloudArmorTier }}"
}';