ManagedInstance interface

Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).

administratorLogin?: string

Property Value

The administrator login password (required for managed instance creation).

administratorLoginPassword?: string

Property Value

The Azure Active Directory administrator can be utilized during instance creation and for instance updates, except for the azureADOnlyAuthentication property. To update the azureADOnlyAuthentication property, individual API must be used.

administrators?: ManagedInstanceExternalAdministrator

Property Value

The managed instance's authentication metadata lookup mode.

authenticationMetadata?: string

Property Value

Collation of the managed instance.

collation?: string

Property Value

Specifies the point in time (ISO8601 format) of the Managed Instance creation.

createTime?: Date

Property Value

The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage)

currentBackupStorageRedundancy?: string

Property Value

Specifies the internal format of instance databases specific to the SQL engine version.

databaseFormat?: string

Property Value

The Dns Zone that the managed instance is in.

dnsZone?: string

Property Value

The resource id of another managed instance whose DNS zone this managed instance will share after creation.

dnsZonePartner?: string

Property Value

Status of external governance.

externalGovernanceStatus?: string

Property Value

The fully qualified domain name of the managed instance.

fullyQualifiedDomainName?: string

Property Value

Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR).

hybridSecondaryUsage?: string

Property Value

Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR).

hybridSecondaryUsageDetected?: string

Property Value

The Azure Active Directory identity of the managed instance.

identity?: ResourceIdentity

Property Value

The Id of the instance pool this managed server belongs to.

instancePoolId?: string

Property Value

Whether or not this is a GPv2 variant of General Purpose edition.

isGeneralPurposeV2?: boolean

Property Value

A CMK URI of the key to use for encryption.

keyId?: string

Property Value

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).

licenseType?: string

Property Value

Specifies maintenance configuration id to apply to this managed instance.

maintenanceConfigurationId?: string

Property Value

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.

managedInstanceCreateMode?: string

Property Value

Memory size in GB. Minimum value: 28. Maximum value: 870. Minimum and maximum value depend on the number of vCores and service tier. Read more about resource limits: https://aka.ms/mi-resource-limits-api.

memorySizeInGB?: number

Property Value

Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'

minimalTlsVersion?: string

Property Value

Pricing model of Managed Instance.

pricingModel?: string

Property Value

The resource id of a user assigned identity to be used by default.

primaryUserAssignedIdentityId?: string

Property Value

List of private endpoint connections on a managed instance.

privateEndpointConnections?: ManagedInstancePecProperty[]

Property Value

Provisioning state of managed instance.

provisioningState?: string

Property Value

Connection type used for connecting to the instance.

proxyOverride?: string

Property Value

Whether or not the public data endpoint is enabled.

publicDataEndpointEnabled?: boolean

Property Value

The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage)

requestedBackupStorageRedundancy?: string

Property Value

Specifies the logical availability zone Managed Instance is pinned to.

requestedLogicalAvailabilityZone?: string

Property Value

Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

restorePointInTime?: Date

Property Value

The managed instance's service principal.

servicePrincipal?: ServicePrincipal

Property Value

Managed instance SKU. Allowed values for sku.name: GP_Gen5 (General Purpose, Standard-series); GP_G8IM (General Purpose, Premium-series); GP_G8IH (General Purpose, Premium-series memory optimized); BC_Gen5 (Business Critical, Standard-Series); BC_G8IM (Business Critical, Premium-series); BC_G8IH (Business Critical, Premium-series memory optimized).

sku?: Sku

Property Value

The resource identifier of the source managed instance associated with create operation of this instance.

sourceManagedInstanceId?: string

Property Value

The state of the managed instance.

state?: string

Property Value

Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores.

storageIOps?: number

Property Value

Storage size in GB. Minimum value: 32. Maximum value: 32768. Increments of 32 GB allowed only. Maximum value depends on the selected hardware family and number of vCores.

storageSizeInGB?: number

Property Value

Storage throughput MBps parameter is not supported in the instance create/update operation.

storageThroughputMBps?: number

Property Value

Subnet resource ID for the managed instance.

subnetId?: string

Property Value

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".

timezoneId?: string

Property Value

The number of vCores. Allowed values: 4, 6, 8, 10, 12, 16, 20, 24, 32, 40, 48, 56, 64, 80, 96, 128. Supported vCores depends on the selected hardware family and service tier.

vCores?: number

Property Value

Virtual cluster resource id for the Managed Instance.

virtualClusterId?: string

Property Value

Whether or not the zone-redundancy is enabled.

zoneRedundant?: boolean

Property Value

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

Inherited From TrackedResource.id

The geo-location where the resource lives

location: string

Property Value

Inherited From TrackedResource.location

The name of the resource

name?: string

Property Value

Inherited From TrackedResource.name

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From TrackedResource.systemData

Resource tags.

tags?: Record<string, string>

Property Value

Inherited From TrackedResource.tags

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

Inherited From TrackedResource.type