Share via


ManagedInstance Class

Definition

An Azure SQL managed instance.

[Microsoft.Rest.Serialization.JsonTransformation]
public class ManagedInstance : Microsoft.Azure.Management.Sql.Models.TrackedResource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type ManagedInstance = class
    inherit TrackedResource
Public Class ManagedInstance
Inherits TrackedResource
Inheritance
ManagedInstance
Attributes

Constructors

ManagedInstance()

Initializes a new instance of the ManagedInstance class.

ManagedInstance(String, String, String, String, IDictionary<String, String>, ResourceIdentity, Sku, String, String, String, String, String, String, String, String, Nullable<Int32>, Nullable<Int32>, String, String, String, Nullable<Boolean>, String, Nullable<DateTime>, String, String, String, String, IList<ManagedInstancePecProperty>, String, String, String, Nullable<Boolean>, String, String, ManagedInstanceExternalAdministrator, ServicePrincipal)

Initializes a new instance of the ManagedInstance class.

Properties

AdministratorLogin

Gets or sets administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).

AdministratorLoginPassword

Gets or sets the administrator login password (required for managed instance creation).

Administrators

Gets or sets the Azure Active Directory administrator of the server.

Collation

Gets or sets collation of the managed instance.

CurrentBackupStorageRedundancy

Gets the storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage). Possible values include: 'Geo', 'Local', 'Zone', 'GeoZone'

DnsZone

Gets the Dns Zone that the managed instance is in.

DnsZonePartner

Gets or sets the resource id of another managed instance whose DNS zone this managed instance will share after creation.

FullyQualifiedDomainName

Gets the fully qualified domain name of the managed instance.

Id

Gets resource ID.

(Inherited from Resource)
Identity

Gets or sets the Azure Active Directory identity of the managed instance.

InstancePoolId

Gets or sets the Id of the instance pool this managed server belongs to.

KeyId

Gets or sets a CMK URI of the key to use for encryption.

LicenseType

Gets or sets 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'

Location

Gets or sets resource location.

(Inherited from TrackedResource)
MaintenanceConfigurationId

Gets or sets specifies maintenance configuration id to apply to this managed instance.

ManagedInstanceCreateMode

Gets or sets 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'

MinimalTlsVersion

Gets or sets minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'

Name

Gets resource name.

(Inherited from Resource)
PrimaryUserAssignedIdentityId

Gets or sets the resource id of a user assigned identity to be used by default.

PrivateEndpointConnections

Gets list of private endpoint connections on a managed instance.

ProvisioningState

Gets possible values include: 'Creating', 'Deleting', 'Updating', 'Unknown', 'Succeeded', 'Failed', 'Accepted', 'Created', 'Deleted', 'Unrecognized', 'Running', 'Canceled', 'NotSpecified', 'Registering', 'TimedOut'

ProxyOverride

Gets or sets connection type used for connecting to the instance. Possible values include: 'Proxy', 'Redirect', 'Default'

PublicDataEndpointEnabled

Gets or sets whether or not the public data endpoint is enabled.

RequestedBackupStorageRedundancy

Gets or sets 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). Possible values include: 'Geo', 'Local', 'Zone', 'GeoZone'

RestorePointInTime

Gets or sets specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

ServicePrincipal

Gets or sets the managed instance's service principal.

Sku

Gets or sets managed instance SKU. Allowed values for sku.name: GP_Gen4, GP_Gen5, BC_Gen4, BC_Gen5

SourceManagedInstanceId

Gets or sets the resource identifier of the source managed instance associated with create operation of this instance.

State

Gets the state of the managed instance.

StorageSizeInGB

Gets or sets storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only.

SubnetId

Gets or sets subnet resource ID for the managed instance.

Tags

Gets or sets resource tags.

(Inherited from TrackedResource)
TimezoneId

Gets or sets 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".

Type

Gets resource type.

(Inherited from Resource)
VCores

Gets or sets the number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.

ZoneRedundant

Gets or sets whether or not the multi-az is enabled.

Methods

Validate()

Validate the object.

Applies to