Docs Packages
  1. Pulumi Registry
  2. Azure Native
  3. API Docs
  4. sql
  5. InstancePool
azure-native logo
Azure Native v1.102.0, May 2 23

azure-native.sql.InstancePool

Explore with Pulumi AI

An Azure SQL instance pool. API Version: 2020-11-01-preview.

Example Usage

Create an instance pool with all properties.

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var instancePool = new AzureNative.Sql.InstancePool("instancePool", new()
    {
        InstancePoolName = "testIP",
        LicenseType = "LicenseIncluded",
        Location = "japaneast",
        ResourceGroupName = "group1",
        Sku = new AzureNative.Sql.Inputs.SkuArgs
        {
            Family = "Gen5",
            Name = "GP_Gen5",
            Tier = "GeneralPurpose",
        },
        SubnetId = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1",
        Tags = 
        {
            { "a", "b" },
        },
        VCores = 8,
    });

});

package main

import (
	sql "github.com/pulumi/pulumi-azure-native/sdk/go/azure/sql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sql.NewInstancePool(ctx, "instancePool", &sql.InstancePoolArgs{
			InstancePoolName:  pulumi.String("testIP"),
			LicenseType:       pulumi.String("LicenseIncluded"),
			Location:          pulumi.String("japaneast"),
			ResourceGroupName: pulumi.String("group1"),
			Sku: sql.SkuResponse{
				Family: pulumi.String("Gen5"),
				Name:   pulumi.String("GP_Gen5"),
				Tier:   pulumi.String("GeneralPurpose"),
			},
			SubnetId: pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1"),
			Tags: pulumi.StringMap{
				"a": pulumi.String("b"),
			},
			VCores: pulumi.Int(8),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.sql.InstancePool;
import com.pulumi.azurenative.sql.InstancePoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var instancePool = new InstancePool("instancePool", InstancePoolArgs.builder()        
            .instancePoolName("testIP")
            .licenseType("LicenseIncluded")
            .location("japaneast")
            .resourceGroupName("group1")
            .sku(Map.ofEntries(
                Map.entry("family", "Gen5"),
                Map.entry("name", "GP_Gen5"),
                Map.entry("tier", "GeneralPurpose")
            ))
            .subnetId("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1")
            .tags(Map.of("a", "b"))
            .vCores(8)
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

instance_pool = azure_native.sql.InstancePool("instancePool",
    instance_pool_name="testIP",
    license_type="LicenseIncluded",
    location="japaneast",
    resource_group_name="group1",
    sku=azure_native.sql.SkuResponseArgs(
        family="Gen5",
        name="GP_Gen5",
        tier="GeneralPurpose",
    ),
    subnet_id="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1",
    tags={
        "a": "b",
    },
    v_cores=8)

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const instancePool = new azure_native.sql.InstancePool("instancePool", {
    instancePoolName: "testIP",
    licenseType: "LicenseIncluded",
    location: "japaneast",
    resourceGroupName: "group1",
    sku: {
        family: "Gen5",
        name: "GP_Gen5",
        tier: "GeneralPurpose",
    },
    subnetId: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1",
    tags: {
        a: "b",
    },
    vCores: 8,
});

resources:
  instancePool:
    type: azure-native:sql:InstancePool
    properties:
      instancePoolName: testIP
      licenseType: LicenseIncluded
      location: japaneast
      resourceGroupName: group1
      sku:
        family: Gen5
        name: GP_Gen5
        tier: GeneralPurpose
      subnetId: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1
      tags:
        a: b
      vCores: 8

Create an instance pool with min properties.

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var instancePool = new AzureNative.Sql.InstancePool("instancePool", new()
    {
        InstancePoolName = "testIP",
        LicenseType = "LicenseIncluded",
        Location = "japaneast",
        ResourceGroupName = "group1",
        Sku = new AzureNative.Sql.Inputs.SkuArgs
        {
            Family = "Gen5",
            Name = "GP_Gen5",
            Tier = "GeneralPurpose",
        },
        SubnetId = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1",
        VCores = 8,
    });

});

package main

import (
	sql "github.com/pulumi/pulumi-azure-native/sdk/go/azure/sql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sql.NewInstancePool(ctx, "instancePool", &sql.InstancePoolArgs{
			InstancePoolName:  pulumi.String("testIP"),
			LicenseType:       pulumi.String("LicenseIncluded"),
			Location:          pulumi.String("japaneast"),
			ResourceGroupName: pulumi.String("group1"),
			Sku: sql.SkuResponse{
				Family: pulumi.String("Gen5"),
				Name:   pulumi.String("GP_Gen5"),
				Tier:   pulumi.String("GeneralPurpose"),
			},
			SubnetId: pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1"),
			VCores:   pulumi.Int(8),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.sql.InstancePool;
import com.pulumi.azurenative.sql.InstancePoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var instancePool = new InstancePool("instancePool", InstancePoolArgs.builder()        
            .instancePoolName("testIP")
            .licenseType("LicenseIncluded")
            .location("japaneast")
            .resourceGroupName("group1")
            .sku(Map.ofEntries(
                Map.entry("family", "Gen5"),
                Map.entry("name", "GP_Gen5"),
                Map.entry("tier", "GeneralPurpose")
            ))
            .subnetId("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1")
            .vCores(8)
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

instance_pool = azure_native.sql.InstancePool("instancePool",
    instance_pool_name="testIP",
    license_type="LicenseIncluded",
    location="japaneast",
    resource_group_name="group1",
    sku=azure_native.sql.SkuResponseArgs(
        family="Gen5",
        name="GP_Gen5",
        tier="GeneralPurpose",
    ),
    subnet_id="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1",
    v_cores=8)

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const instancePool = new azure_native.sql.InstancePool("instancePool", {
    instancePoolName: "testIP",
    licenseType: "LicenseIncluded",
    location: "japaneast",
    resourceGroupName: "group1",
    sku: {
        family: "Gen5",
        name: "GP_Gen5",
        tier: "GeneralPurpose",
    },
    subnetId: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1",
    vCores: 8,
});

resources:
  instancePool:
    type: azure-native:sql:InstancePool
    properties:
      instancePoolName: testIP
      licenseType: LicenseIncluded
      location: japaneast
      resourceGroupName: group1
      sku:
        family: Gen5
        name: GP_Gen5
        tier: GeneralPurpose
      subnetId: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet1
      vCores: 8

Create InstancePool Resource

new InstancePool(name: string, args: InstancePoolArgs, opts?: CustomResourceOptions);
@overload
def InstancePool(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 instance_pool_name: Optional[str] = None,
                 license_type: Optional[Union[str, InstancePoolLicenseType]] = None,
                 location: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 sku: Optional[SkuArgs] = None,
                 subnet_id: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 v_cores: Optional[int] = None)
@overload
def InstancePool(resource_name: str,
                 args: InstancePoolArgs,
                 opts: Optional[ResourceOptions] = None)
func NewInstancePool(ctx *Context, name string, args InstancePoolArgs, opts ...ResourceOption) (*InstancePool, error)
public InstancePool(string name, InstancePoolArgs args, CustomResourceOptions? opts = null)
public InstancePool(String name, InstancePoolArgs args)
public InstancePool(String name, InstancePoolArgs args, CustomResourceOptions options)

type: azure-native:sql:InstancePool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args InstancePoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args InstancePoolArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args InstancePoolArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args InstancePoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args InstancePoolArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

InstancePool Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The InstancePool resource accepts the following input properties:

LicenseType string | Pulumi.AzureNative.Sql.InstancePoolLicenseType

The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).

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.

SubnetId string

Resource ID of the subnet to place this instance pool in.

VCores int

Count of vCores belonging to this instance pool.

InstancePoolName string

The name of the instance pool to be created or updated.

Location string

Resource location.

Sku Pulumi.AzureNative.Sql.Inputs.SkuArgs

The name and tier of the SKU.

Tags Dictionary<string, string>

Resource tags.

LicenseType string | InstancePoolLicenseType

The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).

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.

SubnetId string

Resource ID of the subnet to place this instance pool in.

VCores int

Count of vCores belonging to this instance pool.

InstancePoolName string

The name of the instance pool to be created or updated.

Location string

Resource location.

Sku SkuArgs

The name and tier of the SKU.

Tags map[string]string

Resource tags.

licenseType String | InstancePoolLicenseType

The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).

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.

subnetId String

Resource ID of the subnet to place this instance pool in.

vCores Integer

Count of vCores belonging to this instance pool.

instancePoolName String

The name of the instance pool to be created or updated.

location String

Resource location.

sku SkuArgs

The name and tier of the SKU.

tags Map<String,String>

Resource tags.

licenseType string | InstancePoolLicenseType

The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).

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.

subnetId string

Resource ID of the subnet to place this instance pool in.

vCores number

Count of vCores belonging to this instance pool.

instancePoolName string

The name of the instance pool to be created or updated.

location string

Resource location.

sku SkuArgs

The name and tier of the SKU.

tags {[key: string]: string}

Resource tags.

license_type str | InstancePoolLicenseType

The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).

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.

subnet_id str

Resource ID of the subnet to place this instance pool in.

v_cores int

Count of vCores belonging to this instance pool.

instance_pool_name str

The name of the instance pool to be created or updated.

location str

Resource location.

sku SkuArgs

The name and tier of the SKU.

tags Mapping[str, str]

Resource tags.

licenseType String | "LicenseIncluded" | "BasePrice"

The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).

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.

subnetId String

Resource ID of the subnet to place this instance pool in.

vCores Number

Count of vCores belonging to this instance pool.

instancePoolName String

The name of the instance pool to be created or updated.

location String

Resource location.

sku Property Map

The name and tier of the SKU.

tags Map<String>

Resource tags.

Outputs

All input properties are implicitly available as output properties. Additionally, the InstancePool resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Name string

Resource name.

Type string

Resource type.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Resource name.

Type string

Resource type.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name.

type String

Resource type.

id string

The provider-assigned unique ID for this managed resource.

name string

Resource name.

type string

Resource type.

id str

The provider-assigned unique ID for this managed resource.

name str

Resource name.

type str

Resource type.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name.

type String

Resource type.

Supporting Types

InstancePoolLicenseType

LicenseIncluded
LicenseIncluded
BasePrice
BasePrice
InstancePoolLicenseTypeLicenseIncluded
LicenseIncluded
InstancePoolLicenseTypeBasePrice
BasePrice
LicenseIncluded
LicenseIncluded
BasePrice
BasePrice
LicenseIncluded
LicenseIncluded
BasePrice
BasePrice
LICENSE_INCLUDED
LicenseIncluded
BASE_PRICE
BasePrice
"LicenseIncluded"
LicenseIncluded
"BasePrice"
BasePrice

Sku

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.

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.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:sql:InstancePool testIP /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0