ManagedInstance Class

An Azure SQL managed instance.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.mgmt.sql.models._models_py3.TrackedResource
ManagedInstance

Constructor

ManagedInstance(*, location: str, tags: Dict[str, str] | None = None, identity: ResourceIdentity | None = None, sku: Sku | None = None, managed_instance_create_mode: str | ManagedServerCreateMode | None = None, administrator_login: str | None = None, administrator_login_password: str | None = None, subnet_id: str | None = None, license_type: str | ManagedInstanceLicenseType | None = None, v_cores: int | None = None, storage_size_in_gb: int | None = None, collation: str | None = None, dns_zone_partner: str | None = None, public_data_endpoint_enabled: bool | None = None, source_managed_instance_id: str | None = None, restore_point_in_time: datetime | None = None, proxy_override: str | ManagedInstanceProxyOverride | None = None, timezone_id: str | None = None, instance_pool_id: str | None = None, maintenance_configuration_id: str | None = None, minimal_tls_version: str | None = None, storage_account_type: str | StorageAccountType | None = None, zone_redundant: bool | None = None, primary_user_assigned_identity_id: str | None = None, key_id: str | None = None, administrators: ManagedInstanceExternalAdministrator | None = None, **kwargs)

Parameters

Name Description
location
Required
str

Required. Resource location.

tags
Required

A set of tags. Resource tags.

identity
Required

The Azure Active Directory identity of the managed instance.

sku
Required
Sku

Managed instance SKU. Allowed values for sku.name: GP_Gen4, GP_Gen5, BC_Gen4, BC_Gen5.

managed_instance_create_mode
Required

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. Possible values include: "Default", "PointInTimeRestore".

administrator_login
Required
str

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

administrator_login_password
Required
str

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

subnet_id
Required
str

Subnet resource ID for the managed instance.

license_type
Required

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). Possible values include: "LicenseIncluded", "BasePrice".

v_cores
Required
int

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

storage_size_in_gb
Required
int

Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only.

collation
Required
str

Collation of the managed instance.

dns_zone_partner
Required
str

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

public_data_endpoint_enabled
Required

Whether or not the public data endpoint is enabled.

source_managed_instance_id
Required
str

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

restore_point_in_time
Required

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

proxy_override
Required

Connection type used for connecting to the instance. Possible values include: "Proxy", "Redirect", "Default".

timezone_id
Required
str

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

instance_pool_id
Required
str

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

maintenance_configuration_id
Required
str

Specifies maintenance configuration id to apply to this managed instance.

minimal_tls_version
Required
str

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

storage_account_type
Required

The storage account type used to store backups for this instance. The options are LRS (LocallyRedundantStorage), ZRS (ZoneRedundantStorage) and GRS (GeoRedundantStorage). Possible values include: "GRS", "LRS", "ZRS".

zone_redundant
Required

Whether or not the multi-az is enabled.

primary_user_assigned_identity_id
Required
str

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

key_id
Required
str

A CMK URI of the key to use for encryption.

administrators
Required

The Azure Active Directory administrator of the server.

Keyword-Only Parameters

Name Description
location
Required
tags
Required
identity
Required
sku
Required
managed_instance_create_mode
Required
administrator_login
Required
administrator_login_password
Required
subnet_id
Required
license_type
Required
v_cores
Required
storage_size_in_gb
Required
collation
Required
dns_zone_partner
Required
public_data_endpoint_enabled
Required
source_managed_instance_id
Required
restore_point_in_time
Required
proxy_override
Required
timezone_id
Required
instance_pool_id
Required
maintenance_configuration_id
Required
minimal_tls_version
Required
storage_account_type
Required
zone_redundant
Required
primary_user_assigned_identity_id
Required
key_id
Required
administrators
Required

Variables

Name Description
id
str

Resource ID.

name
str

Resource name.

type
str

Resource type.

provisioning_state

Possible values include: "Creating", "Deleting", "Updating", "Unknown", "Succeeded", "Failed".

fully_qualified_domain_name
str

The fully qualified domain name of the managed instance.

state
str

The state of the managed instance.

dns_zone
str

The Dns Zone that the managed instance is in.

private_endpoint_connections

List of private endpoint connections on a managed instance.