Skip to main content

azSqlInstance

Deploy an Azure SQL Managed Instance to the relevant subscription.

Warning: This operation may take several hours.

Attributes

AttributeTypeMandatoryValuesDefaultNotes
NameString
ResourceGroupNameString
LocationString
SubnetNameString
BackupStorageRedundancyString
StorageSizeInGBString
CollationString
ZoneRedundantString
AdminUsernameString
AdminPasswordObject
EnableADOnlyAuthBoolean
InstancePoolNameString
LicenseTypeStringBasePrice, LicenseIncluded
VCoreNumberMinimum 8
EditionStringGeneralPurpose
Hyperscale
BusinessCritical
ComputeGenerationStringGen5, FSv2, DC, M
TagObjectNo
LockObjectNo

Input by YAML

Object model for YAML deployment:

---
azSqlInstance:
# Mandatory
- Name: 'string'
ResourceGroupName: 'string'
Location: 'string'
SubnetName: 'string'
#Optional
BackupStorageRedundancy: 'string' # Local, Zone (D) or Geo
StorageSizeInGB: number
Collation: 'string'
ZoneRedundant: 'string'

AdminUsername: 'string'
AdminPassword: 'string'
EnableADOnlyAuth: 'string' # False (D), True
InstancePoolName: 'string'

# Following attributes must be supplied if not in a pool
LicenseType: 'string' # Ignored if pool specified, values BasePrice, LicenseIncluded
VCore: number # Ignored if pool specified
Edition: 'string' # Ignored if pool specified, GeneralPurpose, Hyperscale, BusinessCritical
ComputeGeneration: 'string' # Ignored if pool specified, values Gen5 (D), FSv2-series, DC-series, M-series

Tag:
'keyvalue-pairs'
Lock:
- Name: 'string'
Level: 'string' # CanNotDelete, ReadOnly
Notes: 'string'

Input by JSON

Object model for JSON deployment:

{
"azSqlInstancePool": [
{
"Name": "string",
"ResourceGroupName": "string",
"Location": "string",
"SubnetName": "string",
"BackupStorageRedundancy": "string",
"StorageSizeInGB": number,
"Collation": "string",
"SubnetName": "string",
"ZoneRedundant": "string",

"AdminUsername": "string",
"AdminPassword": "string",
"EnableADOnlyAuth": boolean,
"InstancePoolName": "string",

"LicenseType": "string",
"Edition": "string",
"VCore": number,
"ComputeGeneration": "string",

"Tag": {
"key": "value"
},
"Lock": [
{
"Name": "string",
"Level": "string",
"Notes": "string"
}
]
}
]
}