Sql Virtual Machine Groups - List
Gets all SQL virtual machine groups in a subscription.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups?api-version=2023-10-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
Subscription ID that identifies an Azure subscription. |
api-version
|
query | True |
string |
API version to use for the request. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Successfully retrieved all SQL virtual machine groups in the subscription. |
|
Other Status Codes |
*** Error Responses: ***
|
Examples
Gets all SQL virtual machine groups in a subscription.
Sample request
GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups?api-version=2023-10-01
Sample response
{
"value": [
{
"properties": {
"provisioningState": "Succeeded",
"sqlImageOffer": "SQL2017-WS2016",
"sqlImageSku": "Enterprise",
"wsfcDomainProfile": {
"domainFqdn": "testdomain.com",
"ouPath": "OU=WSCluster,DC=testdomain,DC=com",
"clusterBootstrapAccount": "testrpadmin",
"clusterOperatorAccount": "testrp@testdomain.com",
"sqlServiceAccount": "sqlservice@testdomain.com",
"isSqlServiceAccountGmsa": false,
"storageAccountUrl": "https://storgact.blob.core.windows.net/",
"clusterSubnetType": "MultiSubnet"
}
},
"location": "northeurope",
"tags": {
"mytag": "myval"
},
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/",
"name": "testvmgroup",
"type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups"
},
{
"properties": {
"provisioningState": "Succeeded",
"sqlImageOffer": "SQL2016-WS2016",
"sqlImageSku": "Enterprise",
"wsfcDomainProfile": {
"domainFqdn": "testdomain.com",
"ouPath": "OU=WSCluster,DC=testdomain,DC=com",
"clusterBootstrapAccount": "testrpadmin",
"clusterOperatorAccount": "testrp@testdomain.com",
"sqlServiceAccount": "sqlservice@testdomain.com",
"isSqlServiceAccountGmsa": false,
"storageAccountUrl": "https://storgact.blob.core.windows.net/",
"clusterSubnetType": "MultiSubnet"
}
},
"location": "northeurope",
"tags": {
"mytag": "myval"
},
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg1/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/",
"name": "testvmgroup1",
"type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups"
},
{
"properties": {
"provisioningState": "Succeeded",
"sqlImageOffer": "SQL2016-WS2016",
"sqlImageSku": "Enterprise",
"wsfcDomainProfile": {
"domainFqdn": "testdomain.com",
"ouPath": "OU=WSCluster,DC=testdomain,DC=com",
"clusterBootstrapAccount": "testrpadmin",
"clusterOperatorAccount": "testrp@testdomain.com",
"sqlServiceAccount": "sqlservice@testdomain.com",
"isSqlServiceAccountGmsa": false,
"storageAccountUrl": "https://storgact.blob.core.windows.net/",
"clusterSubnetType": "MultiSubnet"
}
},
"location": "northeurope",
"tags": {
"mytag": "myval"
},
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg2/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/",
"name": "testvmgroup2",
"type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups"
}
]
}
Definitions
Name | Description |
---|---|
Cluster |
Cluster type. |
Cluster |
Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. |
Cluster |
Cluster subnet type. |
created |
The type of identity that created the resource. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Scale |
Scale type. |
Sql |
A SQL virtual machine group. |
Sql |
A list of SQL virtual machine groups. |
Sql |
SQL image sku. |
system |
Metadata pertaining to creation and last modification of the resource. |
Wsfc |
Active Directory account details to operate Windows Server Failover Cluster. |
ClusterConfiguration
Cluster type.
Name | Type | Description |
---|---|---|
Domainful |
string |
ClusterManagerType
Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type.
Name | Type | Description |
---|---|---|
WSFC |
string |
ClusterSubnetType
Cluster subnet type.
Name | Type | Description |
---|---|---|
MultiSubnet |
string |
|
SingleSubnet |
string |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
ScaleType
Scale type.
Name | Type | Description |
---|---|---|
HA |
string |
SqlVirtualMachineGroup
A SQL virtual machine group.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |
location |
string |
Resource location. |
name |
string |
Resource name. |
properties.clusterConfiguration |
Cluster type. |
|
properties.clusterManagerType |
Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. |
|
properties.provisioningState |
string |
Provisioning state to track the async operation status. |
properties.scaleType |
Scale type. |
|
properties.sqlImageOffer |
string |
SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. |
properties.sqlImageSku |
SQL image sku. |
|
properties.wsfcDomainProfile |
Cluster Active Directory domain profile. |
|
systemData |
Metadata pertaining to creation and last modification of the resource. |
|
tags |
object |
Resource tags. |
type |
string |
Resource type. |
SqlVirtualMachineGroupListResult
A list of SQL virtual machine groups.
Name | Type | Description |
---|---|---|
nextLink |
string |
Link to retrieve next page of results. |
value |
Array of results. |
SqlVmGroupImageSku
SQL image sku.
Name | Type | Description |
---|---|---|
Developer |
string |
|
Enterprise |
string |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
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 |
The type of identity that last modified the resource. |
WsfcDomainProfile
Active Directory account details to operate Windows Server Failover Cluster.
Name | Type | Description |
---|---|---|
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 |
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. |
storageAccountPrimaryKey |
string |
Primary key of the witness storage account. |
storageAccountUrl |
string |
Fully qualified ARM resource id of the witness storage account. |