Class ManagedInstance

An Azure SQL managed instance.

Inheritance
Object
Resource
TrackedResource
ManagedInstance
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Microsoft.Azure.Management.Sql.dll
Syntax
[Microsoft.Rest.Serialization.JsonTransformation]
public class ManagedInstance : Microsoft.Azure.Management.Sql.Models.TrackedResource

Constructors

ManagedInstance()

Initializes a new instance of the ManagedInstance class.

Declaration
public ManagedInstance ();

ManagedInstance(String, String, String, String, IDictionary<String,String>, ResourceIdentity, Sku, String, String, String, String, String, String, String, Nullable<Int32>, Nullable<Int32>, String, String, String, Nullable<Boolean>, String, Nullable<DateTime>, String, String, String)

Initializes a new instance of the ManagedInstance class.

Declaration
public ManagedInstance (string location, string id = null, string name = null, string type = null, System.Collections.Generic.IDictionary<string,string> tags = null, Microsoft.Azure.Management.Sql.Models.ResourceIdentity identity = null, Microsoft.Azure.Management.Sql.Models.Sku sku = null, string managedInstanceCreateMode = null, string fullyQualifiedDomainName = null, string administratorLogin = null, string administratorLoginPassword = null, string subnetId = null, string state = null, string licenseType = null, Nullable<int> vCores = null, Nullable<int> storageSizeInGB = null, string collation = null, string dnsZone = null, string dnsZonePartner = null, Nullable<bool> publicDataEndpointEnabled = null, string sourceManagedInstanceId = null, Nullable<DateTime> restorePointInTime = null, string proxyOverride = null, string timezoneId = null, string instancePoolId = null);
Parameters
String location

Resource location.
String id

Resource ID.
String name

Resource name.
String type

Resource type.
IDictionary<String,String> tags

Resource tags.
ResourceIdentity identity

The Azure Active Directory identity of the managed instance.
Sku sku

Managed instance SKU. Allowed values for sku.name: GP_Gen4, GP_Gen5, BC_Gen4, BC_Gen5
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. Possible values include:
         'Default', 'PointInTimeRestore'

String fullyQualifiedDomainName

The fully qualified domain name of the managed instance.
String administratorLogin

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

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

Subnet resource ID for the managed instance.
String state

The state of the managed instance.
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). Possible values include: 'LicenseIncluded', 'BasePrice'
Nullable<Int32> vCores

The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
Nullable<Int32> storageSizeInGB

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

Collation of the managed instance.
String dnsZone

The Dns Zone that the managed instance is in.
String dnsZonePartner

The resource id of another managed instance whose DNS zone this managed instance will share after creation.
Nullable<Boolean> publicDataEndpointEnabled

Whether or not the public data endpoint is enabled.
String sourceManagedInstanceId

The resource identifier of the source managed instance associated with create operation of this instance.
Nullable<DateTime> restorePointInTime

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

Connection type used for connecting to the instance. Possible values include: 'Proxy', 'Redirect', 'Default'
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".
String instancePoolId

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

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

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.administratorLogin")]
public string AdministratorLogin { get; set; }
Property Value
String

AdministratorLoginPassword

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

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.administratorLoginPassword")]
public string AdministratorLoginPassword { get; set; }
Property Value
String

Collation

Gets or sets collation of the managed instance.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.collation")]
public string Collation { get; set; }
Property Value
String

DnsZone

Gets the Dns Zone that the managed instance is in.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.dnsZone")]
public string DnsZone { get; }
Property Value
String

DnsZonePartner

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

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.dnsZonePartner")]
public string DnsZonePartner { get; set; }
Property Value
String

FullyQualifiedDomainName

Gets the fully qualified domain name of the managed instance.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.fullyQualifiedDomainName")]
public string FullyQualifiedDomainName { get; }
Property Value
String

Identity

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

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="identity")]
public Microsoft.Azure.Management.Sql.Models.ResourceIdentity Identity { get; set; }
Property Value
ResourceIdentity

InstancePoolId

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

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.instancePoolId")]
public string InstancePoolId { get; set; }
Property Value
String

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'

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.licenseType")]
public string LicenseType { get; set; }
Property Value
String

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'

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.managedInstanceCreateMode")]
public string ManagedInstanceCreateMode { get; set; }
Property Value
String

ProxyOverride

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

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.proxyOverride")]
public string ProxyOverride { get; set; }
Property Value
String

PublicDataEndpointEnabled

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

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.publicDataEndpointEnabled")]
public Nullable<bool> PublicDataEndpointEnabled { get; set; }
Property Value
Nullable<Boolean>

RestorePointInTime

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

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.restorePointInTime")]
public Nullable<DateTime> RestorePointInTime { get; set; }
Property Value
Nullable<DateTime>

Sku

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

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="sku")]
public Microsoft.Azure.Management.Sql.Models.Sku Sku { get; set; }
Property Value
Sku

SourceManagedInstanceId

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

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.sourceManagedInstanceId")]
public string SourceManagedInstanceId { get; set; }
Property Value
String

State

Gets the state of the managed instance.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.state")]
public string State { get; }
Property Value
String

StorageSizeInGB

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

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.storageSizeInGB")]
public Nullable<int> StorageSizeInGB { get; set; }
Property Value
Nullable<Int32>

SubnetId

Gets or sets subnet resource ID for the managed instance.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.subnetId")]
public string SubnetId { get; set; }
Property Value
String

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

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.timezoneId")]
public string TimezoneId { get; set; }
Property Value
String

VCores

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

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.vCores")]
public Nullable<int> VCores { get; set; }
Property Value
Nullable<Int32>

Methods

Validate()

Validate the object.

Declaration
public override void Validate ();
Exceptions
ValidationException

Thrown if validation fails