Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. VirtualCluster
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.7.1 published on Wednesday, Aug 13, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.VirtualCluster

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.7.1 published on Wednesday, Aug 13, 2025 by Pulumi
pulumi/pulumi-azure-native

    An Azure SQL virtual cluster.

    Uses Azure REST API version 2024-11-01-preview.

    Example Usage

    Create virtual cluster

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

return await Deployment.RunAsync(() => 
{
    var virtualCluster = new AzureNative.Sql.VirtualCluster("virtualCluster", new()
    {
        Location = "japaneast",
        ResourceGroupName = "testrg",
        Tags = 
        {
            { "key", "value" },
        },
        VirtualClusterName = "vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sql.NewVirtualCluster(ctx, "virtualCluster", &sql.VirtualClusterArgs{
			Location:          pulumi.String("japaneast"),
			ResourceGroupName: pulumi.String("testrg"),
			Tags: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
			VirtualClusterName: pulumi.String("vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2"),
		})
		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.VirtualCluster;
import com.pulumi.azurenative.sql.VirtualClusterArgs;
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 virtualCluster = new VirtualCluster("virtualCluster", VirtualClusterArgs.builder()
            .location("japaneast")
            .resourceGroupName("testrg")
            .tags(Map.of("key", "value"))
            .virtualClusterName("vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2")
            .build());

    }
}

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

const virtualCluster = new azure_native.sql.VirtualCluster("virtualCluster", {
    location: "japaneast",
    resourceGroupName: "testrg",
    tags: {
        key: "value",
    },
    virtualClusterName: "vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2",
});

    import pulumi
import pulumi_azure_native as azure_native

virtual_cluster = azure_native.sql.VirtualCluster("virtualCluster",
    location="japaneast",
    resource_group_name="testrg",
    tags={
        "key": "value",
    },
    virtual_cluster_name="vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2")

    resources:
  virtualCluster:
    type: azure-native:sql:VirtualCluster
    properties:
      location: japaneast
      resourceGroupName: testrg
      tags:
        key: value
      virtualClusterName: vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2

    Create VirtualCluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VirtualCluster(name: string, args: VirtualClusterArgs, opts?: CustomResourceOptions);
    @overload
def VirtualCluster(resource_name: str,
                   args: VirtualClusterArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def VirtualCluster(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   resource_group_name: Optional[str] = None,
                   location: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   version: Optional[str] = None,
                   virtual_cluster_name: Optional[str] = None)
    func NewVirtualCluster(ctx *Context, name string, args VirtualClusterArgs, opts ...ResourceOption) (*VirtualCluster, error)
    public VirtualCluster(string name, VirtualClusterArgs args, CustomResourceOptions? opts = null)
    public VirtualCluster(String name, VirtualClusterArgs args)
public VirtualCluster(String name, VirtualClusterArgs args, CustomResourceOptions options)

    type: azure-native:sql:VirtualCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VirtualClusterArgs
    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 VirtualClusterArgs
    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 VirtualClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var virtualClusterResource = new AzureNative.Sql.VirtualCluster("virtualClusterResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Version = "string",
    VirtualClusterName = "string",
});

    example, err := sql.NewVirtualCluster(ctx, "virtualClusterResource", &sql.VirtualClusterArgs{
	ResourceGroupName: pulumi.String("string"),
	Location:          pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Version:            pulumi.String("string"),
	VirtualClusterName: pulumi.String("string"),
})

    var virtualClusterResource = new VirtualCluster("virtualClusterResource", VirtualClusterArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .tags(Map.of("string", "string"))
    .version("string")
    .virtualClusterName("string")
    .build());

    virtual_cluster_resource = azure_native.sql.VirtualCluster("virtualClusterResource",
    resource_group_name="string",
    location="string",
    tags={
        "string": "string",
    },
    version="string",
    virtual_cluster_name="string")

    const virtualClusterResource = new azure_native.sql.VirtualCluster("virtualClusterResource", {
    resourceGroupName: "string",
    location: "string",
    tags: {
        string: "string",
    },
    version: "string",
    virtualClusterName: "string",
});

    type: azure-native:sql:VirtualCluster
properties:
    location: string
    resourceGroupName: string
    tags:
        string: string
    version: string
    virtualClusterName: string

    VirtualCluster Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VirtualCluster resource accepts the following input properties:

    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.
    Location string
    Resource location.
    Tags Dictionary<string, string>
    Resource tags.
    Version string
    Virtual cluster version.
    VirtualClusterName string
    The name of the virtual cluster.
    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.
    Location string
    Resource location.
    Tags map[string]string
    Resource tags.
    Version string
    Virtual cluster version.
    VirtualClusterName string
    The name of the virtual cluster.
    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.
    location String
    Resource location.
    tags Map<String,String>
    Resource tags.
    version String
    Virtual cluster version.
    virtualClusterName String
    The name of the virtual cluster.
    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.
    location string
    Resource location.
    tags {[key: string]: string}
    Resource tags.
    version string
    Virtual cluster version.
    virtualClusterName string
    The name of the virtual cluster.
    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.
    location str
    Resource location.
    tags Mapping[str, str]
    Resource tags.
    version str
    Virtual cluster version.
    virtual_cluster_name str
    The name of the virtual cluster.
    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.
    location String
    Resource location.
    tags Map<String>
    Resource tags.
    version String
    Virtual cluster version.
    virtualClusterName String
    The name of the virtual cluster.

    Outputs

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

    AzureApiVersion string
    The Azure API version of the resource.
    ChildResources List<string>
    List of resources in this virtual cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    SubnetId string
    Subnet resource ID for the virtual cluster.
    Type string
    Resource type.
    AzureApiVersion string
    The Azure API version of the resource.
    ChildResources []string
    List of resources in this virtual cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    SubnetId string
    Subnet resource ID for the virtual cluster.
    Type string
    Resource type.
    azureApiVersion String
    The Azure API version of the resource.
    childResources List<String>
    List of resources in this virtual cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    subnetId String
    Subnet resource ID for the virtual cluster.
    type String
    Resource type.
    azureApiVersion string
    The Azure API version of the resource.
    childResources string[]
    List of resources in this virtual cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name.
    subnetId string
    Subnet resource ID for the virtual cluster.
    type string
    Resource type.
    azure_api_version str
    The Azure API version of the resource.
    child_resources Sequence[str]
    List of resources in this virtual cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name.
    subnet_id str
    Subnet resource ID for the virtual cluster.
    type str
    Resource type.
    azureApiVersion String
    The Azure API version of the resource.
    childResources List<String>
    List of resources in this virtual cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    subnetId String
    Subnet resource ID for the virtual cluster.
    type String
    Resource type.

    Import

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

    $ pulumi import azure-native:sql:VirtualCluster vc-f769ed71-b3ad-491a-a9d5-26eeceaa6be2 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/virtualClusters/{virtualClusterName}

    To learn more about importing existing cloud resources, see Importing resources.

    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.7.1 published on Wednesday, Aug 13, 2025 by Pulumi
    pulumi/pulumi-azure-native