instance_templates

Creates, updates, deletes, gets or lists an instance_templates resource.

Overview

Name	`instance_templates`
Type	Resource
Id	`google.compute.instance_templates`

Fields

The following fields are returned by SELECT queries:

get
list

Successful response

Name	Datatype	Description
`id`	`string (uint64)`	[Output Only] A unique identifier for this instance template. The server defines this identifier.
`name`	`string`	Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. (pattern: a-z?)
`creationTimestamp`	`string`	[Output Only] The creation timestamp for this instance template in RFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`kind`	`string`	[Output Only] The resource type, which is always compute#instanceTemplate for instance templates. (default: compute#instanceTemplate)
`properties`	`object`	The instance properties for this instance template. (id: InstanceProperties)
`region`	`string`	[Output Only] URL of the region where the instance template resides. Only applicable for regional resources.
`selfLink`	`string`	[Output Only] The URL for this instance template. The server defines this URL.
`sourceInstance`	`string`	The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance
`sourceInstanceParams`	`object`	The source instance params to use to create this instance template. (id: SourceInstanceParams)

Successful response

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`items`	`array`	A list of InstanceTemplate resources.
`kind`	`string`	[Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists. (default: compute#instanceTemplateList)
`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 than maxResults, 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] 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`, `region`, `instanceTemplate`		Returns the specified instance template.
`list`	`select`	`project`, `region`	`filter`, `maxResults`, `orderBy`, `pageToken`, `returnPartialSuccess`	Retrieves a list of instance templates that are contained within the specified project and region.
`insert`	`insert`	`project`, `region`	`requestId`	Creates an instance template in the specified project and region using the global instance template whose URL is included in the request.
`delete`	`delete`	`project`, `region`, `instanceTemplate`	`requestId`	Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone.

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

`SELECT` examples

get
list

Returns the specified instance template.

SELECT
id,
name,
creationTimestamp,
description,
kind,
properties,
region,
selfLink,
sourceInstance,
sourceInstanceParams
FROM google.compute.instance_templates
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND instanceTemplate = '{{ instanceTemplate }}' -- required;

Retrieves a list of instance templates that are contained within the specified project and region.

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

`INSERT` examples

insert
Manifest

Creates an instance template in the specified project and region using the global instance template whose URL is included in the request.

INSERT INTO google.compute.instance_templates (
data__kind,
data__id,
data__creationTimestamp,
data__name,
data__description,
data__properties,
data__selfLink,
data__sourceInstance,
data__sourceInstanceParams,
data__region,
project,
region,
requestId
)
SELECT 
'{{ kind }}',
'{{ id }}',
'{{ creationTimestamp }}',
'{{ name }}',
'{{ description }}',
'{{ properties }}',
'{{ selfLink }}',
'{{ sourceInstance }}',
'{{ sourceInstanceParams }}',
'{{ region }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

# Description fields are for documentation purposes
- name: instance_templates
  props:
    - name: project
      value: string
      description: Required parameter for the instance_templates resource.
    - name: region
      value: string
      description: Required parameter for the instance_templates resource.
    - name: kind
      value: string
      description: >
        [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
        
      default: compute#instanceTemplate
    - name: id
      value: string
      description: >
        [Output Only] A unique identifier for this instance template. The server defines this identifier.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] The creation timestamp for this instance template in RFC3339 text format.
        
    - name: name
      value: string
      description: >
        Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        
    - name: description
      value: string
      description: >
        An optional description of this resource. Provide this property when you create the resource.
        
    - name: properties
      value: object
      description: >
        The instance properties for this instance template.
        
    - name: selfLink
      value: string
      description: >
        [Output Only] The URL for this instance template. The server defines this URL.
        
    - name: sourceInstance
      value: string
      description: >
        The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance 
        
    - name: sourceInstanceParams
      value: object
      description: >
        The source instance params to use to create this instance template.
        
    - name: region
      value: string
      description: >
        [Output Only] URL of the region where the instance template resides. Only applicable for regional resources.
        
    - name: requestId
      value: string

`DELETE` examples

delete

Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone.

DELETE FROM google.compute.instance_templates
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND instanceTemplate = '{{ instanceTemplate }}' --required
AND requestId = '{{ requestId }}';

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​