Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. compute
  5. compute/alpha
  6. getStoragePool

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.compute/alpha.getStoragePool

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Returns a specified storage pool. Gets a list of available storage pools by making a list() request.

    Using getStoragePool

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getStoragePool(args: GetStoragePoolArgs, opts?: InvokeOptions): Promise<GetStoragePoolResult>
function getStoragePoolOutput(args: GetStoragePoolOutputArgs, opts?: InvokeOptions): Output<GetStoragePoolResult>
    def get_storage_pool(project: Optional[str] = None,
                     storage_pool: Optional[str] = None,
                     zone: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetStoragePoolResult
def get_storage_pool_output(project: Optional[pulumi.Input[str]] = None,
                     storage_pool: Optional[pulumi.Input[str]] = None,
                     zone: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetStoragePoolResult]
    func LookupStoragePool(ctx *Context, args *LookupStoragePoolArgs, opts ...InvokeOption) (*LookupStoragePoolResult, error)
func LookupStoragePoolOutput(ctx *Context, args *LookupStoragePoolOutputArgs, opts ...InvokeOption) LookupStoragePoolResultOutput

    > Note: This function is named LookupStoragePool in the Go SDK.

    public static class GetStoragePool 
{
    public static Task<GetStoragePoolResult> InvokeAsync(GetStoragePoolArgs args, InvokeOptions? opts = null)
    public static Output<GetStoragePoolResult> Invoke(GetStoragePoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetStoragePoolResult> getStoragePool(GetStoragePoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:compute/alpha:getStoragePool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    StoragePool string
    Zone string
    Project string
    StoragePool string
    Zone string
    Project string
    storagePool String
    zone String
    project String
    storagePool string
    zone string
    project string
    storagePool String
    zone String
    project String

    getStoragePool Result

    The following output properties are available:

    CapacityProvisioningType string
    Provisioning type of the byte capacity of the pool.
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    Kind string
    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 Dictionary<string, string>
    Labels to apply to this storage pool. These can be later modified by the setLabels method.
    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.
    PerformanceProvisioningType string
    Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.
    ProvisionedIops string
    Provsioned IOPS of the storage pool.
    ProvisionedThroughput string
    Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.
    ResourceStatus Pulumi.GoogleNative.Compute.Alpha.Outputs.StoragePoolResourceStatusResponse
    Status information for the storage pool resource.
    SelfLink string
    Server-defined fully-qualified URL for this resource.
    SelfLinkWithId string
    Server-defined URL for this resource's resource id.
    SizeGb string
    Size, in GiB, of the storage pool.
    State string
    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 Pulumi.GoogleNative.Compute.Alpha.Outputs.StoragePoolResourceStatusResponse
    Status information for the storage pool resource.
    StoragePoolType string
    Type of the storage pool.
    Zone string
    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.
    CapacityProvisioningType string
    Provisioning type of the byte capacity of the pool.
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    Kind string
    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 map[string]string
    Labels to apply to this storage pool. These can be later modified by the setLabels method.
    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.
    PerformanceProvisioningType string
    Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.
    ProvisionedIops string
    Provsioned IOPS of the storage pool.
    ProvisionedThroughput string
    Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.
    ResourceStatus StoragePoolResourceStatusResponse
    Status information for the storage pool resource.
    SelfLink string
    Server-defined fully-qualified URL for this resource.
    SelfLinkWithId string
    Server-defined URL for this resource's resource id.
    SizeGb string
    Size, in GiB, of the storage pool.
    State string
    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 StoragePoolResourceStatusResponse
    Status information for the storage pool resource.
    StoragePoolType string
    Type of the storage pool.
    Zone string
    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.
    capacityProvisioningType String
    Provisioning type of the byte capacity of the pool.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    kind String
    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 Map<String,String>
    Labels to apply to this storage pool. These can be later modified by the setLabels method.
    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.
    performanceProvisioningType String
    Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.
    provisionedIops String
    Provsioned IOPS of the storage pool.
    provisionedThroughput String
    Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.
    resourceStatus StoragePoolResourceStatusResponse
    Status information for the storage pool resource.
    selfLink String
    Server-defined fully-qualified URL for this resource.
    selfLinkWithId String
    Server-defined URL for this resource's resource id.
    sizeGb String
    Size, in GiB, of the storage pool.
    state String
    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 StoragePoolResourceStatusResponse
    Status information for the storage pool resource.
    storagePoolType String
    Type of the storage pool.
    zone String
    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.
    capacityProvisioningType string
    Provisioning type of the byte capacity of the pool.
    creationTimestamp string
    Creation timestamp in RFC3339 text format.
    description string
    An optional description of this resource. Provide this property when you create the resource.
    kind string
    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 {[key: string]: string}
    Labels to apply to this storage pool. These can be later modified by the setLabels method.
    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.
    performanceProvisioningType string
    Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.
    provisionedIops string
    Provsioned IOPS of the storage pool.
    provisionedThroughput string
    Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.
    resourceStatus StoragePoolResourceStatusResponse
    Status information for the storage pool resource.
    selfLink string
    Server-defined fully-qualified URL for this resource.
    selfLinkWithId string
    Server-defined URL for this resource's resource id.
    sizeGb string
    Size, in GiB, of the storage pool.
    state string
    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 StoragePoolResourceStatusResponse
    Status information for the storage pool resource.
    storagePoolType string
    Type of the storage pool.
    zone string
    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.
    capacity_provisioning_type str
    Provisioning type of the byte capacity of the pool.
    creation_timestamp str
    Creation timestamp in RFC3339 text format.
    description str
    An optional description of this resource. Provide this property when you create the resource.
    kind str
    Type of the resource. Always compute#storagePool for storage pools.
    label_fingerprint str
    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 Mapping[str, str]
    Labels to apply to this storage pool. These can be later modified by the setLabels method.
    name str
    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.
    performance_provisioning_type str
    Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.
    provisioned_iops str
    Provsioned IOPS of the storage pool.
    provisioned_throughput str
    Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.
    resource_status StoragePoolResourceStatusResponse
    Status information for the storage pool resource.
    self_link str
    Server-defined fully-qualified URL for this resource.
    self_link_with_id str
    Server-defined URL for this resource's resource id.
    size_gb str
    Size, in GiB, of the storage pool.
    state str
    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 StoragePoolResourceStatusResponse
    Status information for the storage pool resource.
    storage_pool_type str
    Type of the storage pool.
    zone str
    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.
    capacityProvisioningType String
    Provisioning type of the byte capacity of the pool.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    kind String
    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 Map<String>
    Labels to apply to this storage pool. These can be later modified by the setLabels method.
    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.
    performanceProvisioningType String
    Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.
    provisionedIops String
    Provsioned IOPS of the storage pool.
    provisionedThroughput String
    Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.
    resourceStatus Property Map
    Status information for the storage pool resource.
    selfLink String
    Server-defined fully-qualified URL for this resource.
    selfLinkWithId String
    Server-defined URL for this resource's resource id.
    sizeGb String
    Size, in GiB, of the storage pool.
    state String
    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 Property Map
    Status information for the storage pool resource.
    storagePoolType String
    Type of the storage pool.
    zone String
    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.

    Supporting Types

    StoragePoolResourceStatusResponse

    AggregateDiskProvisionedIops string
    Sum of all the disks' provisioned IOPS.
    AggregateDiskSizeGb string
    Sum of all the capacity provisioned in disks in this storage pool. A disk's provisioned capacity is the same as its total capacity.
    LastResizeTimestamp string
    Timestamp of the last successful resize in RFC3339 text format.
    MaxAggregateDiskSizeGb string
    Maximum allowed aggregate disk size in gigabytes.
    NumberOfDisks string
    Number of disks used.
    UsedBytes string
    Space used by data stored in disks within the storage pool (in bytes).
    UsedReducedBytes string
    Space used by compressed and deduped data stored in disks within the storage pool (in bytes).
    UsedThroughput string
    Sum of all the disks' provisioned throughput in MB/s.
    AggregateDiskProvisionedIops string
    Sum of all the disks' provisioned IOPS.
    AggregateDiskSizeGb string
    Sum of all the capacity provisioned in disks in this storage pool. A disk's provisioned capacity is the same as its total capacity.
    LastResizeTimestamp string
    Timestamp of the last successful resize in RFC3339 text format.
    MaxAggregateDiskSizeGb string
    Maximum allowed aggregate disk size in gigabytes.
    NumberOfDisks string
    Number of disks used.
    UsedBytes string
    Space used by data stored in disks within the storage pool (in bytes).
    UsedReducedBytes string
    Space used by compressed and deduped data stored in disks within the storage pool (in bytes).
    UsedThroughput string
    Sum of all the disks' provisioned throughput in MB/s.
    aggregateDiskProvisionedIops String
    Sum of all the disks' provisioned IOPS.
    aggregateDiskSizeGb String
    Sum of all the capacity provisioned in disks in this storage pool. A disk's provisioned capacity is the same as its total capacity.
    lastResizeTimestamp String
    Timestamp of the last successful resize in RFC3339 text format.
    maxAggregateDiskSizeGb String
    Maximum allowed aggregate disk size in gigabytes.
    numberOfDisks String
    Number of disks used.
    usedBytes String
    Space used by data stored in disks within the storage pool (in bytes).
    usedReducedBytes String
    Space used by compressed and deduped data stored in disks within the storage pool (in bytes).
    usedThroughput String
    Sum of all the disks' provisioned throughput in MB/s.
    aggregateDiskProvisionedIops string
    Sum of all the disks' provisioned IOPS.
    aggregateDiskSizeGb string
    Sum of all the capacity provisioned in disks in this storage pool. A disk's provisioned capacity is the same as its total capacity.
    lastResizeTimestamp string
    Timestamp of the last successful resize in RFC3339 text format.
    maxAggregateDiskSizeGb string
    Maximum allowed aggregate disk size in gigabytes.
    numberOfDisks string
    Number of disks used.
    usedBytes string
    Space used by data stored in disks within the storage pool (in bytes).
    usedReducedBytes string
    Space used by compressed and deduped data stored in disks within the storage pool (in bytes).
    usedThroughput string
    Sum of all the disks' provisioned throughput in MB/s.
    aggregate_disk_provisioned_iops str
    Sum of all the disks' provisioned IOPS.
    aggregate_disk_size_gb str
    Sum of all the capacity provisioned in disks in this storage pool. A disk's provisioned capacity is the same as its total capacity.
    last_resize_timestamp str
    Timestamp of the last successful resize in RFC3339 text format.
    max_aggregate_disk_size_gb str
    Maximum allowed aggregate disk size in gigabytes.
    number_of_disks str
    Number of disks used.
    used_bytes str
    Space used by data stored in disks within the storage pool (in bytes).
    used_reduced_bytes str
    Space used by compressed and deduped data stored in disks within the storage pool (in bytes).
    used_throughput str
    Sum of all the disks' provisioned throughput in MB/s.
    aggregateDiskProvisionedIops String
    Sum of all the disks' provisioned IOPS.
    aggregateDiskSizeGb String
    Sum of all the capacity provisioned in disks in this storage pool. A disk's provisioned capacity is the same as its total capacity.
    lastResizeTimestamp String
    Timestamp of the last successful resize in RFC3339 text format.
    maxAggregateDiskSizeGb String
    Maximum allowed aggregate disk size in gigabytes.
    numberOfDisks String
    Number of disks used.
    usedBytes String
    Space used by data stored in disks within the storage pool (in bytes).
    usedReducedBytes String
    Space used by compressed and deduped data stored in disks within the storage pool (in bytes).
    usedThroughput String
    Sum of all the disks' provisioned throughput in MB/s.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native