Package version:

Interface ManagedInstanceUpdate

An update request for an Azure SQL Database managed instance.

Hierarchy

  • ManagedInstanceUpdate

Properties

administratorLogin?: string

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

administratorLoginPassword?: string

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

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

Collation of the managed instance.

currentBackupStorageRedundancy?: string

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

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

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

fullyQualifiedDomainName?: string

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

Managed instance identity

instancePoolId?: string

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

keyId?: string

A CMK URI of the key to use for encryption.

licenseType?: string

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

Specifies maintenance configuration id to apply to this managed instance.

managedInstanceCreateMode?: string

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

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

primaryUserAssignedIdentityId?: string

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

privateEndpointConnections?: ManagedInstancePecProperty[]

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

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

proxyOverride?: string

Connection type used for connecting to the instance.

publicDataEndpointEnabled?: boolean

Whether or not the public data endpoint is enabled.

requestedBackupStorageRedundancy?: string

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

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

servicePrincipal?: ServicePrincipal

The managed instance's service principal.

sku?: Sku

Managed instance sku

sourceManagedInstanceId?: string

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

state?: string

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

storageSizeInGB?: number

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

Subnet resource ID for the managed instance.

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

Resource tags.

Type declaration

  • [propertyName: string]: string
timezoneId?: string

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

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

zoneRedundant?: boolean

Whether or not the multi-az is enabled.

Generated using TypeDoc