1. Packages
  2. Azure Native
  3. API Docs
  4. sqlvirtualmachine
  5. getSqlVirtualMachineGroup
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.0.1 published on Monday, Apr 7, 2025 by Pulumi

azure-native.sqlvirtualmachine.getSqlVirtualMachineGroup

Explore with Pulumi AI

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.0.1 published on Monday, Apr 7, 2025 by Pulumi

Gets a SQL virtual machine group.

Uses Azure REST API version 2023-10-01.

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

Using getSqlVirtualMachineGroup

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 getSqlVirtualMachineGroup(args: GetSqlVirtualMachineGroupArgs, opts?: InvokeOptions): Promise<GetSqlVirtualMachineGroupResult>
function getSqlVirtualMachineGroupOutput(args: GetSqlVirtualMachineGroupOutputArgs, opts?: InvokeOptions): Output<GetSqlVirtualMachineGroupResult>
Copy
def get_sql_virtual_machine_group(resource_group_name: Optional[str] = None,
                                  sql_virtual_machine_group_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetSqlVirtualMachineGroupResult
def get_sql_virtual_machine_group_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                  sql_virtual_machine_group_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetSqlVirtualMachineGroupResult]
Copy
func LookupSqlVirtualMachineGroup(ctx *Context, args *LookupSqlVirtualMachineGroupArgs, opts ...InvokeOption) (*LookupSqlVirtualMachineGroupResult, error)
func LookupSqlVirtualMachineGroupOutput(ctx *Context, args *LookupSqlVirtualMachineGroupOutputArgs, opts ...InvokeOption) LookupSqlVirtualMachineGroupResultOutput
Copy

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

public static class GetSqlVirtualMachineGroup 
{
    public static Task<GetSqlVirtualMachineGroupResult> InvokeAsync(GetSqlVirtualMachineGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetSqlVirtualMachineGroupResult> Invoke(GetSqlVirtualMachineGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSqlVirtualMachineGroupResult> getSqlVirtualMachineGroup(GetSqlVirtualMachineGroupArgs args, InvokeOptions options)
public static Output<GetSqlVirtualMachineGroupResult> getSqlVirtualMachineGroup(GetSqlVirtualMachineGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:sqlvirtualmachine:getSqlVirtualMachineGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
SqlVirtualMachineGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the SQL virtual machine group.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
SqlVirtualMachineGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the SQL virtual machine group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
sqlVirtualMachineGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the SQL virtual machine group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
sqlVirtualMachineGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the SQL virtual machine group.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
sql_virtual_machine_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the SQL virtual machine group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
sqlVirtualMachineGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the SQL virtual machine group.

getSqlVirtualMachineGroup Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
ClusterConfiguration string
Cluster type.
ClusterManagerType string
Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type.
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
ProvisioningState string
Provisioning state to track the async operation status.
ScaleType string
Scale type.
SystemData Pulumi.AzureNative.SqlVirtualMachine.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Resource type.
SqlImageOffer string
SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.
SqlImageSku string
SQL image sku.
Tags Dictionary<string, string>
Resource tags.
WsfcDomainProfile Pulumi.AzureNative.SqlVirtualMachine.Outputs.WsfcDomainProfileResponse
Cluster Active Directory domain profile.
AzureApiVersion string
The Azure API version of the resource.
ClusterConfiguration string
Cluster type.
ClusterManagerType string
Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type.
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
ProvisioningState string
Provisioning state to track the async operation status.
ScaleType string
Scale type.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Resource type.
SqlImageOffer string
SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.
SqlImageSku string
SQL image sku.
Tags map[string]string
Resource tags.
WsfcDomainProfile WsfcDomainProfileResponse
Cluster Active Directory domain profile.
azureApiVersion String
The Azure API version of the resource.
clusterConfiguration String
Cluster type.
clusterManagerType String
Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type.
id String
Resource ID.
location String
Resource location.
name String
Resource name.
provisioningState String
Provisioning state to track the async operation status.
scaleType String
Scale type.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
Resource type.
sqlImageOffer String
SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.
sqlImageSku String
SQL image sku.
tags Map<String,String>
Resource tags.
wsfcDomainProfile WsfcDomainProfileResponse
Cluster Active Directory domain profile.
azureApiVersion string
The Azure API version of the resource.
clusterConfiguration string
Cluster type.
clusterManagerType string
Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type.
id string
Resource ID.
location string
Resource location.
name string
Resource name.
provisioningState string
Provisioning state to track the async operation status.
scaleType string
Scale type.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
Resource type.
sqlImageOffer string
SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.
sqlImageSku string
SQL image sku.
tags {[key: string]: string}
Resource tags.
wsfcDomainProfile WsfcDomainProfileResponse
Cluster Active Directory domain profile.
azure_api_version str
The Azure API version of the resource.
cluster_configuration str
Cluster type.
cluster_manager_type str
Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type.
id str
Resource ID.
location str
Resource location.
name str
Resource name.
provisioning_state str
Provisioning state to track the async operation status.
scale_type str
Scale type.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
Resource type.
sql_image_offer str
SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.
sql_image_sku str
SQL image sku.
tags Mapping[str, str]
Resource tags.
wsfc_domain_profile WsfcDomainProfileResponse
Cluster Active Directory domain profile.
azureApiVersion String
The Azure API version of the resource.
clusterConfiguration String
Cluster type.
clusterManagerType String
Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type.
id String
Resource ID.
location String
Resource location.
name String
Resource name.
provisioningState String
Provisioning state to track the async operation status.
scaleType String
Scale type.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
Resource type.
sqlImageOffer String
SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.
sqlImageSku String
SQL image sku.
tags Map<String>
Resource tags.
wsfcDomainProfile Property Map
Cluster Active Directory domain profile.

Supporting Types

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.

WsfcDomainProfileResponse

ClusterBootstrapAccount string
Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain).
ClusterOperatorAccount string
Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster.
ClusterSubnetType string
Cluster subnet type.
DomainFqdn string
Fully qualified name of the domain.
FileShareWitnessPath string
Optional path for fileshare witness.
IsSqlServiceAccountGmsa bool
The flag to check if SQL service account is GMSA.
OuPath string
Organizational Unit path in which the nodes and cluster will be present.
SqlServiceAccount string
Account name under which SQL service will run on all participating SQL virtual machines in the cluster.
StorageAccountUrl string
Fully qualified ARM resource id of the witness storage account.
ClusterBootstrapAccount string
Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain).
ClusterOperatorAccount string
Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster.
ClusterSubnetType string
Cluster subnet type.
DomainFqdn string
Fully qualified name of the domain.
FileShareWitnessPath string
Optional path for fileshare witness.
IsSqlServiceAccountGmsa bool
The flag to check if SQL service account is GMSA.
OuPath string
Organizational Unit path in which the nodes and cluster will be present.
SqlServiceAccount string
Account name under which SQL service will run on all participating SQL virtual machines in the cluster.
StorageAccountUrl string
Fully qualified ARM resource id of the witness storage account.
clusterBootstrapAccount String
Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain).
clusterOperatorAccount String
Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster.
clusterSubnetType String
Cluster subnet type.
domainFqdn String
Fully qualified name of the domain.
fileShareWitnessPath String
Optional path for fileshare witness.
isSqlServiceAccountGmsa Boolean
The flag to check if SQL service account is GMSA.
ouPath String
Organizational Unit path in which the nodes and cluster will be present.
sqlServiceAccount String
Account name under which SQL service will run on all participating SQL virtual machines in the cluster.
storageAccountUrl String
Fully qualified ARM resource id of the witness storage account.
clusterBootstrapAccount string
Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain).
clusterOperatorAccount string
Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster.
clusterSubnetType string
Cluster subnet type.
domainFqdn string
Fully qualified name of the domain.
fileShareWitnessPath string
Optional path for fileshare witness.
isSqlServiceAccountGmsa boolean
The flag to check if SQL service account is GMSA.
ouPath string
Organizational Unit path in which the nodes and cluster will be present.
sqlServiceAccount string
Account name under which SQL service will run on all participating SQL virtual machines in the cluster.
storageAccountUrl string
Fully qualified ARM resource id of the witness storage account.
cluster_bootstrap_account str
Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain).
cluster_operator_account str
Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster.
cluster_subnet_type str
Cluster subnet type.
domain_fqdn str
Fully qualified name of the domain.
file_share_witness_path str
Optional path for fileshare witness.
is_sql_service_account_gmsa bool
The flag to check if SQL service account is GMSA.
ou_path str
Organizational Unit path in which the nodes and cluster will be present.
sql_service_account str
Account name under which SQL service will run on all participating SQL virtual machines in the cluster.
storage_account_url str
Fully qualified ARM resource id of the witness storage account.
clusterBootstrapAccount String
Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain).
clusterOperatorAccount String
Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster.
clusterSubnetType String
Cluster subnet type.
domainFqdn String
Fully qualified name of the domain.
fileShareWitnessPath String
Optional path for fileshare witness.
isSqlServiceAccountGmsa Boolean
The flag to check if SQL service account is GMSA.
ouPath String
Organizational Unit path in which the nodes and cluster will be present.
sqlServiceAccount String
Account name under which SQL service will run on all participating SQL virtual machines in the cluster.
storageAccountUrl String
Fully qualified ARM resource id of the witness storage account.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.0.1 published on Monday, Apr 7, 2025 by Pulumi