Sql Virtual Machines - List By Sql Vm Group

Service:

SQL VM

API Version:

2023-10-01

Gets the list of sql virtual machines in a SQL virtual machine group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/sqlVirtualMachines?api-version=2023-10-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	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	path	True	string	Name of the SQL virtual machine group.
subscriptionId	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	SqlVirtualMachineListResult	Successfully retrieved the list of sql virtual machines in a SQL virtual machine group.
Other Status Codes	ErrorResponse	*** Error Responses: *** 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine. 400 InvalidSqlImageOffer - Provided SQL image offer is invalid. 400 InvalidSqlSku - Provided SQL sku is invalid. Sql VM Group allowed values are Enterprise or Developer. 400 OuPathAndDomainMismatch - OU path is not within the domain provided. 400 InvalidAccountNameFormat - Account name format is invalid. 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed. 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed. 400 InvalidStorageAccountUrl - Invalid storage account url. 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters. 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name. 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty. 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed. 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.

Examples

Gets the list of sql virtual machines in a SQL virtual machine group.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvm/sqlVirtualMachines?api-version=2023-10-01

Sample Response

Status code:

200

{
  "value": [
    {
      "properties": {
        "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm2",
        "provisioningState": "Succeeded",
        "sqlServerLicenseType": "PAYG",
        "sqlImageSku": "Enterprise",
        "sqlImageOffer": "SQL2022-WS2022",
        "sqlManagement": "Full",
        "leastPrivilegeMode": "Enabled",
        "enableAutomaticUpgrade": true,
        "additionalVmPatch": "WU",
        "osType": "Windows",
        "virtualMachineIdentitySettings": {
          "type": "SystemAssigned"
        },
        "sqlVirtualMachineGroupResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup"
      },
      "location": "northeurope",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2",
      "name": "testvm2",
      "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines"
    }
  ]
}

Definitions

Name	Description
AADAuthenticationSettings	Enable AAD authentication for SQL VM.
AdditionalFeaturesServerConfigurations	Additional SQL Server feature settings.
AdditionalOsPatch	Additional VM Patching solution enabled on the Virtual Machine
AdditionalVmPatch	Additional Patch to be enable or enabled on the SQL Virtual Machine.
AssessmentDayOfWeek	Day of the week to run assessment.
AssessmentSettings	Configure SQL best practices Assessment for databases in your SQL virtual machine.
AutoBackupDaysOfWeek	Days of the week for the backups when FullBackupFrequency is set to Weekly.
AutoBackupSettings	Configure backups for databases in your SQL virtual machine.
AutoPatchingSettings	Set a patching window during which Windows and SQL patches will be applied.
BackupScheduleType	Backup schedule type.
ConnectivityType	SQL Server connectivity option.
createdByType	The type of identity that created the resource.
DayOfWeek	Day of week to apply the patch on.
DiskConfigurationType	Disk configuration to apply to SQL Server.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
FullBackupFrequencyType	Frequency of full backups. In both cases, full backups begin during the next scheduled time window.
IdentityType	The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
KeyVaultCredentialSettings	Configure your SQL virtual machine to be able to connect to the Azure Key Vault service.
LeastPrivilegeMode	SQL IaaS Agent least privilege mode.
OsType	Operating System of the current SQL Virtual Machine.
ResourceIdentity	Azure Active Directory identity configuration for a resource.
Schedule	Set assessment schedule for SQL Server.
ServerConfigurationsManagementSettings	Set the connectivity, storage and workload settings.
SqlConnectivityUpdateSettings	Set the access level and network port settings for SQL Server.
SqlImageSku	SQL Server edition type.
SQLInstanceSettings	Set the server/instance-level settings for SQL Server.
SqlManagementMode	SQL Server Management type. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it.
SqlServerLicenseType	SQL Server license type.
SQLStorageSettings	Set disk storage settings for SQL Server.
SqlStorageUpdateSettings	Set disk storage settings for SQL Server.
SQLTempDbSettings	Set tempDb storage settings for SQL Server.
SqlVirtualMachine	A SQL virtual machine.
SqlVirtualMachineListResult	A list of SQL virtual machines.
SqlWorkloadType	SQL Server workload type.
SqlWorkloadTypeUpdateSettings	Set workload type to optimize storage for SQL Server.
StorageConfigurationSettings	Storage Configurations for SQL Data, Log and TempDb.
StorageWorkloadType	Storage workload type.
systemData	Metadata pertaining to creation and last modification of the resource.
TroubleshootingAdditionalProperties	SQL VM Troubleshooting additional properties.
TroubleshootingScenario	SQL VM troubleshooting scenario.
TroubleshootingStatus	Status of last troubleshooting operation on this SQL VM
UnhealthyReplicaInfo	SQL VM Troubleshoot UnhealthyReplica scenario information.
VirtualMachineIdentity	Virtual Machine Identity details used for Sql IaaS extension configurations.
VmIdentityType	Identity type of the virtual machine. Specify None to opt-out of Managed Identities.
WsfcDomainCredentials	Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.

AADAuthenticationSettings

Enable AAD authentication for SQL VM.

Name	Type	Description
clientId	string	The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity

AdditionalFeaturesServerConfigurations

Additional SQL Server feature settings.

Name	Type	Description
isRServicesEnabled	boolean	Enable or disable R services (SQL 2016 onwards).

AdditionalOsPatch

Additional VM Patching solution enabled on the Virtual Machine

Name	Type	Description
WSUS	string
WU	string
WUMU	string

AdditionalVmPatch

Additional Patch to be enable or enabled on the SQL Virtual Machine.

Name	Type	Description
MicrosoftUpdate	string
NotSet	string

AssessmentDayOfWeek

Day of the week to run assessment.

Name	Type	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

AssessmentSettings

Configure SQL best practices Assessment for databases in your SQL virtual machine.

Name	Type	Description
enable	boolean	Enable or disable SQL best practices Assessment feature on SQL virtual machine.
runImmediately	boolean	Run SQL best practices Assessment immediately on SQL virtual machine.
schedule	Schedule	Schedule for SQL best practices Assessment.

AutoBackupDaysOfWeek

Days of the week for the backups when FullBackupFrequency is set to Weekly.

Name	Type	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

AutoBackupSettings

Configure backups for databases in your SQL virtual machine.

Name	Type	Description
backupScheduleType	BackupScheduleType	Backup schedule type.
backupSystemDbs	boolean	Include or exclude system databases from auto backup.
daysOfWeek	AutoBackupDaysOfWeek[]	Days of the week for the backups when FullBackupFrequency is set to Weekly.
enable	boolean	Enable or disable autobackup on SQL virtual machine.
enableEncryption	boolean	Enable or disable encryption for backup on SQL virtual machine.
fullBackupFrequency	FullBackupFrequencyType	Frequency of full backups. In both cases, full backups begin during the next scheduled time window.
fullBackupStartTime	integer	Start time of a given day during which full backups can take place. 0-23 hours.
fullBackupWindowHours	integer	Duration of the time window of a given day during which full backups can take place. 1-23 hours.
logBackupFrequency	integer	Frequency of log backups. 5-60 minutes.
password	string	Password for encryption on backup.
retentionPeriod	integer	Retention period of backup: 1-90 days.
storageAccessKey	string	Storage account key where backup will be taken to.
storageAccountUrl	string	Storage account url where backup will be taken to.
storageContainerName	string	Storage container name where backup will be taken to.

AutoPatchingSettings

Set a patching window during which Windows and SQL patches will be applied.

Name	Type	Default Value	Description
additionalVmPatch	AdditionalVmPatch	NotSet	Additional Patch to be enable or enabled on the SQL Virtual Machine.
dayOfWeek	DayOfWeek		Day of week to apply the patch on.
enable	boolean		Enable or disable autopatching on SQL virtual machine.
maintenanceWindowDuration	integer		Duration of patching.
maintenanceWindowStartingHour	integer		Hour of the day when patching is initiated. Local VM time.

BackupScheduleType

Backup schedule type.

Name	Type	Description
Automated	string
Manual	string

ConnectivityType

SQL Server connectivity option.

Name	Type	Description
LOCAL	string
PRIVATE	string
PUBLIC	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DayOfWeek

Day of week to apply the patch on.

Name	Type	Description
Everyday	string
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

DiskConfigurationType

Disk configuration to apply to SQL Server.

Name	Type	Description
ADD	string
EXTEND	string
NEW	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	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

FullBackupFrequencyType

Frequency of full backups. In both cases, full backups begin during the next scheduled time window.

Name	Type	Description
Daily	string
Weekly	string

IdentityType

The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

KeyVaultCredentialSettings

Configure your SQL virtual machine to be able to connect to the Azure Key Vault service.

Name	Type	Description
azureKeyVaultUrl	string	Azure Key Vault url.
credentialName	string	Credential name.
enable	boolean	Enable or disable key vault credential setting.
servicePrincipalName	string	Service principal name to access key vault.
servicePrincipalSecret	string	Service principal name secret to access key vault.

LeastPrivilegeMode

SQL IaaS Agent least privilege mode.

Name	Type	Description
Enabled	string
NotSet	string

OsType

Operating System of the current SQL Virtual Machine.

Name	Type	Description
Linux	string
Windows	string

ResourceIdentity

Azure Active Directory identity configuration for a resource.

Name	Type	Description
principalId	string	The Azure Active Directory principal id.
tenantId	string	The Azure Active Directory tenant id.
type	IdentityType	The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.

Schedule

Set assessment schedule for SQL Server.

Name	Type	Description
dayOfWeek	AssessmentDayOfWeek	Day of the week to run assessment.
enable	boolean	Enable or disable assessment schedule on SQL virtual machine.
monthlyOccurrence	integer	Occurrence of the DayOfWeek day within a month to schedule assessment. Takes values: 1,2,3,4 and -1. Use -1 for last DayOfWeek day of the month
startTime	string	Time of the day in HH:mm format. Eg. 17:30
weeklyInterval	integer	Number of weeks to schedule between 2 assessment runs. Takes value from 1-6

ServerConfigurationsManagementSettings

Set the connectivity, storage and workload settings.

Name	Type	Description
additionalFeaturesServerConfigurations	AdditionalFeaturesServerConfigurations	Additional SQL feature settings.
azureAdAuthenticationSettings	AADAuthenticationSettings	Azure AD authentication Settings.
sqlConnectivityUpdateSettings	SqlConnectivityUpdateSettings	SQL connectivity type settings.
sqlInstanceSettings	SQLInstanceSettings	SQL Instance settings.
sqlStorageUpdateSettings	SqlStorageUpdateSettings	SQL storage update settings.
sqlWorkloadTypeUpdateSettings	SqlWorkloadTypeUpdateSettings	SQL workload type settings.

SqlConnectivityUpdateSettings

Set the access level and network port settings for SQL Server.

Name	Type	Description
connectivityType	ConnectivityType	SQL Server connectivity option.
port	integer	SQL Server port.
sqlAuthUpdatePassword	string	SQL Server sysadmin login password.
sqlAuthUpdateUserName	string	SQL Server sysadmin login to create.

SqlImageSku

SQL Server edition type.

Name	Type	Description
Developer	string
Enterprise	string
Express	string
Standard	string
Web	string

SQLInstanceSettings

Set the server/instance-level settings for SQL Server.

Name	Type	Description
collation	string	SQL Server Collation.
isIfiEnabled	boolean	SQL Server IFI.
isLpimEnabled	boolean	SQL Server LPIM.
isOptimizeForAdHocWorkloadsEnabled	boolean	SQL Server Optimize for Adhoc workloads.
maxDop	integer	SQL Server MAXDOP.
maxServerMemoryMB	integer	SQL Server maximum memory.
minServerMemoryMB	integer	SQL Server minimum memory.

SqlManagementMode

SQL Server Management type. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it.

Name	Type	Description
Full	string
LightWeight	string
NoAgent	string

SqlServerLicenseType

SQL Server license type.

Name	Type	Description
AHUB	string
DR	string
PAYG	string

SQLStorageSettings

Set disk storage settings for SQL Server.

Name	Type	Description
defaultFilePath	string	SQL Server default file path
luns	integer[]	Logical Unit Numbers for the disks.
useStoragePool	boolean	Use storage pool to build a drive if true or not provided

SqlStorageUpdateSettings

Set disk storage settings for SQL Server.

Name	Type	Description
diskConfigurationType	DiskConfigurationType	Disk configuration to apply to SQL Server.
diskCount	integer	Virtual machine disk count.
startingDeviceId	integer	Device id of the first disk to be updated.

SQLTempDbSettings

Set tempDb storage settings for SQL Server.

Name	Type	Description
dataFileCount	integer	SQL Server tempdb data file count
dataFileSize	integer	SQL Server tempdb data file size
dataGrowth	integer	SQL Server tempdb data file autoGrowth size
defaultFilePath	string	SQL Server default file path
logFileSize	integer	SQL Server tempdb log file size
logGrowth	integer	SQL Server tempdb log file autoGrowth size
luns	integer[]	Logical Unit Numbers for the disks.
persistFolder	boolean	SQL Server tempdb persist folder choice
persistFolderPath	string	SQL Server tempdb persist folder location
useStoragePool	boolean	Use storage pool to build a drive if true or not provided

SqlVirtualMachine

A SQL virtual machine.

Name	Type	Default Value	Description
id	string		Resource ID.
identity	ResourceIdentity		DO NOT USE. This value will be deprecated. Azure Active Directory identity of the server.
location	string		Resource location.
name	string		Resource name.
properties.additionalVmPatch	AdditionalOsPatch		Additional VM Patching solution enabled on the Virtual Machine
properties.assessmentSettings	AssessmentSettings		SQL best practices Assessment Settings.
properties.autoBackupSettings	AutoBackupSettings		Auto backup settings for SQL Server.
properties.autoPatchingSettings	AutoPatchingSettings		Auto patching settings for applying critical security updates to SQL virtual machine.
properties.enableAutomaticUpgrade	boolean	False	Enable automatic upgrade of Sql IaaS extension Agent.
properties.keyVaultCredentialSettings	KeyVaultCredentialSettings		Key vault credential settings.
properties.leastPrivilegeMode	LeastPrivilegeMode	NotSet	SQL IaaS Agent least privilege mode.
properties.osType	OsType		Operating System of the current SQL Virtual Machine.
properties.provisioningState	string		Provisioning state to track the async operation status.
properties.serverConfigurationsManagementSettings	ServerConfigurationsManagementSettings		SQL Server configuration management settings.
properties.sqlImageOffer	string		SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016.
properties.sqlImageSku	SqlImageSku		SQL Server edition type.
properties.sqlManagement	SqlManagementMode		SQL Server Management type. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it.
properties.sqlServerLicenseType	SqlServerLicenseType		SQL Server license type.
properties.sqlVirtualMachineGroupResourceId	string		ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of.
properties.storageConfigurationSettings	StorageConfigurationSettings		Storage Configuration Settings.
properties.troubleshootingStatus	TroubleshootingStatus		Troubleshooting status
properties.virtualMachineIdentitySettings	VirtualMachineIdentity		Virtual Machine Identity details used for Sql IaaS extension configurations.
properties.virtualMachineResourceId	string		ARM Resource id of underlying virtual machine created from SQL marketplace image.
properties.wsfcDomainCredentials	WsfcDomainCredentials		Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.
properties.wsfcStaticIp	string		Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.
systemData	systemData		Metadata pertaining to creation and last modification of the resource.
tags	object		Resource tags.
type	string		Resource type.

SqlVirtualMachineListResult

A list of SQL virtual machines.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	SqlVirtualMachine[]	Array of results.

SqlWorkloadType

SQL Server workload type.

Name	Type	Description
DW	string
GENERAL	string
OLTP	string

SqlWorkloadTypeUpdateSettings

Set workload type to optimize storage for SQL Server.

Name	Type	Description
sqlWorkloadType	SqlWorkloadType	SQL Server workload type.

StorageConfigurationSettings

Storage Configurations for SQL Data, Log and TempDb.

Name	Type	Default Value	Description
diskConfigurationType	DiskConfigurationType		Disk configuration to apply to SQL Server.
enableStorageConfigBlade	boolean	False	Enable SQL IaaS Agent storage configuration blade in Azure Portal.
sqlDataSettings	SQLStorageSettings		SQL Server Data Storage Settings.
sqlLogSettings	SQLStorageSettings		SQL Server Log Storage Settings.
sqlSystemDbOnDataDisk	boolean		SQL Server SystemDb Storage on DataPool if true.
sqlTempDbSettings	SQLTempDbSettings		SQL Server TempDb Storage Settings.
storageWorkloadType	StorageWorkloadType		Storage workload type.

StorageWorkloadType

Storage workload type.

Name	Type	Description
DW	string
GENERAL	string
OLTP	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	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	createdByType	The type of identity that last modified the resource.

TroubleshootingAdditionalProperties

SQL VM Troubleshooting additional properties.

Name	Type	Description
unhealthyReplicaInfo	UnhealthyReplicaInfo	The unhealthy replica information

TroubleshootingScenario

SQL VM troubleshooting scenario.

Name	Type	Description
UnhealthyReplica	string

TroubleshootingStatus

Status of last troubleshooting operation on this SQL VM

Name	Type	Default Value	Description
endTimeUtc	string		End time in UTC timezone.
lastTriggerTimeUtc	string		Last troubleshooting trigger time in UTC timezone
properties	TroubleshootingAdditionalProperties		Troubleshooting properties
rootCause	string		Root cause of the issue
startTimeUtc	string		Start time in UTC timezone.
troubleshootingScenario	TroubleshootingScenario	UnhealthyReplica	SQL VM troubleshooting scenario.

UnhealthyReplicaInfo

SQL VM Troubleshoot UnhealthyReplica scenario information.

Name	Type	Description
availabilityGroupName	string	The name of the availability group

VirtualMachineIdentity

Virtual Machine Identity details used for Sql IaaS extension configurations.

Name	Type	Description
resourceId	string	ARM Resource Id of the identity. Only required when UserAssigned identity is selected.
type	VmIdentityType	Identity type of the virtual machine. Specify None to opt-out of Managed Identities.

VmIdentityType

Identity type of the virtual machine. Specify None to opt-out of Managed Identities.

Name	Type	Description
None	string
SystemAssigned	string
UserAssigned	string

WsfcDomainCredentials

Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.

Name	Type	Description
clusterBootstrapAccountPassword	string	Cluster bootstrap account password.
clusterOperatorAccountPassword	string	Cluster operator account password.
sqlServiceAccountPassword	string	SQL service account password.