Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getInstancePool
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
pulumi/pulumi-azure-native

azure-native.sql.getInstancePool

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
pulumi/pulumi-azure-native

    Gets an instance pool.

    Uses Azure REST API version 2023-08-01.

    Other available API versions: 2018-06-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

    Using getInstancePool

    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 getInstancePool(args: GetInstancePoolArgs, opts?: InvokeOptions): Promise<GetInstancePoolResult>
function getInstancePoolOutput(args: GetInstancePoolOutputArgs, opts?: InvokeOptions): Output<GetInstancePoolResult>
    def get_instance_pool(instance_pool_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetInstancePoolResult
def get_instance_pool_output(instance_pool_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetInstancePoolResult]
    func LookupInstancePool(ctx *Context, args *LookupInstancePoolArgs, opts ...InvokeOption) (*LookupInstancePoolResult, error)
func LookupInstancePoolOutput(ctx *Context, args *LookupInstancePoolOutputArgs, opts ...InvokeOption) LookupInstancePoolResultOutput

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

    public static class GetInstancePool 
{
    public static Task<GetInstancePoolResult> InvokeAsync(GetInstancePoolArgs args, InvokeOptions? opts = null)
    public static Output<GetInstancePoolResult> Invoke(GetInstancePoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInstancePoolResult> getInstancePool(GetInstancePoolArgs args, InvokeOptions options)
public static Output<GetInstancePoolResult> getInstancePool(GetInstancePoolArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:sql:getInstancePool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstancePoolName string
    The name of the instance pool to be retrieved.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    InstancePoolName string
    The name of the instance pool to be retrieved.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    instancePoolName String
    The name of the instance pool to be retrieved.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    instancePoolName string
    The name of the instance pool to be retrieved.
    resourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    instance_pool_name str
    The name of the instance pool to be retrieved.
    resource_group_name str
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    instancePoolName String
    The name of the instance pool to be retrieved.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    getInstancePool Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    DnsZone string
    The Dns Zone that the managed instance pool is in.
    Id string
    Resource ID.
    LicenseType string
    The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).
    Location string
    Resource location.
    Name string
    Resource name.
    SubnetId string
    Resource ID of the subnet to place this instance pool in.
    Type string
    Resource type.
    VCores int
    Count of vCores belonging to this instance pool.
    MaintenanceConfigurationId string
    Specifies maintenance configuration id to apply to this managed instance.
    Sku Pulumi.AzureNative.Sql.Outputs.SkuResponse
    The name and tier of the SKU.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    DnsZone string
    The Dns Zone that the managed instance pool is in.
    Id string
    Resource ID.
    LicenseType string
    The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).
    Location string
    Resource location.
    Name string
    Resource name.
    SubnetId string
    Resource ID of the subnet to place this instance pool in.
    Type string
    Resource type.
    VCores int
    Count of vCores belonging to this instance pool.
    MaintenanceConfigurationId string
    Specifies maintenance configuration id to apply to this managed instance.
    Sku SkuResponse
    The name and tier of the SKU.
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    dnsZone String
    The Dns Zone that the managed instance pool is in.
    id String
    Resource ID.
    licenseType String
    The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).
    location String
    Resource location.
    name String
    Resource name.
    subnetId String
    Resource ID of the subnet to place this instance pool in.
    type String
    Resource type.
    vCores Integer
    Count of vCores belonging to this instance pool.
    maintenanceConfigurationId String
    Specifies maintenance configuration id to apply to this managed instance.
    sku SkuResponse
    The name and tier of the SKU.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    dnsZone string
    The Dns Zone that the managed instance pool is in.
    id string
    Resource ID.
    licenseType string
    The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).
    location string
    Resource location.
    name string
    Resource name.
    subnetId string
    Resource ID of the subnet to place this instance pool in.
    type string
    Resource type.
    vCores number
    Count of vCores belonging to this instance pool.
    maintenanceConfigurationId string
    Specifies maintenance configuration id to apply to this managed instance.
    sku SkuResponse
    The name and tier of the SKU.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    dns_zone str
    The Dns Zone that the managed instance pool is in.
    id str
    Resource ID.
    license_type str
    The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).
    location str
    Resource location.
    name str
    Resource name.
    subnet_id str
    Resource ID of the subnet to place this instance pool in.
    type str
    Resource type.
    v_cores int
    Count of vCores belonging to this instance pool.
    maintenance_configuration_id str
    Specifies maintenance configuration id to apply to this managed instance.
    sku SkuResponse
    The name and tier of the SKU.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    dnsZone String
    The Dns Zone that the managed instance pool is in.
    id String
    Resource ID.
    licenseType String
    The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).
    location String
    Resource location.
    name String
    Resource name.
    subnetId String
    Resource ID of the subnet to place this instance pool in.
    type String
    Resource type.
    vCores Number
    Count of vCores belonging to this instance pool.
    maintenanceConfigurationId String
    Specifies maintenance configuration id to apply to this managed instance.
    sku Property Map
    The name and tier of the SKU.
    tags Map<String>
    Resource tags.

    Supporting Types

    SkuResponse

    Name string
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    Capacity int
    Capacity of the particular SKU.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    Size of the particular SKU
    Tier string
    The tier or edition of the particular SKU, e.g. Basic, Premium.
    Name string
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    Capacity int
    Capacity of the particular SKU.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    Size of the particular SKU
    Tier string
    The tier or edition of the particular SKU, e.g. Basic, Premium.
    name String
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    capacity Integer
    Capacity of the particular SKU.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    Size of the particular SKU
    tier String
    The tier or edition of the particular SKU, e.g. Basic, Premium.
    name string
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    capacity number
    Capacity of the particular SKU.
    family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size string
    Size of the particular SKU
    tier string
    The tier or edition of the particular SKU, e.g. Basic, Premium.
    name str
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    capacity int
    Capacity of the particular SKU.
    family str
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size str
    Size of the particular SKU
    tier str
    The tier or edition of the particular SKU, e.g. Basic, Premium.
    name String
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    capacity Number
    Capacity of the particular SKU.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    Size of the particular SKU
    tier String
    The tier or edition of the particular SKU, e.g. Basic, Premium.

    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
    pulumi/pulumi-azure-native