Microsoft.SqlVirtualMachine (preview:2022-07-01)

2025/09/05 • 20 new, 20 deleted methods

AvailabilityGroupListeners_Get (new)
Description :  Gets an availability group listener.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
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 ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
AvailabilityGroupListeners_CreateOrUpdate (new)
Description :  Creates or updates an availability group listener.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
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 ,
}
,
]
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}

⚐ Response (201)

{
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 ,
}
,
]
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
AvailabilityGroupListeners_Delete (new)
Description :  Deletes an availability group listener.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
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 ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
AvailabilityGroupListeners_ListByGroup (new)
Description :  Lists all availability group listeners in a SQL virtual machine group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object. ,
Required: False ,
}
string ,
display:
{
Description: The localized display information for this particular operation / action. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name. ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly form of the resource type related to this action/operation. ,
Required: False ,
}
string ,
operation:
{
Description: The localized friendly name for the operation. ,
Required: False ,
}
string ,
description:
{
Description: The localized friendly description for the operation. ,
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: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SqlVirtualMachineGroups_Get (new)
Description :  Gets a SQL virtual machine group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
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 ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
SqlVirtualMachineGroups_CreateOrUpdate (new)
Description :  Creates or updates a SQL virtual machine group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
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 ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
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 ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}

⚐ Response (201)

{
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 ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
SqlVirtualMachineGroups_Delete (new)
Description :  Deletes a SQL virtual machine group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
SqlVirtualMachineGroups_Update (new)
Description :  Updates SQL virtual machine group tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
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 ,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
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 ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
SqlVirtualMachineGroups_ListByResourceGroup (new)
Description :  Gets all SQL virtual machine groups in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
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 ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SqlVirtualMachineGroups_List (new)
Description :  Gets all SQL virtual machine groups in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups
{
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
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 ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SqlVirtualMachines_ListBySqlVmGroup (new)
Description :  Gets the list of sql virtual machines in a SQL virtual machine group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/sqlVirtualMachines
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SqlVirtualMachines_List (new)
Description :  Gets all SQL virtual machines in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines
{
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SqlVirtualMachines_StartAssessment (new)
Description :  Starts Assessment on SQL virtual machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/startAssessment
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{}
SqlVirtualMachines_Redeploy (new)
Description :  Uninstalls and reinstalls the SQL Iaas Extension.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/redeploy
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{}
SqlVirtualMachines_Get (new)
Description :  Gets a SQL virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
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 ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
SqlVirtualMachines_CreateOrUpdate (new)
Description :  Creates or updates a SQL virtual machine.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
parameters:
{
Description: The SQL virtual machine. ,
Required: True ,
}
{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}

⚐ Response (201)

{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
SqlVirtualMachines_Delete (new)
Description :  Deletes a SQL virtual machine.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
SqlVirtualMachines_Update (new)
Description :  Updates a SQL virtual machine.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
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 ,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
SqlVirtualMachines_ListByResourceGroup (new)
Description :  Gets all SQL virtual machines in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
AvailabilityGroupListeners_Get (removed)
Description :  Gets an availability group listener.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
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 ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
AvailabilityGroupListeners_CreateOrUpdate (removed)
Description :  Creates or updates an availability group listener.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
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 ,
}
,
]
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}

⚐ Response (201)

{
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 ,
}
,
]
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
AvailabilityGroupListeners_Delete (removed)
Description :  Deletes an availability group listener.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
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 ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
AvailabilityGroupListeners_ListByGroup (removed)
Description :  Lists all availability group listeners in a SQL virtual machine group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object. ,
Required: False ,
}
string ,
display:
{
Description: The localized display information for this particular operation / action. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name. ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly form of the resource type related to this action/operation. ,
Required: False ,
}
string ,
operation:
{
Description: The localized friendly name for the operation. ,
Required: False ,
}
string ,
description:
{
Description: The localized friendly description for the operation. ,
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: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SqlVirtualMachineGroups_Get (removed)
Description :  Gets a SQL virtual machine group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
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 ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
SqlVirtualMachineGroups_CreateOrUpdate (removed)
Description :  Creates or updates a SQL virtual machine group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
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 ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
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 ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}

⚐ Response (201)

{
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 ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
SqlVirtualMachineGroups_Delete (removed)
Description :  Deletes a SQL virtual machine group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
SqlVirtualMachineGroups_Update (removed)
Description :  Updates SQL virtual machine group tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
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 ,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
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 ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
SqlVirtualMachineGroups_ListByResourceGroup (removed)
Description :  Gets all SQL virtual machine groups in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
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 ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SqlVirtualMachineGroups_List (removed)
Description :  Gets all SQL virtual machine groups in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups
{
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
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 ,
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 ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SqlVirtualMachines_ListBySqlVmGroup (removed)
Description :  Gets the list of sql virtual machines in a SQL virtual machine group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/sqlVirtualMachines
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineGroupName:
{
Description: Name of the SQL virtual machine group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SqlVirtualMachines_List (removed)
Description :  Gets all SQL virtual machines in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines
{
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}
SqlVirtualMachines_StartAssessment (removed)
Description :  Starts Assessment on SQL virtual machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/startAssessment
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{}
SqlVirtualMachines_Redeploy (removed)
Description :  Uninstalls and reinstalls the SQL Iaas Extension.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/redeploy
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{}
SqlVirtualMachines_Get (removed)
Description :  Gets a SQL virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
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 ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
SqlVirtualMachines_CreateOrUpdate (removed)
Description :  Creates or updates a SQL virtual machine.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
parameters:
{
Description: The SQL virtual machine. ,
Required: True ,
}
{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}

⚐ Response (201)

{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
SqlVirtualMachines_Delete (removed)
Description :  Deletes a SQL virtual machine.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
sqlVirtualMachineName:
{
Description: Name of the SQL virtual machine. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
SqlVirtualMachines_Update (removed)
Description :  Updates a SQL virtual machine.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
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 ,
}
,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{}
SqlVirtualMachines_ListByResourceGroup (removed)
Description :  Gets all SQL virtual machines in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines
{
resourceGroupName:
{
Description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
identity:
{
Description: 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. ,
}
,
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. ,
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 ,
}
,
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 ,
}
,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
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 ,
}
,
assessmentSettings:
{
Description: Assessment Settings. ,
Required: False ,
}
{
enable:
{
Description: Enable or disable assessment feature on SQL virtual machine. ,
Required: False ,
}
boolean ,
runImmediately:
{
Description: Run assessment immediately on SQL virtual machine. ,
Required: False ,
}
boolean ,
schedule:
{
Description: Schedule for 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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{}