Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. containerstorage
  5. getPool
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.containerstorage.getPool

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Get a Pool API Version: 2023-03-01-preview.

    Using getPool

    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 getPool(args: GetPoolArgs, opts?: InvokeOptions): Promise<GetPoolResult>
function getPoolOutput(args: GetPoolOutputArgs, opts?: InvokeOptions): Output<GetPoolResult>
    def get_pool(pool_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetPoolResult
def get_pool_output(pool_name: Optional[pulumi.Input[str]] = None,
             resource_group_name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetPoolResult]
    func LookupPool(ctx *Context, args *LookupPoolArgs, opts ...InvokeOption) (*LookupPoolResult, error)
func LookupPoolOutput(ctx *Context, args *LookupPoolOutputArgs, opts ...InvokeOption) LookupPoolResultOutput

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

    public static class GetPool 
{
    public static Task<GetPoolResult> InvokeAsync(GetPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetPoolResult> Invoke(GetPoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:containerstorage:getPool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PoolName string
    Pool Object
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    PoolName string
    Pool Object
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    poolName String
    Pool Object
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    poolName string
    Pool Object
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    pool_name str
    Pool Object
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    poolName String
    Pool Object
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getPool Result

    The following output properties are available:

    Assignments List<string>
    List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For portable there can be many.
    ElasticSanPoolProperties Pulumi.AzureNative.ContainerStorage.Outputs.ElasticSanPoolPropertiesResponse
    Elastic San Pool Properties
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    PoolCapacityGiB double
    Initial capacity of the pool in GiB.
    PoolType double
    Type of the Pool: ephemeral, disk, managed, or elasticsan.
    ProvisioningState string
    The status of the last operation.
    SystemData Pulumi.AzureNative.ContainerStorage.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Zones List<string>
    List of availability zones that resources can be created in.
    DiskPoolProperties Pulumi.AzureNative.ContainerStorage.Outputs.DiskPoolPropertiesResponse
    Disk Pool Properties
    EphemeralPoolProperties Pulumi.AzureNative.ContainerStorage.Outputs.EphemeralPoolPropertiesResponse
    Ephemeral Pool Properties
    Tags Dictionary<string, string>
    Resource tags.
    Assignments []string
    List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For portable there can be many.
    ElasticSanPoolProperties ElasticSanPoolPropertiesResponse
    Elastic San Pool Properties
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    PoolCapacityGiB float64
    Initial capacity of the pool in GiB.
    PoolType float64
    Type of the Pool: ephemeral, disk, managed, or elasticsan.
    ProvisioningState string
    The status of the last operation.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Zones []string
    List of availability zones that resources can be created in.
    DiskPoolProperties DiskPoolPropertiesResponse
    Disk Pool Properties
    EphemeralPoolProperties EphemeralPoolPropertiesResponse
    Ephemeral Pool Properties
    Tags map[string]string
    Resource tags.
    assignments List<String>
    List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For portable there can be many.
    elasticSanPoolProperties ElasticSanPoolPropertiesResponse
    Elastic San Pool Properties
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    poolCapacityGiB Double
    Initial capacity of the pool in GiB.
    poolType Double
    Type of the Pool: ephemeral, disk, managed, or elasticsan.
    provisioningState String
    The status of the last operation.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    zones List<String>
    List of availability zones that resources can be created in.
    diskPoolProperties DiskPoolPropertiesResponse
    Disk Pool Properties
    ephemeralPoolProperties EphemeralPoolPropertiesResponse
    Ephemeral Pool Properties
    tags Map<String,String>
    Resource tags.
    assignments string[]
    List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For portable there can be many.
    elasticSanPoolProperties ElasticSanPoolPropertiesResponse
    Elastic San Pool Properties
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    poolCapacityGiB number
    Initial capacity of the pool in GiB.
    poolType number
    Type of the Pool: ephemeral, disk, managed, or elasticsan.
    provisioningState string
    The status of the last operation.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    zones string[]
    List of availability zones that resources can be created in.
    diskPoolProperties DiskPoolPropertiesResponse
    Disk Pool Properties
    ephemeralPoolProperties EphemeralPoolPropertiesResponse
    Ephemeral Pool Properties
    tags {[key: string]: string}
    Resource tags.
    assignments Sequence[str]
    List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For portable there can be many.
    elastic_san_pool_properties ElasticSanPoolPropertiesResponse
    Elastic San Pool Properties
    id str
    Fully qualified resource ID for the resource. Ex - /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_capacity_gi_b float
    Initial capacity of the pool in GiB.
    pool_type float
    Type of the Pool: ephemeral, disk, managed, or elasticsan.
    provisioning_state str
    The status of the last operation.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    zones Sequence[str]
    List of availability zones that resources can be created in.
    disk_pool_properties DiskPoolPropertiesResponse
    Disk Pool Properties
    ephemeral_pool_properties EphemeralPoolPropertiesResponse
    Ephemeral Pool Properties
    tags Mapping[str, str]
    Resource tags.
    assignments List<String>
    List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For portable there can be many.
    elasticSanPoolProperties Property Map
    Elastic San Pool Properties
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    poolCapacityGiB Number
    Initial capacity of the pool in GiB.
    poolType Number
    Type of the Pool: ephemeral, disk, managed, or elasticsan.
    provisioningState String
    The status of the last operation.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    zones List<String>
    List of availability zones that resources can be created in.
    diskPoolProperties Property Map
    Disk Pool Properties
    ephemeralPoolProperties Property Map
    Ephemeral Pool Properties
    tags Map<String>
    Resource tags.

    Supporting Types

    DiskPoolPropertiesResponse

    CsiParams Dictionary<string, string>
    List of KV pairs to set in StorageClass to configure CSI driver.
    Disks List<string>
    Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).
    MaxVolumeCapacityGiB double
    Maximum capacity of the volumes in GiB the user intends to create. Default 512.
    CsiParams map[string]string
    List of KV pairs to set in StorageClass to configure CSI driver.
    Disks []string
    Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).
    MaxVolumeCapacityGiB float64
    Maximum capacity of the volumes in GiB the user intends to create. Default 512.
    csiParams Map<String,String>
    List of KV pairs to set in StorageClass to configure CSI driver.
    disks List<String>
    Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).
    maxVolumeCapacityGiB Double
    Maximum capacity of the volumes in GiB the user intends to create. Default 512.
    csiParams {[key: string]: string}
    List of KV pairs to set in StorageClass to configure CSI driver.
    disks string[]
    Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).
    maxVolumeCapacityGiB number
    Maximum capacity of the volumes in GiB the user intends to create. Default 512.
    csi_params Mapping[str, str]
    List of KV pairs to set in StorageClass to configure CSI driver.
    disks Sequence[str]
    Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).
    max_volume_capacity_gi_b float
    Maximum capacity of the volumes in GiB the user intends to create. Default 512.
    csiParams Map<String>
    List of KV pairs to set in StorageClass to configure CSI driver.
    disks List<String>
    Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).
    maxVolumeCapacityGiB Number
    Maximum capacity of the volumes in GiB the user intends to create. Default 512.

    ElasticSanPoolPropertiesResponse

    ResourceGroup string
    Resource group of an existing SAN.
    SanName string
    Name of an existing SAN.
    VolumeGroup string
    Volume group of an existing SAN.
    ResourceGroup string
    Resource group of an existing SAN.
    SanName string
    Name of an existing SAN.
    VolumeGroup string
    Volume group of an existing SAN.
    resourceGroup String
    Resource group of an existing SAN.
    sanName String
    Name of an existing SAN.
    volumeGroup String
    Volume group of an existing SAN.
    resourceGroup string
    Resource group of an existing SAN.
    sanName string
    Name of an existing SAN.
    volumeGroup string
    Volume group of an existing SAN.
    resource_group str
    Resource group of an existing SAN.
    san_name str
    Name of an existing SAN.
    volume_group str
    Volume group of an existing SAN.
    resourceGroup String
    Resource group of an existing SAN.
    sanName String
    Name of an existing SAN.
    volumeGroup String
    Volume group of an existing SAN.

    EphemeralPoolPropertiesResponse

    DiskSelector List<string>
    Template name or KV pairs containing disk selection criteria, e.g. model="Microsoft NVMe Direct Disk" to match all Lsv2 NVMe disks.
    Disks List<string>
    Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).
    DiskFormat bool
    Consent to format the local disks.
    DiskSelector []string
    Template name or KV pairs containing disk selection criteria, e.g. model="Microsoft NVMe Direct Disk" to match all Lsv2 NVMe disks.
    Disks []string
    Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).
    DiskFormat bool
    Consent to format the local disks.
    diskSelector List<String>
    Template name or KV pairs containing disk selection criteria, e.g. model="Microsoft NVMe Direct Disk" to match all Lsv2 NVMe disks.
    disks List<String>
    Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).
    diskFormat Boolean
    Consent to format the local disks.
    diskSelector string[]
    Template name or KV pairs containing disk selection criteria, e.g. model="Microsoft NVMe Direct Disk" to match all Lsv2 NVMe disks.
    disks string[]
    Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).
    diskFormat boolean
    Consent to format the local disks.
    disk_selector Sequence[str]
    Template name or KV pairs containing disk selection criteria, e.g. model="Microsoft NVMe Direct Disk" to match all Lsv2 NVMe disks.
    disks Sequence[str]
    Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).
    disk_format bool
    Consent to format the local disks.
    diskSelector List<String>
    Template name or KV pairs containing disk selection criteria, e.g. model="Microsoft NVMe Direct Disk" to match all Lsv2 NVMe disks.
    disks List<String>
    Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).
    diskFormat Boolean
    Consent to format the local disks.

    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-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native