Microsoft.SqlVirtualMachine (stable:2023-10-01)

2025/07/04 • 22 updated methods

Operations_List (updated)
Description :  Lists all of the available SQL Virtual Machine Rest API operations.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Virtual machine resource id for response.",
        "old": "Result of the request to list SQL operations."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Operation items on this page",
            "old": "Array of results."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "Description": {
              "new": "Result of the request to list SQL operations.",
              "old": "SQL REST API operation definition."
            },
            "$properties": [
              {
                "#name": "name",
                "Description": {
                  "new": "The name of the operation being performed on this particular object.\"",
                  "old": "The name of the operation being performed on this particular object."
                }
              },
              {
                "#name": "display",
                "Description": {
                  "new": "he localized display information for this particular operation / action.",
                  "old": "The localized display information for this particular operation / action."
                },
                "$properties": [
                  {
                    "#name": "provider",
                    "Description": {
                      "new": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".",
                      "old": "The localized friendly form of the resource provider name."
                    }
                  },
                  {
                    "#name": "resource",
                    "Description": {
                      "new": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".",
                      "old": "The localized friendly form of the resource type related to this action/operation."
                    }
                  },
                  {
                    "#name": "operation",
                    "Description": {
                      "new": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".",
                      "old": "The localized friendly name for the operation."
                    }
                  },
                  {
                    "#name": "description",
                    "Description": {
                      "new": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.",
                      "old": "The localized friendly description for the operation."
                    }
                  }
                ]
              },
              {
                "#name": "origin",
                "Description": {
                  "new": "The intended executor of the operation.\"",
                  "old": "The intended executor of the operation."
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to retrieve next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.SqlVirtualMachine/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Operation items on this page ,
Required: True ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object." ,
Required: False ,
}
string ,
display:
{
Description: he localized display information for this particular operation / action. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation." ,
Enum:
{
user: No description available. ,
system: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Additional descriptions for the operation. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachineGroups_List (updated)
Description :  Gets all SQL virtual machine groups in a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachineGroups_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a SqlVirtualMachineGroup list operation.",
        "old": "A list of SQL virtual machine groups."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SqlVirtualMachineGroup items on this page",
            "old": "Array of results."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_7dc269cfaa22489d9c5c4fd0d65a4099": {
                "#name": "systemData",
                "Description": "Metadata pertaining to creation and last modification of the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to retrieve next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlVirtualMachineGroup items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
sqlImageOffer:
{
Description: SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. ,
Required: False ,
}
string ,
sqlImageSku:
{
Description: SQL image sku. ,
Enum:
{
Developer: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
scaleType:
{
Description: Scale type. ,
Enum:
{
HA: No description available. ,
}
,
Required: False ,
}
enum ,
clusterManagerType:
{
Description: Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. ,
Enum:
{
WSFC: No description available. ,
}
,
Required: False ,
}
enum ,
clusterConfiguration:
{
Description: Cluster type. ,
Enum:
{
Domainful: No description available. ,
}
,
Required: False ,
}
enum ,
wsfcDomainProfile:
{
Description: Cluster Active Directory domain profile. ,
Required: False ,
}
{
domainFqdn:
{
Description: Fully qualified name of the domain. ,
Required: False ,
}
string ,
ouPath:
{
Description: Organizational Unit path in which the nodes and cluster will be present. ,
Required: False ,
}
string ,
clusterBootstrapAccount:
{
Description: Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). ,
Required: False ,
}
string ,
clusterOperatorAccount:
{
Description: Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster. ,
Required: False ,
}
string ,
sqlServiceAccount:
{
Description: Account name under which SQL service will run on all participating SQL virtual machines in the cluster. ,
Required: False ,
}
string ,
isSqlServiceAccountGmsa:
{
Description: The flag to check if SQL service account is GMSA. ,
Required: False ,
}
boolean ,
fileShareWitnessPath:
{
Description: Optional path for fileshare witness. ,
Required: False ,
}
string ,
storageAccountUrl:
{
Description: Fully qualified ARM resource id of the witness storage account. ,
Required: False ,
}
string ,
storageAccountPrimaryKey:
{
Description: Primary key of the witness storage account. ,
Required: False ,
}
string ,
clusterSubnetType:
{
Description: Cluster subnet type. ,
Enum:
{
SingleSubnet: No description available. ,
MultiSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachines_List (updated)
Description :  Gets all SQL virtual machines in a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachines_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a SqlVirtualMachine list operation.",
        "old": "A list of SQL virtual machines."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SqlVirtualMachine items on this page",
            "old": "Array of results."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_f1fcac7a3cea4ac7bd9edc3c77aea09b": {
                "#name": "systemData",
                "Description": "Metadata pertaining to creation and last modification of the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to retrieve next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlVirtualMachine items on this page ,
Required: True ,
}
[
{
identity:
{
Description: DO NOT USE. This value will be deprecated. Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
virtualMachineResourceId:
{
Description: ARM Resource id of underlying virtual machine created from SQL marketplace image. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
sqlImageOffer:
{
Description: SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. ,
Required: False ,
}
string ,
sqlServerLicenseType:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
AHUB: No description available. ,
DR: No description available. ,
}
,
Required: False ,
}
enum ,
sqlManagement:
{
Description: SQL Server Management type. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it. ,
Enum:
{
Full: No description available. ,
LightWeight: No description available. ,
NoAgent: No description available. ,
}
,
Required: False ,
}
enum ,
leastPrivilegeMode:
{
Description: SQL IaaS Agent least privilege mode. ,
Enum:
{
Enabled: No description available. ,
NotSet: No description available. ,
}
,
Required: False ,
}
enum ,
sqlImageSku:
{
Description: SQL Server edition type. ,
Enum:
{
Developer: No description available. ,
Express: No description available. ,
Standard: No description available. ,
Enterprise: No description available. ,
Web: No description available. ,
}
,
Required: False ,
}
enum ,
sqlVirtualMachineGroupResourceId:
{
Description: ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. ,
Required: False ,
}
string ,
wsfcDomainCredentials:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
{
clusterBootstrapAccountPassword:
{
Description: Cluster bootstrap account password. ,
Required: False ,
}
string ,
clusterOperatorAccountPassword:
{
Description: Cluster operator account password. ,
Required: False ,
}
string ,
sqlServiceAccountPassword:
{
Description: SQL service account password. ,
Required: False ,
}
string ,
}
,
wsfcStaticIp:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
string ,
autoPatchingSettings:
{
Description: Auto patching settings for applying critical security updates to SQL virtual machine. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autopatching on SQL virtual machine. ,
Required: False ,
}
boolean ,
dayOfWeek:
{
Description: Day of week to apply the patch on. ,
Enum:
{
Everyday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindowStartingHour:
{
Description: Hour of the day when patching is initiated. Local VM time. ,
Format: int32 ,
Required: False ,
}
integer ,
maintenanceWindowDuration:
{
Description: Duration of patching. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVmPatch:
{
Description: Additional Patch to be enable or enabled on the SQL Virtual Machine. ,
Enum:
{
NotSet: No description available. ,
MicrosoftUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
autoBackupSettings:
{
Description: Auto backup settings for SQL Server. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autobackup on SQL virtual machine. ,
Required: False ,
}
boolean ,
enableEncryption:
{
Description: Enable or disable encryption for backup on SQL virtual machine. ,
Required: False ,
}
boolean ,
retentionPeriod:
{
Description: Retention period of backup: 1-90 days. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: Storage account url where backup will be taken to. ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage container name where backup will be taken to. ,
Required: False ,
}
string ,
storageAccessKey:
{
Description: Storage account key where backup will be taken to. ,
Required: False ,
}
string ,
password:
{
Description: Password for encryption on backup. ,
Required: False ,
}
string ,
backupSystemDbs:
{
Description: Include or exclude system databases from auto backup. ,
Required: False ,
}
boolean ,
backupScheduleType:
{
Description: Backup schedule type. ,
Enum:
{
Manual: No description available. ,
Automated: No description available. ,
}
,
Required: False ,
}
enum ,
fullBackupFrequency:
{
Description: Frequency of full backups. In both cases, full backups begin during the next scheduled time window. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: False ,
}
enum ,
daysOfWeek:
{
Description: Days of the week for the backups when FullBackupFrequency is set to Weekly. ,
Required: False ,
}
[
string ,
]
,
fullBackupStartTime:
{
Description: Start time of a given day during which full backups can take place. 0-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupWindowHours:
{
Description: Duration of the time window of a given day during which full backups can take place. 1-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
logBackupFrequency:
{
Description: Frequency of log backups. 5-60 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
keyVaultCredentialSettings:
{
Description: Key vault credential settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable key vault credential setting. ,
Required: False ,
}
boolean ,
credentialName:
{
Description: Credential name. ,
Required: False ,
}
string ,
azureKeyVaultUrl:
{
Description: Azure Key Vault url. ,
Required: False ,
}
string ,
servicePrincipalName:
{
Description: Service principal name to access key vault. ,
Required: False ,
}
string ,
servicePrincipalSecret:
{
Description: Service principal name secret to access key vault. ,
Required: False ,
}
string ,
}
,
serverConfigurationsManagementSettings:
{
Description: SQL Server configuration management settings. ,
Required: False ,
}
{
sqlConnectivityUpdateSettings:
{
Description: SQL connectivity type settings. ,
Required: False ,
}
{
connectivityType:
{
Description: SQL Server connectivity option. ,
Enum:
{
LOCAL: No description available. ,
PRIVATE: No description available. ,
PUBLIC: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: SQL Server port. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlAuthUpdateUserName:
{
Description: SQL Server sysadmin login to create. ,
Required: False ,
}
string ,
sqlAuthUpdatePassword:
{
Description: SQL Server sysadmin login password. ,
Required: False ,
}
string ,
}
,
sqlWorkloadTypeUpdateSettings:
{
Description: SQL workload type settings. ,
Required: False ,
}
{
sqlWorkloadType:
{
Description: SQL Server workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sqlStorageUpdateSettings:
{
Description: SQL storage update settings. ,
Required: False ,
}
{
diskCount:
{
Description: Virtual machine disk count. ,
Format: int32 ,
Required: False ,
}
integer ,
startingDeviceId:
{
Description: Device id of the first disk to be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
additionalFeaturesServerConfigurations:
{
Description: Additional SQL feature settings. ,
Required: False ,
}
{
isRServicesEnabled:
{
Description: Enable or disable R services (SQL 2016 onwards). ,
Required: False ,
}
boolean ,
}
,
sqlInstanceSettings:
{
Description: SQL Instance settings. ,
Required: False ,
}
{
collation:
{
Description: SQL Server Collation. ,
Required: False ,
}
string ,
maxDop:
{
Description: SQL Server MAXDOP. ,
Format: int32 ,
Required: False ,
}
integer ,
isOptimizeForAdHocWorkloadsEnabled:
{
Description: SQL Server Optimize for Adhoc workloads. ,
Required: False ,
}
boolean ,
minServerMemoryMB:
{
Description: SQL Server minimum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
maxServerMemoryMB:
{
Description: SQL Server maximum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
isLpimEnabled:
{
Description: SQL Server LPIM. ,
Required: False ,
}
boolean ,
isIfiEnabled:
{
Description: SQL Server IFI. ,
Required: False ,
}
boolean ,
}
,
azureAdAuthenticationSettings:
{
Description: Azure AD authentication Settings. ,
Required: False ,
}
{
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity ,
Required: False ,
}
string ,
}
,
}
,
storageConfigurationSettings:
{
Description: Storage Configuration Settings. ,
Required: False ,
}
{
sqlDataSettings:
{
Description: SQL Server Data Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlLogSettings:
{
Description: SQL Server Log Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlTempDbSettings:
{
Description: SQL Server TempDb Storage Settings. ,
Required: False ,
}
{
dataFileSize:
{
Description: SQL Server tempdb data file size ,
Format: int32 ,
Required: False ,
}
integer ,
dataGrowth:
{
Description: SQL Server tempdb data file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
logFileSize:
{
Description: SQL Server tempdb log file size ,
Format: int32 ,
Required: False ,
}
integer ,
logGrowth:
{
Description: SQL Server tempdb log file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
dataFileCount:
{
Description: SQL Server tempdb data file count ,
Format: int32 ,
Required: False ,
}
integer ,
persistFolder:
{
Description: SQL Server tempdb persist folder choice ,
Required: False ,
}
boolean ,
persistFolderPath:
{
Description: SQL Server tempdb persist folder location ,
Required: False ,
}
string ,
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlSystemDbOnDataDisk:
{
Description: SQL Server SystemDb Storage on DataPool if true. ,
Required: False ,
}
boolean ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
storageWorkloadType:
{
Description: Storage workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
enableStorageConfigBlade:
{
Description: Enable SQL IaaS Agent storage configuration blade in Azure Portal. ,
Required: False ,
}
boolean ,
}
,
troubleshootingStatus:
{
Description: Troubleshooting status ,
Required: False ,
}
{
rootCause:
{
Description: Root cause of the issue ,
Required: False ,
}
string ,
lastTriggerTimeUtc:
{
Description: Last troubleshooting trigger time in UTC timezone ,
Format: date-time ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
troubleshootingScenario:
{
Description: SQL VM troubleshooting scenario. ,
Enum:
{
UnhealthyReplica: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Troubleshooting properties ,
Required: False ,
}
{
unhealthyReplicaInfo:
{
Description: The unhealthy replica information ,
Required: False ,
}
{
availabilityGroupName:
{
Description: The name of the availability group ,
Required: False ,
}
string ,
}
,
}
,
}
,
assessmentSettings:
{
Description: SQL best practices Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable SQL best practices Assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run SQL best practices Assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for SQL best practices Assessment. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment schedule on SQL virtual machine. ,
Required: False ,
}
boolean ,
weeklyInterval:
{
Description: Number of weeks to schedule between 2 assessment runs. Takes value from 1-6 ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyOccurrence:
{
Description: 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 ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week to run assessment. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time of the day in HH:mm format. Eg. 17:30 ,
Required: False ,
}
string ,
}
,
}
,
enableAutomaticUpgrade:
{
Description: Enable automatic upgrade of Sql IaaS extension Agent. ,
Required: False ,
}
boolean ,
additionalVmPatch:
{
Description: Additional VM Patching solution enabled on the Virtual Machine ,
Enum:
{
WU: No description available. ,
WUMU: No description available. ,
WSUS: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachineIdentitySettings:
{
Description: Virtual Machine Identity details used for Sql IaaS extension configurations. ,
Required: False ,
}
{
type:
{
Description: Identity type of the virtual machine. Specify None to opt-out of Managed Identities. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: ARM Resource Id of the identity. Only required when UserAssigned identity is selected. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
osType:
{
Description: Operating System of the current SQL Virtual Machine. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachineGroups_ListByResourceGroup (updated)
Description :  Gets all SQL virtual machine groups in a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachineGroups_ListByResourceGroup",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a SqlVirtualMachineGroup list operation.",
        "old": "A list of SQL virtual machine groups."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SqlVirtualMachineGroup items on this page",
            "old": "Array of results."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_ab941b9b57f44344a6eb1addf3de48ed": {
                "#name": "systemData",
                "Description": "Metadata pertaining to creation and last modification of the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to retrieve next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlVirtualMachineGroup items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
sqlImageOffer:
{
Description: SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. ,
Required: False ,
}
string ,
sqlImageSku:
{
Description: SQL image sku. ,
Enum:
{
Developer: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
scaleType:
{
Description: Scale type. ,
Enum:
{
HA: No description available. ,
}
,
Required: False ,
}
enum ,
clusterManagerType:
{
Description: Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. ,
Enum:
{
WSFC: No description available. ,
}
,
Required: False ,
}
enum ,
clusterConfiguration:
{
Description: Cluster type. ,
Enum:
{
Domainful: No description available. ,
}
,
Required: False ,
}
enum ,
wsfcDomainProfile:
{
Description: Cluster Active Directory domain profile. ,
Required: False ,
}
{
domainFqdn:
{
Description: Fully qualified name of the domain. ,
Required: False ,
}
string ,
ouPath:
{
Description: Organizational Unit path in which the nodes and cluster will be present. ,
Required: False ,
}
string ,
clusterBootstrapAccount:
{
Description: Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). ,
Required: False ,
}
string ,
clusterOperatorAccount:
{
Description: Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster. ,
Required: False ,
}
string ,
sqlServiceAccount:
{
Description: Account name under which SQL service will run on all participating SQL virtual machines in the cluster. ,
Required: False ,
}
string ,
isSqlServiceAccountGmsa:
{
Description: The flag to check if SQL service account is GMSA. ,
Required: False ,
}
boolean ,
fileShareWitnessPath:
{
Description: Optional path for fileshare witness. ,
Required: False ,
}
string ,
storageAccountUrl:
{
Description: Fully qualified ARM resource id of the witness storage account. ,
Required: False ,
}
string ,
storageAccountPrimaryKey:
{
Description: Primary key of the witness storage account. ,
Required: False ,
}
string ,
clusterSubnetType:
{
Description: Cluster subnet type. ,
Enum:
{
SingleSubnet: No description available. ,
MultiSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachineGroups_Get (updated)
Description :  Gets a SQL virtual machine group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachineGroups_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_5ced17b77b7f435899ceba72c9f8ced7": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
sqlImageOffer:
{
Description: SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. ,
Required: False ,
}
string ,
sqlImageSku:
{
Description: SQL image sku. ,
Enum:
{
Developer: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
scaleType:
{
Description: Scale type. ,
Enum:
{
HA: No description available. ,
}
,
Required: False ,
}
enum ,
clusterManagerType:
{
Description: Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. ,
Enum:
{
WSFC: No description available. ,
}
,
Required: False ,
}
enum ,
clusterConfiguration:
{
Description: Cluster type. ,
Enum:
{
Domainful: No description available. ,
}
,
Required: False ,
}
enum ,
wsfcDomainProfile:
{
Description: Cluster Active Directory domain profile. ,
Required: False ,
}
{
domainFqdn:
{
Description: Fully qualified name of the domain. ,
Required: False ,
}
string ,
ouPath:
{
Description: Organizational Unit path in which the nodes and cluster will be present. ,
Required: False ,
}
string ,
clusterBootstrapAccount:
{
Description: Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). ,
Required: False ,
}
string ,
clusterOperatorAccount:
{
Description: Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster. ,
Required: False ,
}
string ,
sqlServiceAccount:
{
Description: Account name under which SQL service will run on all participating SQL virtual machines in the cluster. ,
Required: False ,
}
string ,
isSqlServiceAccountGmsa:
{
Description: The flag to check if SQL service account is GMSA. ,
Required: False ,
}
boolean ,
fileShareWitnessPath:
{
Description: Optional path for fileshare witness. ,
Required: False ,
}
string ,
storageAccountUrl:
{
Description: Fully qualified ARM resource id of the witness storage account. ,
Required: False ,
}
string ,
storageAccountPrimaryKey:
{
Description: Primary key of the witness storage account. ,
Required: False ,
}
string ,
clusterSubnetType:
{
Description: Cluster subnet type. ,
Enum:
{
SingleSubnet: No description available. ,
MultiSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachineGroups_CreateOrUpdate (updated)
Description :  Creates or updates a SQL virtual machine group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachineGroups_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@removed_1a44adf23941472688a3008a905d189c": {
            "#name": "systemData",
            "Description": "Metadata pertaining to creation and last modification of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_2fd6f0f95c164fbb895000f87d109420": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_2a7cb043a6c642d6a47709d52bf6a118": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
parameters:
{
Description: The SQL virtual machine group. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
sqlImageOffer:
{
Description: SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. ,
Required: False ,
}
string ,
sqlImageSku:
{
Description: SQL image sku. ,
Enum:
{
Developer: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
scaleType:
{
Description: Scale type. ,
Enum:
{
HA: No description available. ,
}
,
Required: False ,
}
enum ,
clusterManagerType:
{
Description: Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. ,
Enum:
{
WSFC: No description available. ,
}
,
Required: False ,
}
enum ,
clusterConfiguration:
{
Description: Cluster type. ,
Enum:
{
Domainful: No description available. ,
}
,
Required: False ,
}
enum ,
wsfcDomainProfile:
{
Description: Cluster Active Directory domain profile. ,
Required: False ,
}
{
domainFqdn:
{
Description: Fully qualified name of the domain. ,
Required: False ,
}
string ,
ouPath:
{
Description: Organizational Unit path in which the nodes and cluster will be present. ,
Required: False ,
}
string ,
clusterBootstrapAccount:
{
Description: Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). ,
Required: False ,
}
string ,
clusterOperatorAccount:
{
Description: Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster. ,
Required: False ,
}
string ,
sqlServiceAccount:
{
Description: Account name under which SQL service will run on all participating SQL virtual machines in the cluster. ,
Required: False ,
}
string ,
isSqlServiceAccountGmsa:
{
Description: The flag to check if SQL service account is GMSA. ,
Required: False ,
}
boolean ,
fileShareWitnessPath:
{
Description: Optional path for fileshare witness. ,
Required: False ,
}
string ,
storageAccountUrl:
{
Description: Fully qualified ARM resource id of the witness storage account. ,
Required: False ,
}
string ,
storageAccountPrimaryKey:
{
Description: Primary key of the witness storage account. ,
Required: False ,
}
string ,
clusterSubnetType:
{
Description: Cluster subnet type. ,
Enum:
{
SingleSubnet: No description available. ,
MultiSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
sqlImageOffer:
{
Description: SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. ,
Required: False ,
}
string ,
sqlImageSku:
{
Description: SQL image sku. ,
Enum:
{
Developer: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
scaleType:
{
Description: Scale type. ,
Enum:
{
HA: No description available. ,
}
,
Required: False ,
}
enum ,
clusterManagerType:
{
Description: Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. ,
Enum:
{
WSFC: No description available. ,
}
,
Required: False ,
}
enum ,
clusterConfiguration:
{
Description: Cluster type. ,
Enum:
{
Domainful: No description available. ,
}
,
Required: False ,
}
enum ,
wsfcDomainProfile:
{
Description: Cluster Active Directory domain profile. ,
Required: False ,
}
{
domainFqdn:
{
Description: Fully qualified name of the domain. ,
Required: False ,
}
string ,
ouPath:
{
Description: Organizational Unit path in which the nodes and cluster will be present. ,
Required: False ,
}
string ,
clusterBootstrapAccount:
{
Description: Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). ,
Required: False ,
}
string ,
clusterOperatorAccount:
{
Description: Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster. ,
Required: False ,
}
string ,
sqlServiceAccount:
{
Description: Account name under which SQL service will run on all participating SQL virtual machines in the cluster. ,
Required: False ,
}
string ,
isSqlServiceAccountGmsa:
{
Description: The flag to check if SQL service account is GMSA. ,
Required: False ,
}
boolean ,
fileShareWitnessPath:
{
Description: Optional path for fileshare witness. ,
Required: False ,
}
string ,
storageAccountUrl:
{
Description: Fully qualified ARM resource id of the witness storage account. ,
Required: False ,
}
string ,
storageAccountPrimaryKey:
{
Description: Primary key of the witness storage account. ,
Required: False ,
}
string ,
clusterSubnetType:
{
Description: Cluster subnet type. ,
Enum:
{
SingleSubnet: No description available. ,
MultiSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A SQL virtual machine group. ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
sqlImageOffer:
{
Description: SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. ,
Required: False ,
}
string ,
sqlImageSku:
{
Description: SQL image sku. ,
Enum:
{
Developer: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
scaleType:
{
Description: Scale type. ,
Enum:
{
HA: No description available. ,
}
,
Required: False ,
}
enum ,
clusterManagerType:
{
Description: Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. ,
Enum:
{
WSFC: No description available. ,
}
,
Required: False ,
}
enum ,
clusterConfiguration:
{
Description: Cluster type. ,
Enum:
{
Domainful: No description available. ,
}
,
Required: False ,
}
enum ,
wsfcDomainProfile:
{
Description: Cluster Active Directory domain profile. ,
Required: False ,
}
{
domainFqdn:
{
Description: Fully qualified name of the domain. ,
Required: False ,
}
string ,
ouPath:
{
Description: Organizational Unit path in which the nodes and cluster will be present. ,
Required: False ,
}
string ,
clusterBootstrapAccount:
{
Description: Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). ,
Required: False ,
}
string ,
clusterOperatorAccount:
{
Description: Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster. ,
Required: False ,
}
string ,
sqlServiceAccount:
{
Description: Account name under which SQL service will run on all participating SQL virtual machines in the cluster. ,
Required: False ,
}
string ,
isSqlServiceAccountGmsa:
{
Description: The flag to check if SQL service account is GMSA. ,
Required: False ,
}
boolean ,
fileShareWitnessPath:
{
Description: Optional path for fileshare witness. ,
Required: False ,
}
string ,
storageAccountUrl:
{
Description: Fully qualified ARM resource id of the witness storage account. ,
Required: False ,
}
string ,
storageAccountPrimaryKey:
{
Description: Primary key of the witness storage account. ,
Required: False ,
}
string ,
clusterSubnetType:
{
Description: Cluster subnet type. ,
Enum:
{
SingleSubnet: No description available. ,
MultiSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachineGroups_Update (updated)
Description :  Updates SQL virtual machine group tags.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachineGroups_Update",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_af2f1958b7bd4b788910b55995df330f": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
parameters:
{
Description: The SQL virtual machine group. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
}
,
$schema:
{
Description: A SQL virtual machine group. ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
sqlImageOffer:
{
Description: SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. ,
Required: False ,
}
string ,
sqlImageSku:
{
Description: SQL image sku. ,
Enum:
{
Developer: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
scaleType:
{
Description: Scale type. ,
Enum:
{
HA: No description available. ,
}
,
Required: False ,
}
enum ,
clusterManagerType:
{
Description: Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. ,
Enum:
{
WSFC: No description available. ,
}
,
Required: False ,
}
enum ,
clusterConfiguration:
{
Description: Cluster type. ,
Enum:
{
Domainful: No description available. ,
}
,
Required: False ,
}
enum ,
wsfcDomainProfile:
{
Description: Cluster Active Directory domain profile. ,
Required: False ,
}
{
domainFqdn:
{
Description: Fully qualified name of the domain. ,
Required: False ,
}
string ,
ouPath:
{
Description: Organizational Unit path in which the nodes and cluster will be present. ,
Required: False ,
}
string ,
clusterBootstrapAccount:
{
Description: Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). ,
Required: False ,
}
string ,
clusterOperatorAccount:
{
Description: Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster. ,
Required: False ,
}
string ,
sqlServiceAccount:
{
Description: Account name under which SQL service will run on all participating SQL virtual machines in the cluster. ,
Required: False ,
}
string ,
isSqlServiceAccountGmsa:
{
Description: The flag to check if SQL service account is GMSA. ,
Required: False ,
}
boolean ,
fileShareWitnessPath:
{
Description: Optional path for fileshare witness. ,
Required: False ,
}
string ,
storageAccountUrl:
{
Description: Fully qualified ARM resource id of the witness storage account. ,
Required: False ,
}
string ,
storageAccountPrimaryKey:
{
Description: Primary key of the witness storage account. ,
Required: False ,
}
string ,
clusterSubnetType:
{
Description: Cluster subnet type. ,
Enum:
{
SingleSubnet: No description available. ,
MultiSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachineGroups_Delete (updated)
Description :  Deletes a SQL virtual machine group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachineGroups_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "@added_a025aa400c2b4e0ca930fdaff346ec89": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailabilityGroupListeners_ListByGroup (updated)
Description :  Lists all availability group listeners in a SQL virtual machine group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AvailabilityGroupListeners_ListByGroup",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a AvailabilityGroupListener list operation.",
        "old": "A list of availability group listeners."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The AvailabilityGroupListener items on this page",
            "old": "Array of results."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_0d70d56b5cc34c418e79227e337660e2": {
                "#name": "systemData",
                "Description": "Metadata pertaining to creation and last modification of the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to retrieve next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AvailabilityGroupListener items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
availabilityGroupName:
{
Description: Name of the availability group. ,
Required: False ,
}
string ,
loadBalancerConfigurations:
{
Description: List of load balancer configurations for an availability group listener. ,
Required: False ,
}
[
{
privateIpAddress:
{
Description: Private IP address. ,
Required: False ,
}
{
ipAddress:
{
Description: Private IP address bound to the availability group listener. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: Subnet used to include private IP. ,
Required: False ,
}
string ,
}
,
publicIpAddressResourceId:
{
Description: Resource id of the public IP. ,
Required: False ,
}
string ,
loadBalancerResourceId:
{
Description: Resource id of the load balancer. ,
Required: False ,
}
string ,
probePort:
{
Description: Probe port. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlVirtualMachineInstances:
{
Description: List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
multiSubnetIpConfigurations:
{
Description: List of multi subnet IP configurations for an AG listener. ,
Required: False ,
}
[
{
privateIpAddress:
{
Description: Private IP address. ,
Required: True ,
}
{
ipAddress:
{
Description: Private IP address bound to the availability group listener. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: Subnet used to include private IP. ,
Required: False ,
}
string ,
}
,
sqlVirtualMachineInstance:
{
Description: SQL virtual machine instance resource id that are enrolled into the availability group listener. ,
Required: True ,
}
string ,
}
,
]
,
createDefaultAvailabilityGroupIfNotExist:
{
Description: Create a default availability group if it does not exist. ,
Required: False ,
}
boolean ,
port:
{
Description: Listener port. ,
Format: int32 ,
Required: False ,
}
integer ,
availabilityGroupConfiguration:
{
Description: Availability Group configuration. ,
Required: False ,
}
{
replicas:
{
Description: Replica configurations. ,
Required: False ,
}
[
{
sqlVirtualMachineInstanceId:
{
Description: Sql VirtualMachine Instance Id. ,
Required: False ,
}
string ,
role:
{
Description: Replica Role in availability group. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
commit:
{
Description: Replica commit mode in availability group. ,
Enum:
{
Synchronous_Commit: No description available. ,
Asynchronous_Commit: No description available. ,
}
,
Required: False ,
}
enum ,
failover:
{
Description: Replica failover mode in availability group. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
readableSecondary:
{
Description: Replica readable secondary mode in availability group. ,
Enum:
{
No: No description available. ,
All: No description available. ,
Read_Only: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailabilityGroupListeners_Get (updated)
Description :  Gets an availability group listener.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AvailabilityGroupListeners_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_ff626b2d9e814bd8b8cfc6007e71407d": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
availabilityGroupListenerName:
{
Description: Name of the availability group listener. ,
Required: True ,
}
string ,
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
availabilityGroupName:
{
Description: Name of the availability group. ,
Required: False ,
}
string ,
loadBalancerConfigurations:
{
Description: List of load balancer configurations for an availability group listener. ,
Required: False ,
}
[
{
privateIpAddress:
{
Description: Private IP address. ,
Required: False ,
}
{
ipAddress:
{
Description: Private IP address bound to the availability group listener. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: Subnet used to include private IP. ,
Required: False ,
}
string ,
}
,
publicIpAddressResourceId:
{
Description: Resource id of the public IP. ,
Required: False ,
}
string ,
loadBalancerResourceId:
{
Description: Resource id of the load balancer. ,
Required: False ,
}
string ,
probePort:
{
Description: Probe port. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlVirtualMachineInstances:
{
Description: List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
multiSubnetIpConfigurations:
{
Description: List of multi subnet IP configurations for an AG listener. ,
Required: False ,
}
[
{
privateIpAddress:
{
Description: Private IP address. ,
Required: True ,
}
{
ipAddress:
{
Description: Private IP address bound to the availability group listener. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: Subnet used to include private IP. ,
Required: False ,
}
string ,
}
,
sqlVirtualMachineInstance:
{
Description: SQL virtual machine instance resource id that are enrolled into the availability group listener. ,
Required: True ,
}
string ,
}
,
]
,
createDefaultAvailabilityGroupIfNotExist:
{
Description: Create a default availability group if it does not exist. ,
Required: False ,
}
boolean ,
port:
{
Description: Listener port. ,
Format: int32 ,
Required: False ,
}
integer ,
availabilityGroupConfiguration:
{
Description: Availability Group configuration. ,
Required: False ,
}
{
replicas:
{
Description: Replica configurations. ,
Required: False ,
}
[
{
sqlVirtualMachineInstanceId:
{
Description: Sql VirtualMachine Instance Id. ,
Required: False ,
}
string ,
role:
{
Description: Replica Role in availability group. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
commit:
{
Description: Replica commit mode in availability group. ,
Enum:
{
Synchronous_Commit: No description available. ,
Asynchronous_Commit: No description available. ,
}
,
Required: False ,
}
enum ,
failover:
{
Description: Replica failover mode in availability group. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
readableSecondary:
{
Description: Replica readable secondary mode in availability group. ,
Enum:
{
No: No description available. ,
All: No description available. ,
Read_Only: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailabilityGroupListeners_CreateOrUpdate (updated)
Description :  Creates or updates an availability group listener.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AvailabilityGroupListeners_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@removed_40e6b94166ef4a34bf3d514d0b971313": {
            "#name": "systemData",
            "Description": "Metadata pertaining to creation and last modification of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_a138813eb44f487e9dac1a0a65f54ffe": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_e3e24f57ec2443c8ac305082071c5504": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
availabilityGroupListenerName:
{
Description: Name of the availability group listener. ,
Required: True ,
}
string ,
parameters:
{
Description: The availability group listener. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
availabilityGroupName:
{
Description: Name of the availability group. ,
Required: False ,
}
string ,
loadBalancerConfigurations:
{
Description: List of load balancer configurations for an availability group listener. ,
Required: False ,
}
[
{
privateIpAddress:
{
Description: Private IP address. ,
Required: False ,
}
{
ipAddress:
{
Description: Private IP address bound to the availability group listener. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: Subnet used to include private IP. ,
Required: False ,
}
string ,
}
,
publicIpAddressResourceId:
{
Description: Resource id of the public IP. ,
Required: False ,
}
string ,
loadBalancerResourceId:
{
Description: Resource id of the load balancer. ,
Required: False ,
}
string ,
probePort:
{
Description: Probe port. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlVirtualMachineInstances:
{
Description: List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
multiSubnetIpConfigurations:
{
Description: List of multi subnet IP configurations for an AG listener. ,
Required: False ,
}
[
{
privateIpAddress:
{
Description: Private IP address. ,
Required: True ,
}
{
ipAddress:
{
Description: Private IP address bound to the availability group listener. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: Subnet used to include private IP. ,
Required: False ,
}
string ,
}
,
sqlVirtualMachineInstance:
{
Description: SQL virtual machine instance resource id that are enrolled into the availability group listener. ,
Required: True ,
}
string ,
}
,
]
,
createDefaultAvailabilityGroupIfNotExist:
{
Description: Create a default availability group if it does not exist. ,
Required: False ,
}
boolean ,
port:
{
Description: Listener port. ,
Format: int32 ,
Required: False ,
}
integer ,
availabilityGroupConfiguration:
{
Description: Availability Group configuration. ,
Required: False ,
}
{
replicas:
{
Description: Replica configurations. ,
Required: False ,
}
[
{
sqlVirtualMachineInstanceId:
{
Description: Sql VirtualMachine Instance Id. ,
Required: False ,
}
string ,
role:
{
Description: Replica Role in availability group. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
commit:
{
Description: Replica commit mode in availability group. ,
Enum:
{
Synchronous_Commit: No description available. ,
Asynchronous_Commit: No description available. ,
}
,
Required: False ,
}
enum ,
failover:
{
Description: Replica failover mode in availability group. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
readableSecondary:
{
Description: Replica readable secondary mode in availability group. ,
Enum:
{
No: No description available. ,
All: No description available. ,
Read_Only: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
availabilityGroupName:
{
Description: Name of the availability group. ,
Required: False ,
}
string ,
loadBalancerConfigurations:
{
Description: List of load balancer configurations for an availability group listener. ,
Required: False ,
}
[
{
privateIpAddress:
{
Description: Private IP address. ,
Required: False ,
}
{
ipAddress:
{
Description: Private IP address bound to the availability group listener. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: Subnet used to include private IP. ,
Required: False ,
}
string ,
}
,
publicIpAddressResourceId:
{
Description: Resource id of the public IP. ,
Required: False ,
}
string ,
loadBalancerResourceId:
{
Description: Resource id of the load balancer. ,
Required: False ,
}
string ,
probePort:
{
Description: Probe port. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlVirtualMachineInstances:
{
Description: List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
multiSubnetIpConfigurations:
{
Description: List of multi subnet IP configurations for an AG listener. ,
Required: False ,
}
[
{
privateIpAddress:
{
Description: Private IP address. ,
Required: True ,
}
{
ipAddress:
{
Description: Private IP address bound to the availability group listener. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: Subnet used to include private IP. ,
Required: False ,
}
string ,
}
,
sqlVirtualMachineInstance:
{
Description: SQL virtual machine instance resource id that are enrolled into the availability group listener. ,
Required: True ,
}
string ,
}
,
]
,
createDefaultAvailabilityGroupIfNotExist:
{
Description: Create a default availability group if it does not exist. ,
Required: False ,
}
boolean ,
port:
{
Description: Listener port. ,
Format: int32 ,
Required: False ,
}
integer ,
availabilityGroupConfiguration:
{
Description: Availability Group configuration. ,
Required: False ,
}
{
replicas:
{
Description: Replica configurations. ,
Required: False ,
}
[
{
sqlVirtualMachineInstanceId:
{
Description: Sql VirtualMachine Instance Id. ,
Required: False ,
}
string ,
role:
{
Description: Replica Role in availability group. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
commit:
{
Description: Replica commit mode in availability group. ,
Enum:
{
Synchronous_Commit: No description available. ,
Asynchronous_Commit: No description available. ,
}
,
Required: False ,
}
enum ,
failover:
{
Description: Replica failover mode in availability group. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
readableSecondary:
{
Description: Replica readable secondary mode in availability group. ,
Enum:
{
No: No description available. ,
All: No description available. ,
Read_Only: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A SQL Server availability group listener. ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
availabilityGroupName:
{
Description: Name of the availability group. ,
Required: False ,
}
string ,
loadBalancerConfigurations:
{
Description: List of load balancer configurations for an availability group listener. ,
Required: False ,
}
[
{
privateIpAddress:
{
Description: Private IP address. ,
Required: False ,
}
{
ipAddress:
{
Description: Private IP address bound to the availability group listener. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: Subnet used to include private IP. ,
Required: False ,
}
string ,
}
,
publicIpAddressResourceId:
{
Description: Resource id of the public IP. ,
Required: False ,
}
string ,
loadBalancerResourceId:
{
Description: Resource id of the load balancer. ,
Required: False ,
}
string ,
probePort:
{
Description: Probe port. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlVirtualMachineInstances:
{
Description: List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
multiSubnetIpConfigurations:
{
Description: List of multi subnet IP configurations for an AG listener. ,
Required: False ,
}
[
{
privateIpAddress:
{
Description: Private IP address. ,
Required: True ,
}
{
ipAddress:
{
Description: Private IP address bound to the availability group listener. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: Subnet used to include private IP. ,
Required: False ,
}
string ,
}
,
sqlVirtualMachineInstance:
{
Description: SQL virtual machine instance resource id that are enrolled into the availability group listener. ,
Required: True ,
}
string ,
}
,
]
,
createDefaultAvailabilityGroupIfNotExist:
{
Description: Create a default availability group if it does not exist. ,
Required: False ,
}
boolean ,
port:
{
Description: Listener port. ,
Format: int32 ,
Required: False ,
}
integer ,
availabilityGroupConfiguration:
{
Description: Availability Group configuration. ,
Required: False ,
}
{
replicas:
{
Description: Replica configurations. ,
Required: False ,
}
[
{
sqlVirtualMachineInstanceId:
{
Description: Sql VirtualMachine Instance Id. ,
Required: False ,
}
string ,
role:
{
Description: Replica Role in availability group. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
commit:
{
Description: Replica commit mode in availability group. ,
Enum:
{
Synchronous_Commit: No description available. ,
Asynchronous_Commit: No description available. ,
}
,
Required: False ,
}
enum ,
failover:
{
Description: Replica failover mode in availability group. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
readableSecondary:
{
Description: Replica readable secondary mode in availability group. ,
Enum:
{
No: No description available. ,
All: No description available. ,
Read_Only: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailabilityGroupListeners_Delete (updated)
Description :  Deletes an availability group listener.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AvailabilityGroupListeners_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "@added_562bf9f6bf3a45c1ac7a5ac7c8d3dcfb": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
availabilityGroupListenerName:
{
Description: Name of the availability group listener. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachines_ListBySqlVmGroup (updated)
Description :  Gets the list of sql virtual machines in a SQL virtual machine group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachines_ListBySqlVmGroup",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a SqlVirtualMachine list operation.",
        "old": "A list of SQL virtual machines."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SqlVirtualMachine items on this page",
            "old": "Array of results."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_3ed0676f251f4a56b89524ff36dc188f": {
                "#name": "systemData",
                "Description": "Metadata pertaining to creation and last modification of the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to retrieve next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/sqlVirtualMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlVirtualMachine items on this page ,
Required: True ,
}
[
{
identity:
{
Description: DO NOT USE. This value will be deprecated. Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
virtualMachineResourceId:
{
Description: ARM Resource id of underlying virtual machine created from SQL marketplace image. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
sqlImageOffer:
{
Description: SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. ,
Required: False ,
}
string ,
sqlServerLicenseType:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
AHUB: No description available. ,
DR: No description available. ,
}
,
Required: False ,
}
enum ,
sqlManagement:
{
Description: SQL Server Management type. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it. ,
Enum:
{
Full: No description available. ,
LightWeight: No description available. ,
NoAgent: No description available. ,
}
,
Required: False ,
}
enum ,
leastPrivilegeMode:
{
Description: SQL IaaS Agent least privilege mode. ,
Enum:
{
Enabled: No description available. ,
NotSet: No description available. ,
}
,
Required: False ,
}
enum ,
sqlImageSku:
{
Description: SQL Server edition type. ,
Enum:
{
Developer: No description available. ,
Express: No description available. ,
Standard: No description available. ,
Enterprise: No description available. ,
Web: No description available. ,
}
,
Required: False ,
}
enum ,
sqlVirtualMachineGroupResourceId:
{
Description: ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. ,
Required: False ,
}
string ,
wsfcDomainCredentials:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
{
clusterBootstrapAccountPassword:
{
Description: Cluster bootstrap account password. ,
Required: False ,
}
string ,
clusterOperatorAccountPassword:
{
Description: Cluster operator account password. ,
Required: False ,
}
string ,
sqlServiceAccountPassword:
{
Description: SQL service account password. ,
Required: False ,
}
string ,
}
,
wsfcStaticIp:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
string ,
autoPatchingSettings:
{
Description: Auto patching settings for applying critical security updates to SQL virtual machine. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autopatching on SQL virtual machine. ,
Required: False ,
}
boolean ,
dayOfWeek:
{
Description: Day of week to apply the patch on. ,
Enum:
{
Everyday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindowStartingHour:
{
Description: Hour of the day when patching is initiated. Local VM time. ,
Format: int32 ,
Required: False ,
}
integer ,
maintenanceWindowDuration:
{
Description: Duration of patching. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVmPatch:
{
Description: Additional Patch to be enable or enabled on the SQL Virtual Machine. ,
Enum:
{
NotSet: No description available. ,
MicrosoftUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
autoBackupSettings:
{
Description: Auto backup settings for SQL Server. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autobackup on SQL virtual machine. ,
Required: False ,
}
boolean ,
enableEncryption:
{
Description: Enable or disable encryption for backup on SQL virtual machine. ,
Required: False ,
}
boolean ,
retentionPeriod:
{
Description: Retention period of backup: 1-90 days. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: Storage account url where backup will be taken to. ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage container name where backup will be taken to. ,
Required: False ,
}
string ,
storageAccessKey:
{
Description: Storage account key where backup will be taken to. ,
Required: False ,
}
string ,
password:
{
Description: Password for encryption on backup. ,
Required: False ,
}
string ,
backupSystemDbs:
{
Description: Include or exclude system databases from auto backup. ,
Required: False ,
}
boolean ,
backupScheduleType:
{
Description: Backup schedule type. ,
Enum:
{
Manual: No description available. ,
Automated: No description available. ,
}
,
Required: False ,
}
enum ,
fullBackupFrequency:
{
Description: Frequency of full backups. In both cases, full backups begin during the next scheduled time window. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: False ,
}
enum ,
daysOfWeek:
{
Description: Days of the week for the backups when FullBackupFrequency is set to Weekly. ,
Required: False ,
}
[
string ,
]
,
fullBackupStartTime:
{
Description: Start time of a given day during which full backups can take place. 0-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupWindowHours:
{
Description: Duration of the time window of a given day during which full backups can take place. 1-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
logBackupFrequency:
{
Description: Frequency of log backups. 5-60 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
keyVaultCredentialSettings:
{
Description: Key vault credential settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable key vault credential setting. ,
Required: False ,
}
boolean ,
credentialName:
{
Description: Credential name. ,
Required: False ,
}
string ,
azureKeyVaultUrl:
{
Description: Azure Key Vault url. ,
Required: False ,
}
string ,
servicePrincipalName:
{
Description: Service principal name to access key vault. ,
Required: False ,
}
string ,
servicePrincipalSecret:
{
Description: Service principal name secret to access key vault. ,
Required: False ,
}
string ,
}
,
serverConfigurationsManagementSettings:
{
Description: SQL Server configuration management settings. ,
Required: False ,
}
{
sqlConnectivityUpdateSettings:
{
Description: SQL connectivity type settings. ,
Required: False ,
}
{
connectivityType:
{
Description: SQL Server connectivity option. ,
Enum:
{
LOCAL: No description available. ,
PRIVATE: No description available. ,
PUBLIC: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: SQL Server port. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlAuthUpdateUserName:
{
Description: SQL Server sysadmin login to create. ,
Required: False ,
}
string ,
sqlAuthUpdatePassword:
{
Description: SQL Server sysadmin login password. ,
Required: False ,
}
string ,
}
,
sqlWorkloadTypeUpdateSettings:
{
Description: SQL workload type settings. ,
Required: False ,
}
{
sqlWorkloadType:
{
Description: SQL Server workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sqlStorageUpdateSettings:
{
Description: SQL storage update settings. ,
Required: False ,
}
{
diskCount:
{
Description: Virtual machine disk count. ,
Format: int32 ,
Required: False ,
}
integer ,
startingDeviceId:
{
Description: Device id of the first disk to be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
additionalFeaturesServerConfigurations:
{
Description: Additional SQL feature settings. ,
Required: False ,
}
{
isRServicesEnabled:
{
Description: Enable or disable R services (SQL 2016 onwards). ,
Required: False ,
}
boolean ,
}
,
sqlInstanceSettings:
{
Description: SQL Instance settings. ,
Required: False ,
}
{
collation:
{
Description: SQL Server Collation. ,
Required: False ,
}
string ,
maxDop:
{
Description: SQL Server MAXDOP. ,
Format: int32 ,
Required: False ,
}
integer ,
isOptimizeForAdHocWorkloadsEnabled:
{
Description: SQL Server Optimize for Adhoc workloads. ,
Required: False ,
}
boolean ,
minServerMemoryMB:
{
Description: SQL Server minimum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
maxServerMemoryMB:
{
Description: SQL Server maximum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
isLpimEnabled:
{
Description: SQL Server LPIM. ,
Required: False ,
}
boolean ,
isIfiEnabled:
{
Description: SQL Server IFI. ,
Required: False ,
}
boolean ,
}
,
azureAdAuthenticationSettings:
{
Description: Azure AD authentication Settings. ,
Required: False ,
}
{
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity ,
Required: False ,
}
string ,
}
,
}
,
storageConfigurationSettings:
{
Description: Storage Configuration Settings. ,
Required: False ,
}
{
sqlDataSettings:
{
Description: SQL Server Data Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlLogSettings:
{
Description: SQL Server Log Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlTempDbSettings:
{
Description: SQL Server TempDb Storage Settings. ,
Required: False ,
}
{
dataFileSize:
{
Description: SQL Server tempdb data file size ,
Format: int32 ,
Required: False ,
}
integer ,
dataGrowth:
{
Description: SQL Server tempdb data file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
logFileSize:
{
Description: SQL Server tempdb log file size ,
Format: int32 ,
Required: False ,
}
integer ,
logGrowth:
{
Description: SQL Server tempdb log file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
dataFileCount:
{
Description: SQL Server tempdb data file count ,
Format: int32 ,
Required: False ,
}
integer ,
persistFolder:
{
Description: SQL Server tempdb persist folder choice ,
Required: False ,
}
boolean ,
persistFolderPath:
{
Description: SQL Server tempdb persist folder location ,
Required: False ,
}
string ,
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlSystemDbOnDataDisk:
{
Description: SQL Server SystemDb Storage on DataPool if true. ,
Required: False ,
}
boolean ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
storageWorkloadType:
{
Description: Storage workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
enableStorageConfigBlade:
{
Description: Enable SQL IaaS Agent storage configuration blade in Azure Portal. ,
Required: False ,
}
boolean ,
}
,
troubleshootingStatus:
{
Description: Troubleshooting status ,
Required: False ,
}
{
rootCause:
{
Description: Root cause of the issue ,
Required: False ,
}
string ,
lastTriggerTimeUtc:
{
Description: Last troubleshooting trigger time in UTC timezone ,
Format: date-time ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
troubleshootingScenario:
{
Description: SQL VM troubleshooting scenario. ,
Enum:
{
UnhealthyReplica: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Troubleshooting properties ,
Required: False ,
}
{
unhealthyReplicaInfo:
{
Description: The unhealthy replica information ,
Required: False ,
}
{
availabilityGroupName:
{
Description: The name of the availability group ,
Required: False ,
}
string ,
}
,
}
,
}
,
assessmentSettings:
{
Description: SQL best practices Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable SQL best practices Assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run SQL best practices Assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for SQL best practices Assessment. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment schedule on SQL virtual machine. ,
Required: False ,
}
boolean ,
weeklyInterval:
{
Description: Number of weeks to schedule between 2 assessment runs. Takes value from 1-6 ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyOccurrence:
{
Description: 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 ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week to run assessment. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time of the day in HH:mm format. Eg. 17:30 ,
Required: False ,
}
string ,
}
,
}
,
enableAutomaticUpgrade:
{
Description: Enable automatic upgrade of Sql IaaS extension Agent. ,
Required: False ,
}
boolean ,
additionalVmPatch:
{
Description: Additional VM Patching solution enabled on the Virtual Machine ,
Enum:
{
WU: No description available. ,
WUMU: No description available. ,
WSUS: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachineIdentitySettings:
{
Description: Virtual Machine Identity details used for Sql IaaS extension configurations. ,
Required: False ,
}
{
type:
{
Description: Identity type of the virtual machine. Specify None to opt-out of Managed Identities. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: ARM Resource Id of the identity. Only required when UserAssigned identity is selected. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
osType:
{
Description: Operating System of the current SQL Virtual Machine. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachines_ListByResourceGroup (updated)
Description :  Gets all SQL virtual machines in a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachines_ListByResourceGroup",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a SqlVirtualMachine list operation.",
        "old": "A list of SQL virtual machines."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SqlVirtualMachine items on this page",
            "old": "Array of results."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_6b7ee041f52a470983ed50535447250e": {
                "#name": "systemData",
                "Description": "Metadata pertaining to creation and last modification of the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to retrieve next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlVirtualMachine items on this page ,
Required: True ,
}
[
{
identity:
{
Description: DO NOT USE. This value will be deprecated. Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
virtualMachineResourceId:
{
Description: ARM Resource id of underlying virtual machine created from SQL marketplace image. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
sqlImageOffer:
{
Description: SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. ,
Required: False ,
}
string ,
sqlServerLicenseType:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
AHUB: No description available. ,
DR: No description available. ,
}
,
Required: False ,
}
enum ,
sqlManagement:
{
Description: SQL Server Management type. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it. ,
Enum:
{
Full: No description available. ,
LightWeight: No description available. ,
NoAgent: No description available. ,
}
,
Required: False ,
}
enum ,
leastPrivilegeMode:
{
Description: SQL IaaS Agent least privilege mode. ,
Enum:
{
Enabled: No description available. ,
NotSet: No description available. ,
}
,
Required: False ,
}
enum ,
sqlImageSku:
{
Description: SQL Server edition type. ,
Enum:
{
Developer: No description available. ,
Express: No description available. ,
Standard: No description available. ,
Enterprise: No description available. ,
Web: No description available. ,
}
,
Required: False ,
}
enum ,
sqlVirtualMachineGroupResourceId:
{
Description: ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. ,
Required: False ,
}
string ,
wsfcDomainCredentials:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
{
clusterBootstrapAccountPassword:
{
Description: Cluster bootstrap account password. ,
Required: False ,
}
string ,
clusterOperatorAccountPassword:
{
Description: Cluster operator account password. ,
Required: False ,
}
string ,
sqlServiceAccountPassword:
{
Description: SQL service account password. ,
Required: False ,
}
string ,
}
,
wsfcStaticIp:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
string ,
autoPatchingSettings:
{
Description: Auto patching settings for applying critical security updates to SQL virtual machine. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autopatching on SQL virtual machine. ,
Required: False ,
}
boolean ,
dayOfWeek:
{
Description: Day of week to apply the patch on. ,
Enum:
{
Everyday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindowStartingHour:
{
Description: Hour of the day when patching is initiated. Local VM time. ,
Format: int32 ,
Required: False ,
}
integer ,
maintenanceWindowDuration:
{
Description: Duration of patching. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVmPatch:
{
Description: Additional Patch to be enable or enabled on the SQL Virtual Machine. ,
Enum:
{
NotSet: No description available. ,
MicrosoftUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
autoBackupSettings:
{
Description: Auto backup settings for SQL Server. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autobackup on SQL virtual machine. ,
Required: False ,
}
boolean ,
enableEncryption:
{
Description: Enable or disable encryption for backup on SQL virtual machine. ,
Required: False ,
}
boolean ,
retentionPeriod:
{
Description: Retention period of backup: 1-90 days. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: Storage account url where backup will be taken to. ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage container name where backup will be taken to. ,
Required: False ,
}
string ,
storageAccessKey:
{
Description: Storage account key where backup will be taken to. ,
Required: False ,
}
string ,
password:
{
Description: Password for encryption on backup. ,
Required: False ,
}
string ,
backupSystemDbs:
{
Description: Include or exclude system databases from auto backup. ,
Required: False ,
}
boolean ,
backupScheduleType:
{
Description: Backup schedule type. ,
Enum:
{
Manual: No description available. ,
Automated: No description available. ,
}
,
Required: False ,
}
enum ,
fullBackupFrequency:
{
Description: Frequency of full backups. In both cases, full backups begin during the next scheduled time window. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: False ,
}
enum ,
daysOfWeek:
{
Description: Days of the week for the backups when FullBackupFrequency is set to Weekly. ,
Required: False ,
}
[
string ,
]
,
fullBackupStartTime:
{
Description: Start time of a given day during which full backups can take place. 0-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupWindowHours:
{
Description: Duration of the time window of a given day during which full backups can take place. 1-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
logBackupFrequency:
{
Description: Frequency of log backups. 5-60 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
keyVaultCredentialSettings:
{
Description: Key vault credential settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable key vault credential setting. ,
Required: False ,
}
boolean ,
credentialName:
{
Description: Credential name. ,
Required: False ,
}
string ,
azureKeyVaultUrl:
{
Description: Azure Key Vault url. ,
Required: False ,
}
string ,
servicePrincipalName:
{
Description: Service principal name to access key vault. ,
Required: False ,
}
string ,
servicePrincipalSecret:
{
Description: Service principal name secret to access key vault. ,
Required: False ,
}
string ,
}
,
serverConfigurationsManagementSettings:
{
Description: SQL Server configuration management settings. ,
Required: False ,
}
{
sqlConnectivityUpdateSettings:
{
Description: SQL connectivity type settings. ,
Required: False ,
}
{
connectivityType:
{
Description: SQL Server connectivity option. ,
Enum:
{
LOCAL: No description available. ,
PRIVATE: No description available. ,
PUBLIC: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: SQL Server port. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlAuthUpdateUserName:
{
Description: SQL Server sysadmin login to create. ,
Required: False ,
}
string ,
sqlAuthUpdatePassword:
{
Description: SQL Server sysadmin login password. ,
Required: False ,
}
string ,
}
,
sqlWorkloadTypeUpdateSettings:
{
Description: SQL workload type settings. ,
Required: False ,
}
{
sqlWorkloadType:
{
Description: SQL Server workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sqlStorageUpdateSettings:
{
Description: SQL storage update settings. ,
Required: False ,
}
{
diskCount:
{
Description: Virtual machine disk count. ,
Format: int32 ,
Required: False ,
}
integer ,
startingDeviceId:
{
Description: Device id of the first disk to be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
additionalFeaturesServerConfigurations:
{
Description: Additional SQL feature settings. ,
Required: False ,
}
{
isRServicesEnabled:
{
Description: Enable or disable R services (SQL 2016 onwards). ,
Required: False ,
}
boolean ,
}
,
sqlInstanceSettings:
{
Description: SQL Instance settings. ,
Required: False ,
}
{
collation:
{
Description: SQL Server Collation. ,
Required: False ,
}
string ,
maxDop:
{
Description: SQL Server MAXDOP. ,
Format: int32 ,
Required: False ,
}
integer ,
isOptimizeForAdHocWorkloadsEnabled:
{
Description: SQL Server Optimize for Adhoc workloads. ,
Required: False ,
}
boolean ,
minServerMemoryMB:
{
Description: SQL Server minimum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
maxServerMemoryMB:
{
Description: SQL Server maximum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
isLpimEnabled:
{
Description: SQL Server LPIM. ,
Required: False ,
}
boolean ,
isIfiEnabled:
{
Description: SQL Server IFI. ,
Required: False ,
}
boolean ,
}
,
azureAdAuthenticationSettings:
{
Description: Azure AD authentication Settings. ,
Required: False ,
}
{
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity ,
Required: False ,
}
string ,
}
,
}
,
storageConfigurationSettings:
{
Description: Storage Configuration Settings. ,
Required: False ,
}
{
sqlDataSettings:
{
Description: SQL Server Data Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlLogSettings:
{
Description: SQL Server Log Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlTempDbSettings:
{
Description: SQL Server TempDb Storage Settings. ,
Required: False ,
}
{
dataFileSize:
{
Description: SQL Server tempdb data file size ,
Format: int32 ,
Required: False ,
}
integer ,
dataGrowth:
{
Description: SQL Server tempdb data file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
logFileSize:
{
Description: SQL Server tempdb log file size ,
Format: int32 ,
Required: False ,
}
integer ,
logGrowth:
{
Description: SQL Server tempdb log file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
dataFileCount:
{
Description: SQL Server tempdb data file count ,
Format: int32 ,
Required: False ,
}
integer ,
persistFolder:
{
Description: SQL Server tempdb persist folder choice ,
Required: False ,
}
boolean ,
persistFolderPath:
{
Description: SQL Server tempdb persist folder location ,
Required: False ,
}
string ,
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlSystemDbOnDataDisk:
{
Description: SQL Server SystemDb Storage on DataPool if true. ,
Required: False ,
}
boolean ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
storageWorkloadType:
{
Description: Storage workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
enableStorageConfigBlade:
{
Description: Enable SQL IaaS Agent storage configuration blade in Azure Portal. ,
Required: False ,
}
boolean ,
}
,
troubleshootingStatus:
{
Description: Troubleshooting status ,
Required: False ,
}
{
rootCause:
{
Description: Root cause of the issue ,
Required: False ,
}
string ,
lastTriggerTimeUtc:
{
Description: Last troubleshooting trigger time in UTC timezone ,
Format: date-time ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
troubleshootingScenario:
{
Description: SQL VM troubleshooting scenario. ,
Enum:
{
UnhealthyReplica: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Troubleshooting properties ,
Required: False ,
}
{
unhealthyReplicaInfo:
{
Description: The unhealthy replica information ,
Required: False ,
}
{
availabilityGroupName:
{
Description: The name of the availability group ,
Required: False ,
}
string ,
}
,
}
,
}
,
assessmentSettings:
{
Description: SQL best practices Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable SQL best practices Assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run SQL best practices Assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for SQL best practices Assessment. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment schedule on SQL virtual machine. ,
Required: False ,
}
boolean ,
weeklyInterval:
{
Description: Number of weeks to schedule between 2 assessment runs. Takes value from 1-6 ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyOccurrence:
{
Description: 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 ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week to run assessment. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time of the day in HH:mm format. Eg. 17:30 ,
Required: False ,
}
string ,
}
,
}
,
enableAutomaticUpgrade:
{
Description: Enable automatic upgrade of Sql IaaS extension Agent. ,
Required: False ,
}
boolean ,
additionalVmPatch:
{
Description: Additional VM Patching solution enabled on the Virtual Machine ,
Enum:
{
WU: No description available. ,
WUMU: No description available. ,
WSUS: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachineIdentitySettings:
{
Description: Virtual Machine Identity details used for Sql IaaS extension configurations. ,
Required: False ,
}
{
type:
{
Description: Identity type of the virtual machine. Specify None to opt-out of Managed Identities. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: ARM Resource Id of the identity. Only required when UserAssigned identity is selected. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
osType:
{
Description: Operating System of the current SQL Virtual Machine. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachines_Get (updated)
Description :  Gets a SQL virtual machine.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachines_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_2739417cf8bb41c191ecee5ac3c83433": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: DO NOT USE. This value will be deprecated. Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
virtualMachineResourceId:
{
Description: ARM Resource id of underlying virtual machine created from SQL marketplace image. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
sqlImageOffer:
{
Description: SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. ,
Required: False ,
}
string ,
sqlServerLicenseType:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
AHUB: No description available. ,
DR: No description available. ,
}
,
Required: False ,
}
enum ,
sqlManagement:
{
Description: SQL Server Management type. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it. ,
Enum:
{
Full: No description available. ,
LightWeight: No description available. ,
NoAgent: No description available. ,
}
,
Required: False ,
}
enum ,
leastPrivilegeMode:
{
Description: SQL IaaS Agent least privilege mode. ,
Enum:
{
Enabled: No description available. ,
NotSet: No description available. ,
}
,
Required: False ,
}
enum ,
sqlImageSku:
{
Description: SQL Server edition type. ,
Enum:
{
Developer: No description available. ,
Express: No description available. ,
Standard: No description available. ,
Enterprise: No description available. ,
Web: No description available. ,
}
,
Required: False ,
}
enum ,
sqlVirtualMachineGroupResourceId:
{
Description: ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. ,
Required: False ,
}
string ,
wsfcDomainCredentials:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
{
clusterBootstrapAccountPassword:
{
Description: Cluster bootstrap account password. ,
Required: False ,
}
string ,
clusterOperatorAccountPassword:
{
Description: Cluster operator account password. ,
Required: False ,
}
string ,
sqlServiceAccountPassword:
{
Description: SQL service account password. ,
Required: False ,
}
string ,
}
,
wsfcStaticIp:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
string ,
autoPatchingSettings:
{
Description: Auto patching settings for applying critical security updates to SQL virtual machine. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autopatching on SQL virtual machine. ,
Required: False ,
}
boolean ,
dayOfWeek:
{
Description: Day of week to apply the patch on. ,
Enum:
{
Everyday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindowStartingHour:
{
Description: Hour of the day when patching is initiated. Local VM time. ,
Format: int32 ,
Required: False ,
}
integer ,
maintenanceWindowDuration:
{
Description: Duration of patching. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVmPatch:
{
Description: Additional Patch to be enable or enabled on the SQL Virtual Machine. ,
Enum:
{
NotSet: No description available. ,
MicrosoftUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
autoBackupSettings:
{
Description: Auto backup settings for SQL Server. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autobackup on SQL virtual machine. ,
Required: False ,
}
boolean ,
enableEncryption:
{
Description: Enable or disable encryption for backup on SQL virtual machine. ,
Required: False ,
}
boolean ,
retentionPeriod:
{
Description: Retention period of backup: 1-90 days. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: Storage account url where backup will be taken to. ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage container name where backup will be taken to. ,
Required: False ,
}
string ,
storageAccessKey:
{
Description: Storage account key where backup will be taken to. ,
Required: False ,
}
string ,
password:
{
Description: Password for encryption on backup. ,
Required: False ,
}
string ,
backupSystemDbs:
{
Description: Include or exclude system databases from auto backup. ,
Required: False ,
}
boolean ,
backupScheduleType:
{
Description: Backup schedule type. ,
Enum:
{
Manual: No description available. ,
Automated: No description available. ,
}
,
Required: False ,
}
enum ,
fullBackupFrequency:
{
Description: Frequency of full backups. In both cases, full backups begin during the next scheduled time window. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: False ,
}
enum ,
daysOfWeek:
{
Description: Days of the week for the backups when FullBackupFrequency is set to Weekly. ,
Required: False ,
}
[
string ,
]
,
fullBackupStartTime:
{
Description: Start time of a given day during which full backups can take place. 0-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupWindowHours:
{
Description: Duration of the time window of a given day during which full backups can take place. 1-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
logBackupFrequency:
{
Description: Frequency of log backups. 5-60 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
keyVaultCredentialSettings:
{
Description: Key vault credential settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable key vault credential setting. ,
Required: False ,
}
boolean ,
credentialName:
{
Description: Credential name. ,
Required: False ,
}
string ,
azureKeyVaultUrl:
{
Description: Azure Key Vault url. ,
Required: False ,
}
string ,
servicePrincipalName:
{
Description: Service principal name to access key vault. ,
Required: False ,
}
string ,
servicePrincipalSecret:
{
Description: Service principal name secret to access key vault. ,
Required: False ,
}
string ,
}
,
serverConfigurationsManagementSettings:
{
Description: SQL Server configuration management settings. ,
Required: False ,
}
{
sqlConnectivityUpdateSettings:
{
Description: SQL connectivity type settings. ,
Required: False ,
}
{
connectivityType:
{
Description: SQL Server connectivity option. ,
Enum:
{
LOCAL: No description available. ,
PRIVATE: No description available. ,
PUBLIC: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: SQL Server port. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlAuthUpdateUserName:
{
Description: SQL Server sysadmin login to create. ,
Required: False ,
}
string ,
sqlAuthUpdatePassword:
{
Description: SQL Server sysadmin login password. ,
Required: False ,
}
string ,
}
,
sqlWorkloadTypeUpdateSettings:
{
Description: SQL workload type settings. ,
Required: False ,
}
{
sqlWorkloadType:
{
Description: SQL Server workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sqlStorageUpdateSettings:
{
Description: SQL storage update settings. ,
Required: False ,
}
{
diskCount:
{
Description: Virtual machine disk count. ,
Format: int32 ,
Required: False ,
}
integer ,
startingDeviceId:
{
Description: Device id of the first disk to be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
additionalFeaturesServerConfigurations:
{
Description: Additional SQL feature settings. ,
Required: False ,
}
{
isRServicesEnabled:
{
Description: Enable or disable R services (SQL 2016 onwards). ,
Required: False ,
}
boolean ,
}
,
sqlInstanceSettings:
{
Description: SQL Instance settings. ,
Required: False ,
}
{
collation:
{
Description: SQL Server Collation. ,
Required: False ,
}
string ,
maxDop:
{
Description: SQL Server MAXDOP. ,
Format: int32 ,
Required: False ,
}
integer ,
isOptimizeForAdHocWorkloadsEnabled:
{
Description: SQL Server Optimize for Adhoc workloads. ,
Required: False ,
}
boolean ,
minServerMemoryMB:
{
Description: SQL Server minimum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
maxServerMemoryMB:
{
Description: SQL Server maximum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
isLpimEnabled:
{
Description: SQL Server LPIM. ,
Required: False ,
}
boolean ,
isIfiEnabled:
{
Description: SQL Server IFI. ,
Required: False ,
}
boolean ,
}
,
azureAdAuthenticationSettings:
{
Description: Azure AD authentication Settings. ,
Required: False ,
}
{
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity ,
Required: False ,
}
string ,
}
,
}
,
storageConfigurationSettings:
{
Description: Storage Configuration Settings. ,
Required: False ,
}
{
sqlDataSettings:
{
Description: SQL Server Data Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlLogSettings:
{
Description: SQL Server Log Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlTempDbSettings:
{
Description: SQL Server TempDb Storage Settings. ,
Required: False ,
}
{
dataFileSize:
{
Description: SQL Server tempdb data file size ,
Format: int32 ,
Required: False ,
}
integer ,
dataGrowth:
{
Description: SQL Server tempdb data file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
logFileSize:
{
Description: SQL Server tempdb log file size ,
Format: int32 ,
Required: False ,
}
integer ,
logGrowth:
{
Description: SQL Server tempdb log file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
dataFileCount:
{
Description: SQL Server tempdb data file count ,
Format: int32 ,
Required: False ,
}
integer ,
persistFolder:
{
Description: SQL Server tempdb persist folder choice ,
Required: False ,
}
boolean ,
persistFolderPath:
{
Description: SQL Server tempdb persist folder location ,
Required: False ,
}
string ,
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlSystemDbOnDataDisk:
{
Description: SQL Server SystemDb Storage on DataPool if true. ,
Required: False ,
}
boolean ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
storageWorkloadType:
{
Description: Storage workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
enableStorageConfigBlade:
{
Description: Enable SQL IaaS Agent storage configuration blade in Azure Portal. ,
Required: False ,
}
boolean ,
}
,
troubleshootingStatus:
{
Description: Troubleshooting status ,
Required: False ,
}
{
rootCause:
{
Description: Root cause of the issue ,
Required: False ,
}
string ,
lastTriggerTimeUtc:
{
Description: Last troubleshooting trigger time in UTC timezone ,
Format: date-time ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
troubleshootingScenario:
{
Description: SQL VM troubleshooting scenario. ,
Enum:
{
UnhealthyReplica: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Troubleshooting properties ,
Required: False ,
}
{
unhealthyReplicaInfo:
{
Description: The unhealthy replica information ,
Required: False ,
}
{
availabilityGroupName:
{
Description: The name of the availability group ,
Required: False ,
}
string ,
}
,
}
,
}
,
assessmentSettings:
{
Description: SQL best practices Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable SQL best practices Assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run SQL best practices Assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for SQL best practices Assessment. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment schedule on SQL virtual machine. ,
Required: False ,
}
boolean ,
weeklyInterval:
{
Description: Number of weeks to schedule between 2 assessment runs. Takes value from 1-6 ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyOccurrence:
{
Description: 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 ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week to run assessment. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time of the day in HH:mm format. Eg. 17:30 ,
Required: False ,
}
string ,
}
,
}
,
enableAutomaticUpgrade:
{
Description: Enable automatic upgrade of Sql IaaS extension Agent. ,
Required: False ,
}
boolean ,
additionalVmPatch:
{
Description: Additional VM Patching solution enabled on the Virtual Machine ,
Enum:
{
WU: No description available. ,
WUMU: No description available. ,
WSUS: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachineIdentitySettings:
{
Description: Virtual Machine Identity details used for Sql IaaS extension configurations. ,
Required: False ,
}
{
type:
{
Description: Identity type of the virtual machine. Specify None to opt-out of Managed Identities. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: ARM Resource Id of the identity. Only required when UserAssigned identity is selected. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
osType:
{
Description: Operating System of the current SQL Virtual Machine. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachines_CreateOrUpdate (updated)
Description :  Creates or updates a SQL virtual machine.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachines_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@removed_d0702b08b67c4d2e9b8690b7da35d376": {
            "#name": "systemData",
            "Description": "Metadata pertaining to creation and last modification of the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_44975fd2cd864b89b39c775230598d01": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_1f398a5d95614521be9dcf762223c45e": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
parameters:
{
Description: The SQL virtual machine. ,
Required: True ,
}
{
identity:
{
Description: DO NOT USE. This value will be deprecated. Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
virtualMachineResourceId:
{
Description: ARM Resource id of underlying virtual machine created from SQL marketplace image. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
sqlImageOffer:
{
Description: SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. ,
Required: False ,
}
string ,
sqlServerLicenseType:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
AHUB: No description available. ,
DR: No description available. ,
}
,
Required: False ,
}
enum ,
sqlManagement:
{
Description: SQL Server Management type. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it. ,
Enum:
{
Full: No description available. ,
LightWeight: No description available. ,
NoAgent: No description available. ,
}
,
Required: False ,
}
enum ,
leastPrivilegeMode:
{
Description: SQL IaaS Agent least privilege mode. ,
Enum:
{
Enabled: No description available. ,
NotSet: No description available. ,
}
,
Required: False ,
}
enum ,
sqlImageSku:
{
Description: SQL Server edition type. ,
Enum:
{
Developer: No description available. ,
Express: No description available. ,
Standard: No description available. ,
Enterprise: No description available. ,
Web: No description available. ,
}
,
Required: False ,
}
enum ,
sqlVirtualMachineGroupResourceId:
{
Description: ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. ,
Required: False ,
}
string ,
wsfcDomainCredentials:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
{
clusterBootstrapAccountPassword:
{
Description: Cluster bootstrap account password. ,
Required: False ,
}
string ,
clusterOperatorAccountPassword:
{
Description: Cluster operator account password. ,
Required: False ,
}
string ,
sqlServiceAccountPassword:
{
Description: SQL service account password. ,
Required: False ,
}
string ,
}
,
wsfcStaticIp:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
string ,
autoPatchingSettings:
{
Description: Auto patching settings for applying critical security updates to SQL virtual machine. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autopatching on SQL virtual machine. ,
Required: False ,
}
boolean ,
dayOfWeek:
{
Description: Day of week to apply the patch on. ,
Enum:
{
Everyday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindowStartingHour:
{
Description: Hour of the day when patching is initiated. Local VM time. ,
Format: int32 ,
Required: False ,
}
integer ,
maintenanceWindowDuration:
{
Description: Duration of patching. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVmPatch:
{
Description: Additional Patch to be enable or enabled on the SQL Virtual Machine. ,
Enum:
{
NotSet: No description available. ,
MicrosoftUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
autoBackupSettings:
{
Description: Auto backup settings for SQL Server. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autobackup on SQL virtual machine. ,
Required: False ,
}
boolean ,
enableEncryption:
{
Description: Enable or disable encryption for backup on SQL virtual machine. ,
Required: False ,
}
boolean ,
retentionPeriod:
{
Description: Retention period of backup: 1-90 days. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: Storage account url where backup will be taken to. ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage container name where backup will be taken to. ,
Required: False ,
}
string ,
storageAccessKey:
{
Description: Storage account key where backup will be taken to. ,
Required: False ,
}
string ,
password:
{
Description: Password for encryption on backup. ,
Required: False ,
}
string ,
backupSystemDbs:
{
Description: Include or exclude system databases from auto backup. ,
Required: False ,
}
boolean ,
backupScheduleType:
{
Description: Backup schedule type. ,
Enum:
{
Manual: No description available. ,
Automated: No description available. ,
}
,
Required: False ,
}
enum ,
fullBackupFrequency:
{
Description: Frequency of full backups. In both cases, full backups begin during the next scheduled time window. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: False ,
}
enum ,
daysOfWeek:
{
Description: Days of the week for the backups when FullBackupFrequency is set to Weekly. ,
Required: False ,
}
[
string ,
]
,
fullBackupStartTime:
{
Description: Start time of a given day during which full backups can take place. 0-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupWindowHours:
{
Description: Duration of the time window of a given day during which full backups can take place. 1-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
logBackupFrequency:
{
Description: Frequency of log backups. 5-60 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
keyVaultCredentialSettings:
{
Description: Key vault credential settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable key vault credential setting. ,
Required: False ,
}
boolean ,
credentialName:
{
Description: Credential name. ,
Required: False ,
}
string ,
azureKeyVaultUrl:
{
Description: Azure Key Vault url. ,
Required: False ,
}
string ,
servicePrincipalName:
{
Description: Service principal name to access key vault. ,
Required: False ,
}
string ,
servicePrincipalSecret:
{
Description: Service principal name secret to access key vault. ,
Required: False ,
}
string ,
}
,
serverConfigurationsManagementSettings:
{
Description: SQL Server configuration management settings. ,
Required: False ,
}
{
sqlConnectivityUpdateSettings:
{
Description: SQL connectivity type settings. ,
Required: False ,
}
{
connectivityType:
{
Description: SQL Server connectivity option. ,
Enum:
{
LOCAL: No description available. ,
PRIVATE: No description available. ,
PUBLIC: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: SQL Server port. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlAuthUpdateUserName:
{
Description: SQL Server sysadmin login to create. ,
Required: False ,
}
string ,
sqlAuthUpdatePassword:
{
Description: SQL Server sysadmin login password. ,
Required: False ,
}
string ,
}
,
sqlWorkloadTypeUpdateSettings:
{
Description: SQL workload type settings. ,
Required: False ,
}
{
sqlWorkloadType:
{
Description: SQL Server workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sqlStorageUpdateSettings:
{
Description: SQL storage update settings. ,
Required: False ,
}
{
diskCount:
{
Description: Virtual machine disk count. ,
Format: int32 ,
Required: False ,
}
integer ,
startingDeviceId:
{
Description: Device id of the first disk to be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
additionalFeaturesServerConfigurations:
{
Description: Additional SQL feature settings. ,
Required: False ,
}
{
isRServicesEnabled:
{
Description: Enable or disable R services (SQL 2016 onwards). ,
Required: False ,
}
boolean ,
}
,
sqlInstanceSettings:
{
Description: SQL Instance settings. ,
Required: False ,
}
{
collation:
{
Description: SQL Server Collation. ,
Required: False ,
}
string ,
maxDop:
{
Description: SQL Server MAXDOP. ,
Format: int32 ,
Required: False ,
}
integer ,
isOptimizeForAdHocWorkloadsEnabled:
{
Description: SQL Server Optimize for Adhoc workloads. ,
Required: False ,
}
boolean ,
minServerMemoryMB:
{
Description: SQL Server minimum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
maxServerMemoryMB:
{
Description: SQL Server maximum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
isLpimEnabled:
{
Description: SQL Server LPIM. ,
Required: False ,
}
boolean ,
isIfiEnabled:
{
Description: SQL Server IFI. ,
Required: False ,
}
boolean ,
}
,
azureAdAuthenticationSettings:
{
Description: Azure AD authentication Settings. ,
Required: False ,
}
{
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity ,
Required: False ,
}
string ,
}
,
}
,
storageConfigurationSettings:
{
Description: Storage Configuration Settings. ,
Required: False ,
}
{
sqlDataSettings:
{
Description: SQL Server Data Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlLogSettings:
{
Description: SQL Server Log Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlTempDbSettings:
{
Description: SQL Server TempDb Storage Settings. ,
Required: False ,
}
{
dataFileSize:
{
Description: SQL Server tempdb data file size ,
Format: int32 ,
Required: False ,
}
integer ,
dataGrowth:
{
Description: SQL Server tempdb data file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
logFileSize:
{
Description: SQL Server tempdb log file size ,
Format: int32 ,
Required: False ,
}
integer ,
logGrowth:
{
Description: SQL Server tempdb log file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
dataFileCount:
{
Description: SQL Server tempdb data file count ,
Format: int32 ,
Required: False ,
}
integer ,
persistFolder:
{
Description: SQL Server tempdb persist folder choice ,
Required: False ,
}
boolean ,
persistFolderPath:
{
Description: SQL Server tempdb persist folder location ,
Required: False ,
}
string ,
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlSystemDbOnDataDisk:
{
Description: SQL Server SystemDb Storage on DataPool if true. ,
Required: False ,
}
boolean ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
storageWorkloadType:
{
Description: Storage workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
enableStorageConfigBlade:
{
Description: Enable SQL IaaS Agent storage configuration blade in Azure Portal. ,
Required: False ,
}
boolean ,
}
,
troubleshootingStatus:
{
Description: Troubleshooting status ,
Required: False ,
}
{
rootCause:
{
Description: Root cause of the issue ,
Required: False ,
}
string ,
lastTriggerTimeUtc:
{
Description: Last troubleshooting trigger time in UTC timezone ,
Format: date-time ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
troubleshootingScenario:
{
Description: SQL VM troubleshooting scenario. ,
Enum:
{
UnhealthyReplica: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Troubleshooting properties ,
Required: False ,
}
{
unhealthyReplicaInfo:
{
Description: The unhealthy replica information ,
Required: False ,
}
{
availabilityGroupName:
{
Description: The name of the availability group ,
Required: False ,
}
string ,
}
,
}
,
}
,
assessmentSettings:
{
Description: SQL best practices Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable SQL best practices Assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run SQL best practices Assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for SQL best practices Assessment. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment schedule on SQL virtual machine. ,
Required: False ,
}
boolean ,
weeklyInterval:
{
Description: Number of weeks to schedule between 2 assessment runs. Takes value from 1-6 ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyOccurrence:
{
Description: 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 ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week to run assessment. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time of the day in HH:mm format. Eg. 17:30 ,
Required: False ,
}
string ,
}
,
}
,
enableAutomaticUpgrade:
{
Description: Enable automatic upgrade of Sql IaaS extension Agent. ,
Required: False ,
}
boolean ,
additionalVmPatch:
{
Description: Additional VM Patching solution enabled on the Virtual Machine ,
Enum:
{
WU: No description available. ,
WUMU: No description available. ,
WSUS: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachineIdentitySettings:
{
Description: Virtual Machine Identity details used for Sql IaaS extension configurations. ,
Required: False ,
}
{
type:
{
Description: Identity type of the virtual machine. Specify None to opt-out of Managed Identities. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: ARM Resource Id of the identity. Only required when UserAssigned identity is selected. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
osType:
{
Description: Operating System of the current SQL Virtual Machine. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: DO NOT USE. This value will be deprecated. Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
virtualMachineResourceId:
{
Description: ARM Resource id of underlying virtual machine created from SQL marketplace image. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
sqlImageOffer:
{
Description: SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. ,
Required: False ,
}
string ,
sqlServerLicenseType:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
AHUB: No description available. ,
DR: No description available. ,
}
,
Required: False ,
}
enum ,
sqlManagement:
{
Description: SQL Server Management type. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it. ,
Enum:
{
Full: No description available. ,
LightWeight: No description available. ,
NoAgent: No description available. ,
}
,
Required: False ,
}
enum ,
leastPrivilegeMode:
{
Description: SQL IaaS Agent least privilege mode. ,
Enum:
{
Enabled: No description available. ,
NotSet: No description available. ,
}
,
Required: False ,
}
enum ,
sqlImageSku:
{
Description: SQL Server edition type. ,
Enum:
{
Developer: No description available. ,
Express: No description available. ,
Standard: No description available. ,
Enterprise: No description available. ,
Web: No description available. ,
}
,
Required: False ,
}
enum ,
sqlVirtualMachineGroupResourceId:
{
Description: ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. ,
Required: False ,
}
string ,
wsfcDomainCredentials:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
{
clusterBootstrapAccountPassword:
{
Description: Cluster bootstrap account password. ,
Required: False ,
}
string ,
clusterOperatorAccountPassword:
{
Description: Cluster operator account password. ,
Required: False ,
}
string ,
sqlServiceAccountPassword:
{
Description: SQL service account password. ,
Required: False ,
}
string ,
}
,
wsfcStaticIp:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
string ,
autoPatchingSettings:
{
Description: Auto patching settings for applying critical security updates to SQL virtual machine. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autopatching on SQL virtual machine. ,
Required: False ,
}
boolean ,
dayOfWeek:
{
Description: Day of week to apply the patch on. ,
Enum:
{
Everyday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindowStartingHour:
{
Description: Hour of the day when patching is initiated. Local VM time. ,
Format: int32 ,
Required: False ,
}
integer ,
maintenanceWindowDuration:
{
Description: Duration of patching. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVmPatch:
{
Description: Additional Patch to be enable or enabled on the SQL Virtual Machine. ,
Enum:
{
NotSet: No description available. ,
MicrosoftUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
autoBackupSettings:
{
Description: Auto backup settings for SQL Server. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autobackup on SQL virtual machine. ,
Required: False ,
}
boolean ,
enableEncryption:
{
Description: Enable or disable encryption for backup on SQL virtual machine. ,
Required: False ,
}
boolean ,
retentionPeriod:
{
Description: Retention period of backup: 1-90 days. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: Storage account url where backup will be taken to. ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage container name where backup will be taken to. ,
Required: False ,
}
string ,
storageAccessKey:
{
Description: Storage account key where backup will be taken to. ,
Required: False ,
}
string ,
password:
{
Description: Password for encryption on backup. ,
Required: False ,
}
string ,
backupSystemDbs:
{
Description: Include or exclude system databases from auto backup. ,
Required: False ,
}
boolean ,
backupScheduleType:
{
Description: Backup schedule type. ,
Enum:
{
Manual: No description available. ,
Automated: No description available. ,
}
,
Required: False ,
}
enum ,
fullBackupFrequency:
{
Description: Frequency of full backups. In both cases, full backups begin during the next scheduled time window. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: False ,
}
enum ,
daysOfWeek:
{
Description: Days of the week for the backups when FullBackupFrequency is set to Weekly. ,
Required: False ,
}
[
string ,
]
,
fullBackupStartTime:
{
Description: Start time of a given day during which full backups can take place. 0-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupWindowHours:
{
Description: Duration of the time window of a given day during which full backups can take place. 1-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
logBackupFrequency:
{
Description: Frequency of log backups. 5-60 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
keyVaultCredentialSettings:
{
Description: Key vault credential settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable key vault credential setting. ,
Required: False ,
}
boolean ,
credentialName:
{
Description: Credential name. ,
Required: False ,
}
string ,
azureKeyVaultUrl:
{
Description: Azure Key Vault url. ,
Required: False ,
}
string ,
servicePrincipalName:
{
Description: Service principal name to access key vault. ,
Required: False ,
}
string ,
servicePrincipalSecret:
{
Description: Service principal name secret to access key vault. ,
Required: False ,
}
string ,
}
,
serverConfigurationsManagementSettings:
{
Description: SQL Server configuration management settings. ,
Required: False ,
}
{
sqlConnectivityUpdateSettings:
{
Description: SQL connectivity type settings. ,
Required: False ,
}
{
connectivityType:
{
Description: SQL Server connectivity option. ,
Enum:
{
LOCAL: No description available. ,
PRIVATE: No description available. ,
PUBLIC: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: SQL Server port. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlAuthUpdateUserName:
{
Description: SQL Server sysadmin login to create. ,
Required: False ,
}
string ,
sqlAuthUpdatePassword:
{
Description: SQL Server sysadmin login password. ,
Required: False ,
}
string ,
}
,
sqlWorkloadTypeUpdateSettings:
{
Description: SQL workload type settings. ,
Required: False ,
}
{
sqlWorkloadType:
{
Description: SQL Server workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sqlStorageUpdateSettings:
{
Description: SQL storage update settings. ,
Required: False ,
}
{
diskCount:
{
Description: Virtual machine disk count. ,
Format: int32 ,
Required: False ,
}
integer ,
startingDeviceId:
{
Description: Device id of the first disk to be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
additionalFeaturesServerConfigurations:
{
Description: Additional SQL feature settings. ,
Required: False ,
}
{
isRServicesEnabled:
{
Description: Enable or disable R services (SQL 2016 onwards). ,
Required: False ,
}
boolean ,
}
,
sqlInstanceSettings:
{
Description: SQL Instance settings. ,
Required: False ,
}
{
collation:
{
Description: SQL Server Collation. ,
Required: False ,
}
string ,
maxDop:
{
Description: SQL Server MAXDOP. ,
Format: int32 ,
Required: False ,
}
integer ,
isOptimizeForAdHocWorkloadsEnabled:
{
Description: SQL Server Optimize for Adhoc workloads. ,
Required: False ,
}
boolean ,
minServerMemoryMB:
{
Description: SQL Server minimum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
maxServerMemoryMB:
{
Description: SQL Server maximum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
isLpimEnabled:
{
Description: SQL Server LPIM. ,
Required: False ,
}
boolean ,
isIfiEnabled:
{
Description: SQL Server IFI. ,
Required: False ,
}
boolean ,
}
,
azureAdAuthenticationSettings:
{
Description: Azure AD authentication Settings. ,
Required: False ,
}
{
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity ,
Required: False ,
}
string ,
}
,
}
,
storageConfigurationSettings:
{
Description: Storage Configuration Settings. ,
Required: False ,
}
{
sqlDataSettings:
{
Description: SQL Server Data Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlLogSettings:
{
Description: SQL Server Log Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlTempDbSettings:
{
Description: SQL Server TempDb Storage Settings. ,
Required: False ,
}
{
dataFileSize:
{
Description: SQL Server tempdb data file size ,
Format: int32 ,
Required: False ,
}
integer ,
dataGrowth:
{
Description: SQL Server tempdb data file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
logFileSize:
{
Description: SQL Server tempdb log file size ,
Format: int32 ,
Required: False ,
}
integer ,
logGrowth:
{
Description: SQL Server tempdb log file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
dataFileCount:
{
Description: SQL Server tempdb data file count ,
Format: int32 ,
Required: False ,
}
integer ,
persistFolder:
{
Description: SQL Server tempdb persist folder choice ,
Required: False ,
}
boolean ,
persistFolderPath:
{
Description: SQL Server tempdb persist folder location ,
Required: False ,
}
string ,
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlSystemDbOnDataDisk:
{
Description: SQL Server SystemDb Storage on DataPool if true. ,
Required: False ,
}
boolean ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
storageWorkloadType:
{
Description: Storage workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
enableStorageConfigBlade:
{
Description: Enable SQL IaaS Agent storage configuration blade in Azure Portal. ,
Required: False ,
}
boolean ,
}
,
troubleshootingStatus:
{
Description: Troubleshooting status ,
Required: False ,
}
{
rootCause:
{
Description: Root cause of the issue ,
Required: False ,
}
string ,
lastTriggerTimeUtc:
{
Description: Last troubleshooting trigger time in UTC timezone ,
Format: date-time ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
troubleshootingScenario:
{
Description: SQL VM troubleshooting scenario. ,
Enum:
{
UnhealthyReplica: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Troubleshooting properties ,
Required: False ,
}
{
unhealthyReplicaInfo:
{
Description: The unhealthy replica information ,
Required: False ,
}
{
availabilityGroupName:
{
Description: The name of the availability group ,
Required: False ,
}
string ,
}
,
}
,
}
,
assessmentSettings:
{
Description: SQL best practices Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable SQL best practices Assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run SQL best practices Assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for SQL best practices Assessment. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment schedule on SQL virtual machine. ,
Required: False ,
}
boolean ,
weeklyInterval:
{
Description: Number of weeks to schedule between 2 assessment runs. Takes value from 1-6 ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyOccurrence:
{
Description: 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 ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week to run assessment. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time of the day in HH:mm format. Eg. 17:30 ,
Required: False ,
}
string ,
}
,
}
,
enableAutomaticUpgrade:
{
Description: Enable automatic upgrade of Sql IaaS extension Agent. ,
Required: False ,
}
boolean ,
additionalVmPatch:
{
Description: Additional VM Patching solution enabled on the Virtual Machine ,
Enum:
{
WU: No description available. ,
WUMU: No description available. ,
WSUS: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachineIdentitySettings:
{
Description: Virtual Machine Identity details used for Sql IaaS extension configurations. ,
Required: False ,
}
{
type:
{
Description: Identity type of the virtual machine. Specify None to opt-out of Managed Identities. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: ARM Resource Id of the identity. Only required when UserAssigned identity is selected. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
osType:
{
Description: Operating System of the current SQL Virtual Machine. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A SQL virtual machine. ,
}
{
identity:
{
Description: DO NOT USE. This value will be deprecated. Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
virtualMachineResourceId:
{
Description: ARM Resource id of underlying virtual machine created from SQL marketplace image. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
sqlImageOffer:
{
Description: SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. ,
Required: False ,
}
string ,
sqlServerLicenseType:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
AHUB: No description available. ,
DR: No description available. ,
}
,
Required: False ,
}
enum ,
sqlManagement:
{
Description: SQL Server Management type. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it. ,
Enum:
{
Full: No description available. ,
LightWeight: No description available. ,
NoAgent: No description available. ,
}
,
Required: False ,
}
enum ,
leastPrivilegeMode:
{
Description: SQL IaaS Agent least privilege mode. ,
Enum:
{
Enabled: No description available. ,
NotSet: No description available. ,
}
,
Required: False ,
}
enum ,
sqlImageSku:
{
Description: SQL Server edition type. ,
Enum:
{
Developer: No description available. ,
Express: No description available. ,
Standard: No description available. ,
Enterprise: No description available. ,
Web: No description available. ,
}
,
Required: False ,
}
enum ,
sqlVirtualMachineGroupResourceId:
{
Description: ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. ,
Required: False ,
}
string ,
wsfcDomainCredentials:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
{
clusterBootstrapAccountPassword:
{
Description: Cluster bootstrap account password. ,
Required: False ,
}
string ,
clusterOperatorAccountPassword:
{
Description: Cluster operator account password. ,
Required: False ,
}
string ,
sqlServiceAccountPassword:
{
Description: SQL service account password. ,
Required: False ,
}
string ,
}
,
wsfcStaticIp:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
string ,
autoPatchingSettings:
{
Description: Auto patching settings for applying critical security updates to SQL virtual machine. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autopatching on SQL virtual machine. ,
Required: False ,
}
boolean ,
dayOfWeek:
{
Description: Day of week to apply the patch on. ,
Enum:
{
Everyday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindowStartingHour:
{
Description: Hour of the day when patching is initiated. Local VM time. ,
Format: int32 ,
Required: False ,
}
integer ,
maintenanceWindowDuration:
{
Description: Duration of patching. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVmPatch:
{
Description: Additional Patch to be enable or enabled on the SQL Virtual Machine. ,
Enum:
{
NotSet: No description available. ,
MicrosoftUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
autoBackupSettings:
{
Description: Auto backup settings for SQL Server. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autobackup on SQL virtual machine. ,
Required: False ,
}
boolean ,
enableEncryption:
{
Description: Enable or disable encryption for backup on SQL virtual machine. ,
Required: False ,
}
boolean ,
retentionPeriod:
{
Description: Retention period of backup: 1-90 days. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: Storage account url where backup will be taken to. ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage container name where backup will be taken to. ,
Required: False ,
}
string ,
storageAccessKey:
{
Description: Storage account key where backup will be taken to. ,
Required: False ,
}
string ,
password:
{
Description: Password for encryption on backup. ,
Required: False ,
}
string ,
backupSystemDbs:
{
Description: Include or exclude system databases from auto backup. ,
Required: False ,
}
boolean ,
backupScheduleType:
{
Description: Backup schedule type. ,
Enum:
{
Manual: No description available. ,
Automated: No description available. ,
}
,
Required: False ,
}
enum ,
fullBackupFrequency:
{
Description: Frequency of full backups. In both cases, full backups begin during the next scheduled time window. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: False ,
}
enum ,
daysOfWeek:
{
Description: Days of the week for the backups when FullBackupFrequency is set to Weekly. ,
Required: False ,
}
[
string ,
]
,
fullBackupStartTime:
{
Description: Start time of a given day during which full backups can take place. 0-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupWindowHours:
{
Description: Duration of the time window of a given day during which full backups can take place. 1-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
logBackupFrequency:
{
Description: Frequency of log backups. 5-60 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
keyVaultCredentialSettings:
{
Description: Key vault credential settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable key vault credential setting. ,
Required: False ,
}
boolean ,
credentialName:
{
Description: Credential name. ,
Required: False ,
}
string ,
azureKeyVaultUrl:
{
Description: Azure Key Vault url. ,
Required: False ,
}
string ,
servicePrincipalName:
{
Description: Service principal name to access key vault. ,
Required: False ,
}
string ,
servicePrincipalSecret:
{
Description: Service principal name secret to access key vault. ,
Required: False ,
}
string ,
}
,
serverConfigurationsManagementSettings:
{
Description: SQL Server configuration management settings. ,
Required: False ,
}
{
sqlConnectivityUpdateSettings:
{
Description: SQL connectivity type settings. ,
Required: False ,
}
{
connectivityType:
{
Description: SQL Server connectivity option. ,
Enum:
{
LOCAL: No description available. ,
PRIVATE: No description available. ,
PUBLIC: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: SQL Server port. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlAuthUpdateUserName:
{
Description: SQL Server sysadmin login to create. ,
Required: False ,
}
string ,
sqlAuthUpdatePassword:
{
Description: SQL Server sysadmin login password. ,
Required: False ,
}
string ,
}
,
sqlWorkloadTypeUpdateSettings:
{
Description: SQL workload type settings. ,
Required: False ,
}
{
sqlWorkloadType:
{
Description: SQL Server workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sqlStorageUpdateSettings:
{
Description: SQL storage update settings. ,
Required: False ,
}
{
diskCount:
{
Description: Virtual machine disk count. ,
Format: int32 ,
Required: False ,
}
integer ,
startingDeviceId:
{
Description: Device id of the first disk to be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
additionalFeaturesServerConfigurations:
{
Description: Additional SQL feature settings. ,
Required: False ,
}
{
isRServicesEnabled:
{
Description: Enable or disable R services (SQL 2016 onwards). ,
Required: False ,
}
boolean ,
}
,
sqlInstanceSettings:
{
Description: SQL Instance settings. ,
Required: False ,
}
{
collation:
{
Description: SQL Server Collation. ,
Required: False ,
}
string ,
maxDop:
{
Description: SQL Server MAXDOP. ,
Format: int32 ,
Required: False ,
}
integer ,
isOptimizeForAdHocWorkloadsEnabled:
{
Description: SQL Server Optimize for Adhoc workloads. ,
Required: False ,
}
boolean ,
minServerMemoryMB:
{
Description: SQL Server minimum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
maxServerMemoryMB:
{
Description: SQL Server maximum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
isLpimEnabled:
{
Description: SQL Server LPIM. ,
Required: False ,
}
boolean ,
isIfiEnabled:
{
Description: SQL Server IFI. ,
Required: False ,
}
boolean ,
}
,
azureAdAuthenticationSettings:
{
Description: Azure AD authentication Settings. ,
Required: False ,
}
{
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity ,
Required: False ,
}
string ,
}
,
}
,
storageConfigurationSettings:
{
Description: Storage Configuration Settings. ,
Required: False ,
}
{
sqlDataSettings:
{
Description: SQL Server Data Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlLogSettings:
{
Description: SQL Server Log Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlTempDbSettings:
{
Description: SQL Server TempDb Storage Settings. ,
Required: False ,
}
{
dataFileSize:
{
Description: SQL Server tempdb data file size ,
Format: int32 ,
Required: False ,
}
integer ,
dataGrowth:
{
Description: SQL Server tempdb data file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
logFileSize:
{
Description: SQL Server tempdb log file size ,
Format: int32 ,
Required: False ,
}
integer ,
logGrowth:
{
Description: SQL Server tempdb log file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
dataFileCount:
{
Description: SQL Server tempdb data file count ,
Format: int32 ,
Required: False ,
}
integer ,
persistFolder:
{
Description: SQL Server tempdb persist folder choice ,
Required: False ,
}
boolean ,
persistFolderPath:
{
Description: SQL Server tempdb persist folder location ,
Required: False ,
}
string ,
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlSystemDbOnDataDisk:
{
Description: SQL Server SystemDb Storage on DataPool if true. ,
Required: False ,
}
boolean ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
storageWorkloadType:
{
Description: Storage workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
enableStorageConfigBlade:
{
Description: Enable SQL IaaS Agent storage configuration blade in Azure Portal. ,
Required: False ,
}
boolean ,
}
,
troubleshootingStatus:
{
Description: Troubleshooting status ,
Required: False ,
}
{
rootCause:
{
Description: Root cause of the issue ,
Required: False ,
}
string ,
lastTriggerTimeUtc:
{
Description: Last troubleshooting trigger time in UTC timezone ,
Format: date-time ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
troubleshootingScenario:
{
Description: SQL VM troubleshooting scenario. ,
Enum:
{
UnhealthyReplica: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Troubleshooting properties ,
Required: False ,
}
{
unhealthyReplicaInfo:
{
Description: The unhealthy replica information ,
Required: False ,
}
{
availabilityGroupName:
{
Description: The name of the availability group ,
Required: False ,
}
string ,
}
,
}
,
}
,
assessmentSettings:
{
Description: SQL best practices Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable SQL best practices Assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run SQL best practices Assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for SQL best practices Assessment. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment schedule on SQL virtual machine. ,
Required: False ,
}
boolean ,
weeklyInterval:
{
Description: Number of weeks to schedule between 2 assessment runs. Takes value from 1-6 ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyOccurrence:
{
Description: 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 ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week to run assessment. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time of the day in HH:mm format. Eg. 17:30 ,
Required: False ,
}
string ,
}
,
}
,
enableAutomaticUpgrade:
{
Description: Enable automatic upgrade of Sql IaaS extension Agent. ,
Required: False ,
}
boolean ,
additionalVmPatch:
{
Description: Additional VM Patching solution enabled on the Virtual Machine ,
Enum:
{
WU: No description available. ,
WUMU: No description available. ,
WSUS: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachineIdentitySettings:
{
Description: Virtual Machine Identity details used for Sql IaaS extension configurations. ,
Required: False ,
}
{
type:
{
Description: Identity type of the virtual machine. Specify None to opt-out of Managed Identities. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: ARM Resource Id of the identity. Only required when UserAssigned identity is selected. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
osType:
{
Description: Operating System of the current SQL Virtual Machine. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachines_Update (updated)
Description :  Updates SQL virtual machine tags.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachines_Update",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_d04bd5fc4232473c851871784c2f349c": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
parameters:
{
Description: The SQL virtual machine. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
}
,
$schema:
{
Description: A SQL virtual machine. ,
}
{
identity:
{
Description: DO NOT USE. This value will be deprecated. Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
virtualMachineResourceId:
{
Description: ARM Resource id of underlying virtual machine created from SQL marketplace image. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state to track the async operation status. ,
Required: False ,
}
string ,
sqlImageOffer:
{
Description: SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. ,
Required: False ,
}
string ,
sqlServerLicenseType:
{
Description: SQL Server license type. ,
Enum:
{
PAYG: No description available. ,
AHUB: No description available. ,
DR: No description available. ,
}
,
Required: False ,
}
enum ,
sqlManagement:
{
Description: SQL Server Management type. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it. ,
Enum:
{
Full: No description available. ,
LightWeight: No description available. ,
NoAgent: No description available. ,
}
,
Required: False ,
}
enum ,
leastPrivilegeMode:
{
Description: SQL IaaS Agent least privilege mode. ,
Enum:
{
Enabled: No description available. ,
NotSet: No description available. ,
}
,
Required: False ,
}
enum ,
sqlImageSku:
{
Description: SQL Server edition type. ,
Enum:
{
Developer: No description available. ,
Express: No description available. ,
Standard: No description available. ,
Enterprise: No description available. ,
Web: No description available. ,
}
,
Required: False ,
}
enum ,
sqlVirtualMachineGroupResourceId:
{
Description: ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. ,
Required: False ,
}
string ,
wsfcDomainCredentials:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
{
clusterBootstrapAccountPassword:
{
Description: Cluster bootstrap account password. ,
Required: False ,
}
string ,
clusterOperatorAccountPassword:
{
Description: Cluster operator account password. ,
Required: False ,
}
string ,
sqlServiceAccountPassword:
{
Description: SQL service account password. ,
Required: False ,
}
string ,
}
,
wsfcStaticIp:
{
Description: Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. ,
Required: False ,
}
string ,
autoPatchingSettings:
{
Description: Auto patching settings for applying critical security updates to SQL virtual machine. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autopatching on SQL virtual machine. ,
Required: False ,
}
boolean ,
dayOfWeek:
{
Description: Day of week to apply the patch on. ,
Enum:
{
Everyday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindowStartingHour:
{
Description: Hour of the day when patching is initiated. Local VM time. ,
Format: int32 ,
Required: False ,
}
integer ,
maintenanceWindowDuration:
{
Description: Duration of patching. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalVmPatch:
{
Description: Additional Patch to be enable or enabled on the SQL Virtual Machine. ,
Enum:
{
NotSet: No description available. ,
MicrosoftUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
autoBackupSettings:
{
Description: Auto backup settings for SQL Server. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable autobackup on SQL virtual machine. ,
Required: False ,
}
boolean ,
enableEncryption:
{
Description: Enable or disable encryption for backup on SQL virtual machine. ,
Required: False ,
}
boolean ,
retentionPeriod:
{
Description: Retention period of backup: 1-90 days. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: Storage account url where backup will be taken to. ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage container name where backup will be taken to. ,
Required: False ,
}
string ,
storageAccessKey:
{
Description: Storage account key where backup will be taken to. ,
Required: False ,
}
string ,
password:
{
Description: Password for encryption on backup. ,
Required: False ,
}
string ,
backupSystemDbs:
{
Description: Include or exclude system databases from auto backup. ,
Required: False ,
}
boolean ,
backupScheduleType:
{
Description: Backup schedule type. ,
Enum:
{
Manual: No description available. ,
Automated: No description available. ,
}
,
Required: False ,
}
enum ,
fullBackupFrequency:
{
Description: Frequency of full backups. In both cases, full backups begin during the next scheduled time window. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: False ,
}
enum ,
daysOfWeek:
{
Description: Days of the week for the backups when FullBackupFrequency is set to Weekly. ,
Required: False ,
}
[
string ,
]
,
fullBackupStartTime:
{
Description: Start time of a given day during which full backups can take place. 0-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupWindowHours:
{
Description: Duration of the time window of a given day during which full backups can take place. 1-23 hours. ,
Format: int32 ,
Required: False ,
}
integer ,
logBackupFrequency:
{
Description: Frequency of log backups. 5-60 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
keyVaultCredentialSettings:
{
Description: Key vault credential settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable key vault credential setting. ,
Required: False ,
}
boolean ,
credentialName:
{
Description: Credential name. ,
Required: False ,
}
string ,
azureKeyVaultUrl:
{
Description: Azure Key Vault url. ,
Required: False ,
}
string ,
servicePrincipalName:
{
Description: Service principal name to access key vault. ,
Required: False ,
}
string ,
servicePrincipalSecret:
{
Description: Service principal name secret to access key vault. ,
Required: False ,
}
string ,
}
,
serverConfigurationsManagementSettings:
{
Description: SQL Server configuration management settings. ,
Required: False ,
}
{
sqlConnectivityUpdateSettings:
{
Description: SQL connectivity type settings. ,
Required: False ,
}
{
connectivityType:
{
Description: SQL Server connectivity option. ,
Enum:
{
LOCAL: No description available. ,
PRIVATE: No description available. ,
PUBLIC: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: SQL Server port. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlAuthUpdateUserName:
{
Description: SQL Server sysadmin login to create. ,
Required: False ,
}
string ,
sqlAuthUpdatePassword:
{
Description: SQL Server sysadmin login password. ,
Required: False ,
}
string ,
}
,
sqlWorkloadTypeUpdateSettings:
{
Description: SQL workload type settings. ,
Required: False ,
}
{
sqlWorkloadType:
{
Description: SQL Server workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sqlStorageUpdateSettings:
{
Description: SQL storage update settings. ,
Required: False ,
}
{
diskCount:
{
Description: Virtual machine disk count. ,
Format: int32 ,
Required: False ,
}
integer ,
startingDeviceId:
{
Description: Device id of the first disk to be updated. ,
Format: int32 ,
Required: False ,
}
integer ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
additionalFeaturesServerConfigurations:
{
Description: Additional SQL feature settings. ,
Required: False ,
}
{
isRServicesEnabled:
{
Description: Enable or disable R services (SQL 2016 onwards). ,
Required: False ,
}
boolean ,
}
,
sqlInstanceSettings:
{
Description: SQL Instance settings. ,
Required: False ,
}
{
collation:
{
Description: SQL Server Collation. ,
Required: False ,
}
string ,
maxDop:
{
Description: SQL Server MAXDOP. ,
Format: int32 ,
Required: False ,
}
integer ,
isOptimizeForAdHocWorkloadsEnabled:
{
Description: SQL Server Optimize for Adhoc workloads. ,
Required: False ,
}
boolean ,
minServerMemoryMB:
{
Description: SQL Server minimum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
maxServerMemoryMB:
{
Description: SQL Server maximum memory. ,
Format: int32 ,
Required: False ,
}
integer ,
isLpimEnabled:
{
Description: SQL Server LPIM. ,
Required: False ,
}
boolean ,
isIfiEnabled:
{
Description: SQL Server IFI. ,
Required: False ,
}
boolean ,
}
,
azureAdAuthenticationSettings:
{
Description: Azure AD authentication Settings. ,
Required: False ,
}
{
clientId:
{
Description: The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity ,
Required: False ,
}
string ,
}
,
}
,
storageConfigurationSettings:
{
Description: Storage Configuration Settings. ,
Required: False ,
}
{
sqlDataSettings:
{
Description: SQL Server Data Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlLogSettings:
{
Description: SQL Server Log Storage Settings. ,
Required: False ,
}
{
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlTempDbSettings:
{
Description: SQL Server TempDb Storage Settings. ,
Required: False ,
}
{
dataFileSize:
{
Description: SQL Server tempdb data file size ,
Format: int32 ,
Required: False ,
}
integer ,
dataGrowth:
{
Description: SQL Server tempdb data file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
logFileSize:
{
Description: SQL Server tempdb log file size ,
Format: int32 ,
Required: False ,
}
integer ,
logGrowth:
{
Description: SQL Server tempdb log file autoGrowth size ,
Format: int32 ,
Required: False ,
}
integer ,
dataFileCount:
{
Description: SQL Server tempdb data file count ,
Format: int32 ,
Required: False ,
}
integer ,
persistFolder:
{
Description: SQL Server tempdb persist folder choice ,
Required: False ,
}
boolean ,
persistFolderPath:
{
Description: SQL Server tempdb persist folder location ,
Required: False ,
}
string ,
luns:
{
Description: Logical Unit Numbers for the disks. ,
Required: False ,
}
[
integer ,
]
,
defaultFilePath:
{
Description: SQL Server default file path ,
Required: False ,
}
string ,
useStoragePool:
{
Description: Use storage pool to build a drive if true or not provided ,
Required: False ,
}
boolean ,
}
,
sqlSystemDbOnDataDisk:
{
Description: SQL Server SystemDb Storage on DataPool if true. ,
Required: False ,
}
boolean ,
diskConfigurationType:
{
Description: Disk configuration to apply to SQL Server. ,
Enum:
{
NEW: No description available. ,
EXTEND: No description available. ,
ADD: No description available. ,
}
,
Required: False ,
}
enum ,
storageWorkloadType:
{
Description: Storage workload type. ,
Enum:
{
GENERAL: No description available. ,
OLTP: No description available. ,
DW: No description available. ,
}
,
Required: False ,
}
enum ,
enableStorageConfigBlade:
{
Description: Enable SQL IaaS Agent storage configuration blade in Azure Portal. ,
Required: False ,
}
boolean ,
}
,
troubleshootingStatus:
{
Description: Troubleshooting status ,
Required: False ,
}
{
rootCause:
{
Description: Root cause of the issue ,
Required: False ,
}
string ,
lastTriggerTimeUtc:
{
Description: Last troubleshooting trigger time in UTC timezone ,
Format: date-time ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
troubleshootingScenario:
{
Description: SQL VM troubleshooting scenario. ,
Enum:
{
UnhealthyReplica: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Troubleshooting properties ,
Required: False ,
}
{
unhealthyReplicaInfo:
{
Description: The unhealthy replica information ,
Required: False ,
}
{
availabilityGroupName:
{
Description: The name of the availability group ,
Required: False ,
}
string ,
}
,
}
,
}
,
assessmentSettings:
{
Description: SQL best practices Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable SQL best practices Assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run SQL best practices Assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for SQL best practices Assessment. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment schedule on SQL virtual machine. ,
Required: False ,
}
boolean ,
weeklyInterval:
{
Description: Number of weeks to schedule between 2 assessment runs. Takes value from 1-6 ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyOccurrence:
{
Description: 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 ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week to run assessment. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Time of the day in HH:mm format. Eg. 17:30 ,
Required: False ,
}
string ,
}
,
}
,
enableAutomaticUpgrade:
{
Description: Enable automatic upgrade of Sql IaaS extension Agent. ,
Required: False ,
}
boolean ,
additionalVmPatch:
{
Description: Additional VM Patching solution enabled on the Virtual Machine ,
Enum:
{
WU: No description available. ,
WUMU: No description available. ,
WSUS: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachineIdentitySettings:
{
Description: Virtual Machine Identity details used for Sql IaaS extension configurations. ,
Required: False ,
}
{
type:
{
Description: Identity type of the virtual machine. Specify None to opt-out of Managed Identities. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: ARM Resource Id of the identity. Only required when UserAssigned identity is selected. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
osType:
{
Description: Operating System of the current SQL Virtual Machine. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachines_Delete (updated)
Description :  Deletes a SQL virtual machine.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachines_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "@added_2c1b3f6971cb4ee8aae02d0cfc05a81b": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachines_FetchDCAssessment (updated)
Description :  Starts SQL best practices Assessment with Disk Config rules on SQL virtual machine
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachines_FetchDCAssessment",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "@added_c76b214c5ca74325bbf695c3af5fef91": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/fetchDCAssessment
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Disk Config Assessment property ,
Required: True ,
}
{
runDiskConfigRules:
{
Description: Boolean to run disk config Assessment. Use false to fetch past Assessment. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachines_Redeploy (updated)
Description :  Uninstalls and reinstalls the SQL IaaS Extension.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachines_Redeploy",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "@added_195cd73acc99451f9bddccccf1a106bf": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/redeploy
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachines_StartAssessment (updated)
Description :  Starts SQL best practices Assessment on SQL virtual machine.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachines_StartAssessment",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "@added_fb75e7e5bd3f402189e0397f22069fdd": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/startAssessment
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVirtualMachineTroubleshoot_Troubleshoot (updated)
Description :  Starts SQL virtual machine troubleshooting.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SqlVirtualMachineTroubleshoot_Troubleshoot",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "API version to use for the request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Subscription ID that identifies an Azure subscription."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "@added_83d10a38993f4cb6ac97099e4580f035": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/troubleshoot
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
parameters:
{
Description: The SQL virtual machine troubleshooting entity. ,
Required: True ,
}
{
startTimeUtc:
{
Description: Start time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
troubleshootingScenario:
{
Description: SQL VM troubleshooting scenario. ,
Enum:
{
UnhealthyReplica: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Troubleshooting properties ,
Required: False ,
}
{
unhealthyReplicaInfo:
{
Description: The unhealthy replica information ,
Required: False ,
}
{
availabilityGroupName:
{
Description: The name of the availability group ,
Required: False ,
}
string ,
}
,
}
,
virtualMachineResourceId:
{
Description: Virtual machine resource id for response. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
startTimeUtc:
{
Description: Start time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time in UTC timezone. ,
Format: date-time ,
Required: False ,
}
string ,
troubleshootingScenario:
{
Description: SQL VM troubleshooting scenario. ,
Enum:
{
UnhealthyReplica: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Troubleshooting properties ,
Required: False ,
}
{
unhealthyReplicaInfo:
{
Description: The unhealthy replica information ,
Required: False ,
}
{
availabilityGroupName:
{
Description: The name of the availability group ,
Required: False ,
}
string ,
}
,
}
,
virtualMachineResourceId:
{
Description: Virtual machine resource id for response. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}