Share via

ManagedInstance interface

  • Reference
Package:
@azure/arm-sql

An Azure SQL managed instance.

Extends
TrackedResource

Properties

administratorLogin

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

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

The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used.
collation

Collation of the managed instance.
currentBackupStorageRedundancy

The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) NOTE: This property will not be serialized. It can only be populated by the server.
dnsZone

The Dns Zone that the managed instance is in. NOTE: This property will not be serialized. It can only be populated by the server.
dnsZonePartner

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

The fully qualified domain name of the managed instance. NOTE: This property will not be serialized. It can only be populated by the server.
identity

The Azure Active Directory identity of the managed instance.
instancePoolId

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

A CMK URI of the key to use for encryption.
licenseType

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

Specifies maintenance configuration id to apply to this managed instance.
managedInstanceCreateMode

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

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

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

List of private endpoint connections on a managed instance. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

NOTE: This property will not be serialized. It can only be populated by the server.
proxyOverride

Connection type used for connecting to the instance.
publicDataEndpointEnabled

Whether or not the public data endpoint is enabled.
requestedBackupStorageRedundancy

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

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

The managed instance's service principal.
sku

Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
sourceManagedInstanceId

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

The state of the managed instance. NOTE: This property will not be serialized. It can only be populated by the server.
storageSizeInGB

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

Subnet resource ID for the managed instance.
timezoneId

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

The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
zoneRedundant

Whether or not the multi-az is enabled.

Inherited Properties

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
location

Resource location.
name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

administratorLogin

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

string

administratorLoginPassword

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

administratorLoginPassword?: string

Property Value

string

administrators

The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used.

administrators?: ManagedInstanceExternalAdministrator

Property Value

ManagedInstanceExternalAdministrator

collation

Collation of the managed instance.

collation?: string

Property Value

string

currentBackupStorageRedundancy

The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) NOTE: This property will not be serialized. It can only be populated by the server.

currentBackupStorageRedundancy?: string

Property Value

string

dnsZone

The Dns Zone that the managed instance is in. NOTE: This property will not be serialized. It can only be populated by the server.

dnsZone?: string

Property Value

string

dnsZonePartner

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

dnsZonePartner?: string

Property Value

string

fullyQualifiedDomainName

The fully qualified domain name of the managed instance. NOTE: This property will not be serialized. It can only be populated by the server.

fullyQualifiedDomainName?: string

Property Value

string

identity

The Azure Active Directory identity of the managed instance.

identity?: ResourceIdentity

Property Value

ResourceIdentity

instancePoolId

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

instancePoolId?: string

Property Value

string

keyId

A CMK URI of the key to use for encryption.

keyId?: string

Property Value

string

licenseType

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

string

maintenanceConfigurationId

Specifies maintenance configuration id to apply to this managed instance.

maintenanceConfigurationId?: string

Property Value

string

managedInstanceCreateMode

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

string

minimalTlsVersion

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

minimalTlsVersion?: string

Property Value

string

primaryUserAssignedIdentityId

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

primaryUserAssignedIdentityId?: string

Property Value

string

privateEndpointConnections

List of private endpoint connections on a managed instance. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: ManagedInstancePecProperty[]

Property Value

ManagedInstancePecProperty[]

provisioningState

NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

proxyOverride

Connection type used for connecting to the instance.

proxyOverride?: string

Property Value

string

publicDataEndpointEnabled

Whether or not the public data endpoint is enabled.

publicDataEndpointEnabled?: boolean

Property Value

boolean

requestedBackupStorageRedundancy

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

string

restorePointInTime

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

restorePointInTime?: Date

Property Value

Date

servicePrincipal

The managed instance's service principal.

servicePrincipal?: ServicePrincipal

Property Value

ServicePrincipal

sku

Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH

sku?: Sku

Property Value

Sku

sourceManagedInstanceId

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

sourceManagedInstanceId?: string

Property Value

string

state

The state of the managed instance. NOTE: This property will not be serialized. It can only be populated by the server.

state?: string

Property Value

string

storageSizeInGB

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

storageSizeInGB?: number

Property Value

number

subnetId

Subnet resource ID for the managed instance.

subnetId?: string

Property Value

string

timezoneId

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

string

vCores

The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.

vCores?: number

Property Value

number

zoneRedundant

Whether or not the multi-az is enabled.

zoneRedundant?: boolean

Property Value

boolean

Inherited Property Details

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

Resource location.

location: string

Property Value

string

Inherited From TrackedResource.location

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type