Share via

ManagedInstanceUpdate interface

Package:
@azure/arm-sql

An update request for an Azure SQL Database managed instance.

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

The managed instance's authentication metadata lookup mode.
collation

Collation of the managed instance.
createTime

Specifies the point in time (ISO8601 format) of the Managed Instance creation. NOTE: This property will not be serialized. It can only be populated by the server.
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.
databaseFormat

Specifies the internal format of instance databases specific to the SQL engine version.
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.
externalGovernanceStatus

Status of external governance. NOTE: This property will not be serialized. It can only be populated by the server.
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.
hybridSecondaryUsage

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

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). NOTE: This property will not be serialized. It can only be populated by the server.
identity

Managed instance identity
instancePoolId

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

Whether or not this is a GPv2 variant of General Purpose edition.
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'
pricingModel

Weather or not Managed Instance is freemium.
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

Provisioning state of managed instance. 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
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.
storageIOps

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

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

Subnet resource ID for the managed instance.
tags

Resource tags.
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.
virtualClusterId

Virtual cluster resource id for the Managed Instance. NOTE: This property will not be serialized. It can only be populated by the server.
zoneRedundant

Whether or not the multi-az is enabled.

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

authenticationMetadata

The managed instance's authentication metadata lookup mode.

authenticationMetadata?: string

Property Value

string

collation

Collation of the managed instance.

collation?: string

Property Value

string

createTime

Specifies the point in time (ISO8601 format) of the Managed Instance creation. NOTE: This property will not be serialized. It can only be populated by the server.

createTime?: Date

Property Value

Date

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

databaseFormat

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

databaseFormat?: 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

externalGovernanceStatus

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

externalGovernanceStatus?: 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

hybridSecondaryUsage

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

hybridSecondaryUsage?: string

Property Value

string

hybridSecondaryUsageDetected

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). NOTE: This property will not be serialized. It can only be populated by the server.

hybridSecondaryUsageDetected?: string

Property Value

string

identity

Managed instance identity

identity?: ResourceIdentity

Property Value

ResourceIdentity

instancePoolId

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

instancePoolId?: string

Property Value

string

isGeneralPurposeV2

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

isGeneralPurposeV2?: boolean

Property Value

boolean

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

pricingModel

Weather or not Managed Instance is freemium.

pricingModel?: 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

Provisioning state of managed instance. 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

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

storageIOps

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

number

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

storageThroughputMBps

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

storageThroughputMBps?: number

Property Value

number

subnetId

Subnet resource ID for the managed instance.

subnetId?: string

Property Value

string

tags

Resource tags.

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

Property Value

{[propertyName: string]: 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

virtualClusterId

Virtual cluster resource id for the Managed Instance. NOTE: This property will not be serialized. It can only be populated by the server.

virtualClusterId?: string

Property Value

string

zoneRedundant

Whether or not the multi-az is enabled.

zoneRedundant?: boolean

Property Value

boolean