Microsoft.Sql managedInstances template reference

Template format

To create a Microsoft.Sql/managedInstances resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Sql/managedInstances",
  "apiVersion": "2018-06-01-preview",
  "location": "string",
  "tags": {},
  "identity": {
    "type": "SystemAssigned"
  },
  "sku": {
    "name": "string",
    "tier": "string",
    "size": "string",
    "family": "string",
    "capacity": "integer"
  },
  "properties": {
    "managedInstanceCreateMode": "string",
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "subnetId": "string",
    "licenseType": "string",
    "vCores": "integer",
    "storageSizeInGB": "integer",
    "collation": "string",
    "dnsZonePartner": "string",
    "publicDataEndpointEnabled": "boolean",
    "sourceManagedInstanceId": "string",
    "restorePointInTime": "string",
    "proxyOverride": "string",
    "timezoneId": "string",
    "instancePoolId": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Sql/managedInstances object

Name Type Required Value
name string Yes The name of the managed instance.
type enum Yes Microsoft.Sql/managedInstances
apiVersion enum Yes 2018-06-01-preview
location string Yes Resource location.
tags object No Resource tags.
identity object No The Azure Active Directory identity of the managed instance. - ResourceIdentity object
sku object No Managed instance SKU. Allowed values for sku.name: GP_Gen4, GP_Gen5, BC_Gen4, BC_Gen5 - Sku object
properties object Yes Resource properties. - ManagedInstanceProperties object

ResourceIdentity object

Name Type Required Value
type enum No The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. - SystemAssigned

Sku object

Name Type Required Value
name string Yes The name of the SKU, typically, a letter + Number code, e.g. P3.
tier string No The tier or edition of the particular SKU, e.g. Basic, Premium.
size string No Size of the particular SKU
family string No If the service has different generations of hardware, for the same SKU, then that can be captured here.
capacity integer No Capacity of the particular SKU.

ManagedInstanceProperties object

Name Type Required Value
managedInstanceCreateMode enum No Specifies the mode of database creation.

Default: Regular instance creation.

Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. - Default or PointInTimeRestore
administratorLogin string No Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).
administratorLoginPassword string No The administrator login password (required for managed instance creation).
subnetId string No Subnet resource ID for the managed instance.
licenseType enum No The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). - LicenseIncluded or BasePrice
vCores integer No The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
storageSizeInGB integer No Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only.
collation string No Collation of the managed instance.
dnsZonePartner string No The resource id of another managed instance whose DNS zone this managed instance will share after creation.
publicDataEndpointEnabled boolean No Whether or not the public data endpoint is enabled.
sourceManagedInstanceId string No The resource identifier of the source managed instance associated with create operation of this instance.
restorePointInTime string No Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
proxyOverride enum No Connection type used for connecting to the instance. - Proxy, Redirect, Default
timezoneId string No Id of the timezone. Allowed values are timezones supported by Windows.
Windows keeps details on supported timezones, including the id, in registry under
KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones.
You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info.
List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell.
An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time".
instancePoolId string No The Id of the instance pool this managed server belongs to.

Quickstart templates

The following quickstart templates deploy this resource type.