1. Packages
  2. Azure Native
  3. API Docs
  4. netapp
  5. getCapacityPool
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

azure-native.netapp.getCapacityPool

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

    Get details of the specified capacity pool

    Uses Azure REST API version 2024-09-01.

    Other available API versions: 2022-11-01, 2022-11-01-preview, 2023-05-01, 2023-05-01-preview, 2023-07-01, 2023-07-01-preview, 2023-11-01, 2023-11-01-preview, 2024-01-01, 2024-03-01, 2024-03-01-preview, 2024-05-01, 2024-05-01-preview, 2024-07-01, 2024-07-01-preview, 2024-09-01-preview, 2025-01-01, 2025-01-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native netapp [ApiVersion]. See the version guide for details.

    Using getCapacityPool

    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 getCapacityPool(args: GetCapacityPoolArgs, opts?: InvokeOptions): Promise<GetCapacityPoolResult>
    function getCapacityPoolOutput(args: GetCapacityPoolOutputArgs, opts?: InvokeOptions): Output<GetCapacityPoolResult>
    def get_capacity_pool(account_name: Optional[str] = None,
                          pool_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetCapacityPoolResult
    def get_capacity_pool_output(account_name: Optional[pulumi.Input[str]] = None,
                          pool_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetCapacityPoolResult]
    func LookupCapacityPool(ctx *Context, args *LookupCapacityPoolArgs, opts ...InvokeOption) (*LookupCapacityPoolResult, error)
    func LookupCapacityPoolOutput(ctx *Context, args *LookupCapacityPoolOutputArgs, opts ...InvokeOption) LookupCapacityPoolResultOutput

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

    public static class GetCapacityPool 
    {
        public static Task<GetCapacityPoolResult> InvokeAsync(GetCapacityPoolArgs args, InvokeOptions? opts = null)
        public static Output<GetCapacityPoolResult> Invoke(GetCapacityPoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCapacityPoolResult> getCapacityPool(GetCapacityPoolArgs args, InvokeOptions options)
    public static Output<GetCapacityPoolResult> getCapacityPool(GetCapacityPoolArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:netapp:getCapacityPool
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountName string
    The name of the NetApp account
    PoolName string
    The name of the capacity pool
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AccountName string
    The name of the NetApp account
    PoolName string
    The name of the capacity pool
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    accountName String
    The name of the NetApp account
    poolName String
    The name of the capacity pool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    accountName string
    The name of the NetApp account
    poolName string
    The name of the capacity pool
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    account_name str
    The name of the NetApp account
    pool_name str
    The name of the capacity pool
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    accountName String
    The name of the NetApp account
    poolName String
    The name of the capacity pool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getCapacityPool Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    PoolId string
    UUID v4 used to identify the Pool
    ProvisioningState string
    Azure lifecycle management
    ServiceLevel string
    The service level of the file system
    Size double
    Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).
    SystemData Pulumi.AzureNative.NetApp.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    TotalThroughputMibps double
    Total throughput of pool in MiB/s
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    UtilizedThroughputMibps double
    Utilized throughput of pool in MiB/s
    CoolAccess bool
    If enabled (true) the pool can contain cool Access enabled volumes.
    EncryptionType string
    Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.
    QosType string
    The qos type of the pool
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    PoolId string
    UUID v4 used to identify the Pool
    ProvisioningState string
    Azure lifecycle management
    ServiceLevel string
    The service level of the file system
    Size float64
    Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    TotalThroughputMibps float64
    Total throughput of pool in MiB/s
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    UtilizedThroughputMibps float64
    Utilized throughput of pool in MiB/s
    CoolAccess bool
    If enabled (true) the pool can contain cool Access enabled volumes.
    EncryptionType string
    Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.
    QosType string
    The qos type of the pool
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    poolId String
    UUID v4 used to identify the Pool
    provisioningState String
    Azure lifecycle management
    serviceLevel String
    The service level of the file system
    size Double
    Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    totalThroughputMibps Double
    Total throughput of pool in MiB/s
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    utilizedThroughputMibps Double
    Utilized throughput of pool in MiB/s
    coolAccess Boolean
    If enabled (true) the pool can contain cool Access enabled volumes.
    encryptionType String
    Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.
    qosType String
    The qos type of the pool
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    poolId string
    UUID v4 used to identify the Pool
    provisioningState string
    Azure lifecycle management
    serviceLevel string
    The service level of the file system
    size number
    Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    totalThroughputMibps number
    Total throughput of pool in MiB/s
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    utilizedThroughputMibps number
    Utilized throughput of pool in MiB/s
    coolAccess boolean
    If enabled (true) the pool can contain cool Access enabled volumes.
    encryptionType string
    Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.
    qosType string
    The qos type of the pool
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    pool_id str
    UUID v4 used to identify the Pool
    provisioning_state str
    Azure lifecycle management
    service_level str
    The service level of the file system
    size float
    Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    total_throughput_mibps float
    Total throughput of pool in MiB/s
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    utilized_throughput_mibps float
    Utilized throughput of pool in MiB/s
    cool_access bool
    If enabled (true) the pool can contain cool Access enabled volumes.
    encryption_type str
    Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.
    qos_type str
    The qos type of the pool
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    poolId String
    UUID v4 used to identify the Pool
    provisioningState String
    Azure lifecycle management
    serviceLevel String
    The service level of the file system
    size Number
    Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    totalThroughputMibps Number
    Total throughput of pool in MiB/s
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    utilizedThroughputMibps Number
    Utilized throughput of pool in MiB/s
    coolAccess Boolean
    If enabled (true) the pool can contain cool Access enabled volumes.
    encryptionType String
    Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.
    qosType String
    The qos type of the pool
    tags Map<String>
    Resource tags.

    Supporting Types

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi