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. getVirtualCluster
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.getVirtualCluster

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

    Gets a virtual cluster.

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

    Using getVirtualCluster

    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 getVirtualCluster(args: GetVirtualClusterArgs, opts?: InvokeOptions): Promise<GetVirtualClusterResult>
function getVirtualClusterOutput(args: GetVirtualClusterOutputArgs, opts?: InvokeOptions): Output<GetVirtualClusterResult>
    def get_virtual_cluster(resource_group_name: Optional[str] = None,
                        virtual_cluster_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVirtualClusterResult
def get_virtual_cluster_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                        virtual_cluster_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetVirtualClusterResult]
    func LookupVirtualCluster(ctx *Context, args *LookupVirtualClusterArgs, opts ...InvokeOption) (*LookupVirtualClusterResult, error)
func LookupVirtualClusterOutput(ctx *Context, args *LookupVirtualClusterOutputArgs, opts ...InvokeOption) LookupVirtualClusterResultOutput

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

    public static class GetVirtualCluster 
{
    public static Task<GetVirtualClusterResult> InvokeAsync(GetVirtualClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualClusterResult> Invoke(GetVirtualClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVirtualClusterResult> getVirtualCluster(GetVirtualClusterArgs args, InvokeOptions options)
public static Output<GetVirtualClusterResult> getVirtualCluster(GetVirtualClusterArgs args, InvokeOptions options)

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

    The following arguments are supported:

    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.
    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.
    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.
    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.
    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.
    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.
    virtualClusterName String
    The name of the virtual cluster.

    getVirtualCluster Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    ChildResources List<string>
    List of resources in this virtual cluster.
    Id string
    Resource ID.
    Location string
    Resource location.
    Name string
    Resource name.
    SubnetId string
    Subnet resource ID for the virtual cluster.
    Type string
    Resource type.
    Tags Dictionary<string, string>
    Resource tags.
    Version string
    Virtual cluster version.
    AzureApiVersion string
    The Azure API version of the resource.
    ChildResources []string
    List of resources in this virtual cluster.
    Id string
    Resource ID.
    Location string
    Resource location.
    Name string
    Resource name.
    SubnetId string
    Subnet resource ID for the virtual cluster.
    Type string
    Resource type.
    Tags map[string]string
    Resource tags.
    Version string
    Virtual cluster version.
    azureApiVersion String
    The Azure API version of the resource.
    childResources List<String>
    List of resources in this virtual cluster.
    id String
    Resource ID.
    location String
    Resource location.
    name String
    Resource name.
    subnetId String
    Subnet resource ID for the virtual cluster.
    type String
    Resource type.
    tags Map<String,String>
    Resource tags.
    version String
    Virtual cluster version.
    azureApiVersion string
    The Azure API version of the resource.
    childResources string[]
    List of resources in this virtual cluster.
    id string
    Resource ID.
    location string
    Resource location.
    name string
    Resource name.
    subnetId string
    Subnet resource ID for the virtual cluster.
    type string
    Resource type.
    tags {[key: string]: string}
    Resource tags.
    version string
    Virtual cluster version.
    azure_api_version str
    The Azure API version of the resource.
    child_resources Sequence[str]
    List of resources in this virtual cluster.
    id str
    Resource ID.
    location str
    Resource location.
    name str
    Resource name.
    subnet_id str
    Subnet resource ID for the virtual cluster.
    type str
    Resource type.
    tags Mapping[str, str]
    Resource tags.
    version str
    Virtual cluster version.
    azureApiVersion String
    The Azure API version of the resource.
    childResources List<String>
    List of resources in this virtual cluster.
    id String
    Resource ID.
    location String
    Resource location.
    name String
    Resource name.
    subnetId String
    Subnet resource ID for the virtual cluster.
    type String
    Resource type.
    tags Map<String>
    Resource tags.
    version String
    Virtual cluster version.

    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