storage_pools

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

Overview

Name	storage_pools
Type	Resource
Id	google.compute.storage_pools

Fields

Name	Datatype	Description
id	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
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.
description	string	An optional description of this resource. Provide this property when you create the resource.
capacityProvisioningType	string	Provisioning type of the byte capacity of the pool.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
kind	string	[Output Only] Type of the resource. Always compute#storagePool for storage pools.
labelFingerprint	string	A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a storage pool.
labels	object	Labels to apply to this storage pool. These can be later modified by the setLabels method.
performanceProvisioningType	string	Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.
poolProvisionedCapacityGb	string	Size, in GiB, of the storage pool. For more information about the size limits, see https://cloud.google.com/compute/docs/disks/storage-pools.
poolProvisionedIops	string	Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced.
poolProvisionedThroughput	string	Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.
resourceStatus	object	[Output Only] Contains output only fields.
selfLink	string	[Output Only] Server-defined fully-qualified URL for this resource.
selfLinkWithId	string	[Output Only] Server-defined URL for this resource's resource id.
state	string	[Output Only] The status of storage pool creation. - CREATING: Storage pool is provisioning. storagePool. - FAILED: Storage pool creation failed. - READY: Storage pool is ready for use. - DELETING: Storage pool is deleting.
status	object	[Output Only] Contains output only fields.
storagePoolType	string	Type of the storage pool.
zone	string	[Output Only] URL of the zone where the storage pool resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Methods

Name	Accessible by	Required Params	Description
aggregated_list	SELECT	project	Retrieves an aggregated list of storage pools. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
get	SELECT	project, storagePool, zone	Returns a specified storage pool. Gets a list of available storage pools by making a list() request.
list	SELECT	project, zone	Retrieves a list of storage pools contained within the specified zone.
insert	INSERT	project, zone	Creates a storage pool in the specified project using the data in the request.
delete	DELETE	project, storagePool, zone	Deletes the specified storage pool. Deleting a storagePool removes its data permanently and is irreversible. However, deleting a storagePool does not delete any snapshots previously made from the storagePool. You must separately delete snapshots.
update	UPDATE	project, storagePool, zone	Updates the specified storagePool with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: pool_provisioned_capacity_gb, pool_provisioned_iops and pool_provisioned_throughput.

SELECT examples

Retrieves an aggregated list of storage pools. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

SELECT
id,
name,
description,
capacityProvisioningType,
creationTimestamp,
kind,
labelFingerprint,
labels,
performanceProvisioningType,
poolProvisionedCapacityGb,
poolProvisionedIops,
poolProvisionedThroughput,
resourceStatus,
selfLink,
selfLinkWithId,
state,
status,
storagePoolType,
zone
FROM google.compute.storage_pools
WHERE project = '{{ project }}';

INSERT example

Use the following StackQL query and manifest file to create a new storage_pools resource.

All Properties

/*+ create */
INSERT INTO google.compute.storage_pools (
project,
zone,
name,
description,
poolProvisionedCapacityGb,
poolProvisionedIops,
poolProvisionedThroughput,
zone,
state,
labels,
labelFingerprint,
resourceStatus,
storagePoolType,
status,
capacityProvisioningType,
performanceProvisioningType
)
SELECT 
'{{ project }}',
'{{ zone }}',
'{{ name }}',
'{{ description }}',
'{{ poolProvisionedCapacityGb }}',
'{{ poolProvisionedIops }}',
'{{ poolProvisionedThroughput }}',
'{{ zone }}',
'{{ state }}',
'{{ labels }}',
'{{ labelFingerprint }}',
'{{ resourceStatus }}',
'{{ storagePoolType }}',
'{{ status }}',
'{{ capacityProvisioningType }}',
'{{ performanceProvisioningType }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: poolProvisionedCapacityGb
      value: string
    - name: poolProvisionedIops
      value: string
    - name: poolProvisionedThroughput
      value: string
    - name: zone
      value: string
    - name: state
      value: string
    - name: selfLink
      value: string
    - name: selfLinkWithId
      value: string
    - name: labels
      value: object
    - name: labelFingerprint
      value: string
    - name: resourceStatus
      value:
        - name: lastResizeTimestamp
          value: string
        - name: diskCount
          value: string
        - name: poolUsedCapacityBytes
          value: string
        - name: poolUserWrittenBytes
          value: string
        - name: totalProvisionedDiskCapacityGb
          value: string
        - name: maxTotalProvisionedDiskCapacityGb
          value: string
        - name: poolUsedIops
          value: string
        - name: totalProvisionedDiskIops
          value: string
        - name: poolUsedThroughput
          value: string
        - name: totalProvisionedDiskThroughput
          value: string
    - name: storagePoolType
      value: string
    - name: capacityProvisioningType
      value: string
    - name: performanceProvisioningType
      value: string

UPDATE example

Updates a storage_pools resource.

/*+ update */
UPDATE google.compute.storage_pools
SET 
name = '{{ name }}',
description = '{{ description }}',
poolProvisionedCapacityGb = '{{ poolProvisionedCapacityGb }}',
poolProvisionedIops = '{{ poolProvisionedIops }}',
poolProvisionedThroughput = '{{ poolProvisionedThroughput }}',
zone = '{{ zone }}',
state = '{{ state }}',
labels = '{{ labels }}',
labelFingerprint = '{{ labelFingerprint }}',
resourceStatus = '{{ resourceStatus }}',
storagePoolType = '{{ storagePoolType }}',
status = '{{ status }}',
capacityProvisioningType = '{{ capacityProvisioningType }}',
performanceProvisioningType = '{{ performanceProvisioningType }}'
WHERE 
project = '{{ project }}'
AND storagePool = '{{ storagePool }}'
AND zone = '{{ zone }}';

DELETE example

Deletes the specified storage_pools resource.

/*+ delete */
DELETE FROM google.compute.storage_pools
WHERE project = '{{ project }}'
AND storagePool = '{{ storagePool }}'
AND zone = '{{ zone }}';