ManagedInstanceInner Class

public final class ManagedInstanceInner
extends Resource

An Azure SQL managed instance.

Constructor Summary

Constructor Description
ManagedInstanceInner()

Creates an instance of ManagedInstanceInner class.

Method Summary

Modifier and Type Method and Description
String administratorLogin()

Get the administratorLogin property: Administrator username for the managed instance.

String administratorLoginPassword()

Get the administratorLoginPassword property: The administrator login password (required for managed instance creation).

ManagedInstanceExternalAdministrator administrators()

Get the administrators property: The Azure Active Directory administrator of the server.

String collation()

Get the collation property: Collation of the managed instance.

BackupStorageRedundancy currentBackupStorageRedundancy()

Get the currentBackupStorageRedundancy property: The storage account type used to store backups for this instance.

String dnsZone()

Get the dnsZone property: The Dns Zone that the managed instance is in.

String dnsZonePartner()

Get the dnsZonePartner property: The resource id of another managed instance whose DNS zone this managed instance will share after creation.

static ManagedInstanceInner fromJson(JsonReader jsonReader)

Reads an instance of ManagedInstanceInner from the JsonReader.

String fullyQualifiedDomainName()

Get the fullyQualifiedDomainName property: The fully qualified domain name of the managed instance.

String id()

Get the id property: Fully qualified resource Id for the resource.

ResourceIdentity identity()

Get the identity property: The Azure Active Directory identity of the managed instance.

String instancePoolId()

Get the instancePoolId property: The Id of the instance pool this managed server belongs to.

String keyId()

Get the keyId property: A CMK URI of the key to use for encryption.

ManagedInstanceLicenseType licenseType()

Get the licenseType property: The license type.

String maintenanceConfigurationId()

Get the maintenanceConfigurationId property: Specifies maintenance configuration id to apply to this managed instance.

ManagedServerCreateMode managedInstanceCreateMode()

Get the managedInstanceCreateMode property: Specifies the mode of database creation.

String minimalTlsVersion()

Get the minimalTlsVersion property: Minimal TLS version.

String name()

Get the name property: The name of the resource.

String primaryUserAssignedIdentityId()

Get the primaryUserAssignedIdentityId property: The resource id of a user assigned identity to be used by default.

List<ManagedInstancePecProperty> privateEndpointConnections()

Get the privateEndpointConnections property: List of private endpoint connections on a managed instance.

ManagedInstancePropertiesProvisioningState provisioningState()

Get the provisioningState property: The provisioningState property.

ManagedInstanceProxyOverride proxyOverride()

Get the proxyOverride property: Connection type used for connecting to the instance.

Boolean publicDataEndpointEnabled()

Get the publicDataEndpointEnabled property: Whether or not the public data endpoint is enabled.

BackupStorageRedundancy requestedBackupStorageRedundancy()

Get the requestedBackupStorageRedundancy property: The storage account type to be used to store backups for this instance.

OffsetDateTime restorePointInTime()

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

ServicePrincipal servicePrincipal()

Get the servicePrincipal property: The managed instance's service principal.

Sku sku()

Get the sku property: Managed instance SKU.

String sourceManagedInstanceId()

Get the sourceManagedInstanceId property: The resource identifier of the source managed instance associated with create operation of this instance.

String state()

Get the state property: The state of the managed instance.

Integer storageSizeInGB()

Get the storageSizeInGB property: Storage size in GB.

String subnetId()

Get the subnetId property: Subnet resource ID for the managed instance.

String timezoneId()

Get the timezoneId property: Id of the timezone.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.

Integer vCores()

Get the vCores property: The number of vCores.

void validate()

Validates the instance.

ManagedInstanceInner withAdministratorLogin(String administratorLogin)

Set the administratorLogin property: Administrator username for the managed instance.

ManagedInstanceInner withAdministratorLoginPassword(String administratorLoginPassword)

Set the administratorLoginPassword property: The administrator login password (required for managed instance creation).

ManagedInstanceInner withAdministrators(ManagedInstanceExternalAdministrator administrators)

Set the administrators property: The Azure Active Directory administrator of the server.

ManagedInstanceInner withCollation(String collation)

Set the collation property: Collation of the managed instance.

ManagedInstanceInner withDnsZonePartner(String dnsZonePartner)

Set the dnsZonePartner property: The resource id of another managed instance whose DNS zone this managed instance will share after creation.

ManagedInstanceInner withIdentity(ResourceIdentity identity)

Set the identity property: The Azure Active Directory identity of the managed instance.

ManagedInstanceInner withInstancePoolId(String instancePoolId)

Set the instancePoolId property: The Id of the instance pool this managed server belongs to.

ManagedInstanceInner withKeyId(String keyId)

Set the keyId property: A CMK URI of the key to use for encryption.

ManagedInstanceInner withLicenseType(ManagedInstanceLicenseType licenseType)

Set the licenseType property: The license type.

ManagedInstanceInner withLocation(String location)
ManagedInstanceInner withMaintenanceConfigurationId(String maintenanceConfigurationId)

Set the maintenanceConfigurationId property: Specifies maintenance configuration id to apply to this managed instance.

ManagedInstanceInner withManagedInstanceCreateMode(ManagedServerCreateMode managedInstanceCreateMode)

Set the managedInstanceCreateMode property: Specifies the mode of database creation.

ManagedInstanceInner withMinimalTlsVersion(String minimalTlsVersion)

Set the minimalTlsVersion property: Minimal TLS version.

ManagedInstanceInner withPrimaryUserAssignedIdentityId(String primaryUserAssignedIdentityId)

Set the primaryUserAssignedIdentityId property: The resource id of a user assigned identity to be used by default.

ManagedInstanceInner withProxyOverride(ManagedInstanceProxyOverride proxyOverride)

Set the proxyOverride property: Connection type used for connecting to the instance.

ManagedInstanceInner withPublicDataEndpointEnabled(Boolean publicDataEndpointEnabled)

Set the publicDataEndpointEnabled property: Whether or not the public data endpoint is enabled.

ManagedInstanceInner withRequestedBackupStorageRedundancy(BackupStorageRedundancy requestedBackupStorageRedundancy)

Set the requestedBackupStorageRedundancy property: The storage account type to be used to store backups for this instance.

ManagedInstanceInner withRestorePointInTime(OffsetDateTime restorePointInTime)

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

ManagedInstanceInner withServicePrincipal(ServicePrincipal servicePrincipal)

Set the servicePrincipal property: The managed instance's service principal.

ManagedInstanceInner withSku(Sku sku)

Set the sku property: Managed instance SKU.

ManagedInstanceInner withSourceManagedInstanceId(String sourceManagedInstanceId)

Set the sourceManagedInstanceId property: The resource identifier of the source managed instance associated with create operation of this instance.

ManagedInstanceInner withStorageSizeInGB(Integer storageSizeInGB)

Set the storageSizeInGB property: Storage size in GB.

ManagedInstanceInner withSubnetId(String subnetId)

Set the subnetId property: Subnet resource ID for the managed instance.

ManagedInstanceInner withTags(Map<String,String> tags)
ManagedInstanceInner withTimezoneId(String timezoneId)

Set the timezoneId property: Id of the timezone.

ManagedInstanceInner withVCores(Integer vCores)

Set the vCores property: The number of vCores.

ManagedInstanceInner withZoneRedundant(Boolean zoneRedundant)

Set the zoneRedundant property: Whether or not the multi-az is enabled.

Boolean zoneRedundant()

Get the zoneRedundant property: Whether or not the multi-az is enabled.

Methods inherited from ProxyResource

Methods inherited from Resource

Methods inherited from java.lang.Object

Constructor Details

ManagedInstanceInner

public ManagedInstanceInner()

Creates an instance of ManagedInstanceInner class.

Method Details

administratorLogin

public String administratorLogin()

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

Returns:

the administratorLogin value.

administratorLoginPassword

public String administratorLoginPassword()

Get the administratorLoginPassword property: The administrator login password (required for managed instance creation).

Returns:

the administratorLoginPassword value.

administrators

public ManagedInstanceExternalAdministrator administrators()

Get the administrators property: The Azure Active Directory administrator of the server.

Returns:

the administrators value.

collation

public String collation()

Get the collation property: Collation of the managed instance.

Returns:

the collation value.

currentBackupStorageRedundancy

public BackupStorageRedundancy currentBackupStorageRedundancy()

Get the currentBackupStorageRedundancy property: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage).

Returns:

the currentBackupStorageRedundancy value.

dnsZone

public String dnsZone()

Get the dnsZone property: The Dns Zone that the managed instance is in.

Returns:

the dnsZone value.

dnsZonePartner

public String dnsZonePartner()

Get the dnsZonePartner property: The resource id of another managed instance whose DNS zone this managed instance will share after creation.

Returns:

the dnsZonePartner value.

fromJson

public static ManagedInstanceInner fromJson(JsonReader jsonReader)

Reads an instance of ManagedInstanceInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ManagedInstanceInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

fullyQualifiedDomainName

public String fullyQualifiedDomainName()

Get the fullyQualifiedDomainName property: The fully qualified domain name of the managed instance.

Returns:

the fullyQualifiedDomainName value.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

ManagedInstanceInner.id()

Returns:

the id value.

identity

public ResourceIdentity identity()

Get the identity property: The Azure Active Directory identity of the managed instance.

Returns:

the identity value.

instancePoolId

public String instancePoolId()

Get the instancePoolId property: The Id of the instance pool this managed server belongs to.

Returns:

the instancePoolId value.

keyId

public String keyId()

Get the keyId property: A CMK URI of the key to use for encryption.

Returns:

the keyId value.

licenseType

public ManagedInstanceLicenseType licenseType()

Get the licenseType property: 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).

Returns:

the licenseType value.

maintenanceConfigurationId

public String maintenanceConfigurationId()

Get the maintenanceConfigurationId property: Specifies maintenance configuration id to apply to this managed instance.

Returns:

the maintenanceConfigurationId value.

managedInstanceCreateMode

public ManagedServerCreateMode managedInstanceCreateMode()

Get the managedInstanceCreateMode property: 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.

Returns:

the managedInstanceCreateMode value.

minimalTlsVersion

public String minimalTlsVersion()

Get the minimalTlsVersion property: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'.

Returns:

the minimalTlsVersion value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

ManagedInstanceInner.name()

Returns:

the name value.

primaryUserAssignedIdentityId

public String primaryUserAssignedIdentityId()

Get the primaryUserAssignedIdentityId property: The resource id of a user assigned identity to be used by default.

Returns:

the primaryUserAssignedIdentityId value.

privateEndpointConnections

public List privateEndpointConnections()

Get the privateEndpointConnections property: List of private endpoint connections on a managed instance.

Returns:

the privateEndpointConnections value.

provisioningState

public ManagedInstancePropertiesProvisioningState provisioningState()

Get the provisioningState property: The provisioningState property.

Returns:

the provisioningState value.

proxyOverride

public ManagedInstanceProxyOverride proxyOverride()

Get the proxyOverride property: Connection type used for connecting to the instance.

Returns:

the proxyOverride value.

publicDataEndpointEnabled

public Boolean publicDataEndpointEnabled()

Get the publicDataEndpointEnabled property: Whether or not the public data endpoint is enabled.

Returns:

the publicDataEndpointEnabled value.

requestedBackupStorageRedundancy

public BackupStorageRedundancy requestedBackupStorageRedundancy()

Get the requestedBackupStorageRedundancy property: 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).

Returns:

the requestedBackupStorageRedundancy value.

restorePointInTime

public OffsetDateTime restorePointInTime()

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

Returns:

the restorePointInTime value.

servicePrincipal

public ServicePrincipal servicePrincipal()

Get the servicePrincipal property: The managed instance's service principal.

Returns:

the servicePrincipal value.

sku

public Sku sku()

Get the sku property: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH.

Returns:

the sku value.

sourceManagedInstanceId

public String sourceManagedInstanceId()

Get the sourceManagedInstanceId property: The resource identifier of the source managed instance associated with create operation of this instance.

Returns:

the sourceManagedInstanceId value.

state

public String state()

Get the state property: The state of the managed instance.

Returns:

the state value.

storageSizeInGB

public Integer storageSizeInGB()

Get the storageSizeInGB property: 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.

Returns:

the storageSizeInGB value.

subnetId

public String subnetId()

Get the subnetId property: Subnet resource ID for the managed instance.

Returns:

the subnetId value.

timezoneId

public String timezoneId()

Get the timezoneId property: 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".

Returns:

the timezoneId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ManagedInstanceInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

ManagedInstanceInner.type()

Returns:

the type value.

vCores

public Integer vCores()

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

Returns:

the vCores value.

validate

public void validate()

Validates the instance.

withAdministratorLogin

public ManagedInstanceInner withAdministratorLogin(String administratorLogin)

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

Parameters:

administratorLogin - the administratorLogin value to set.

Returns:

the ManagedInstanceInner object itself.

withAdministratorLoginPassword

public ManagedInstanceInner withAdministratorLoginPassword(String administratorLoginPassword)

Set the administratorLoginPassword property: The administrator login password (required for managed instance creation).

Parameters:

administratorLoginPassword - the administratorLoginPassword value to set.

Returns:

the ManagedInstanceInner object itself.

withAdministrators

public ManagedInstanceInner withAdministrators(ManagedInstanceExternalAdministrator administrators)

Set the administrators property: The Azure Active Directory administrator of the server.

Parameters:

administrators - the administrators value to set.

Returns:

the ManagedInstanceInner object itself.

withCollation

public ManagedInstanceInner withCollation(String collation)

Set the collation property: Collation of the managed instance.

Parameters:

collation - the collation value to set.

Returns:

the ManagedInstanceInner object itself.

withDnsZonePartner

public ManagedInstanceInner withDnsZonePartner(String dnsZonePartner)

Set the dnsZonePartner property: The resource id of another managed instance whose DNS zone this managed instance will share after creation.

Parameters:

dnsZonePartner - the dnsZonePartner value to set.

Returns:

the ManagedInstanceInner object itself.

withIdentity

public ManagedInstanceInner withIdentity(ResourceIdentity identity)

Set the identity property: The Azure Active Directory identity of the managed instance.

Parameters:

identity - the identity value to set.

Returns:

the ManagedInstanceInner object itself.

withInstancePoolId

public ManagedInstanceInner withInstancePoolId(String instancePoolId)

Set the instancePoolId property: The Id of the instance pool this managed server belongs to.

Parameters:

instancePoolId - the instancePoolId value to set.

Returns:

the ManagedInstanceInner object itself.

withKeyId

public ManagedInstanceInner withKeyId(String keyId)

Set the keyId property: A CMK URI of the key to use for encryption.

Parameters:

keyId - the keyId value to set.

Returns:

the ManagedInstanceInner object itself.

withLicenseType

public ManagedInstanceInner withLicenseType(ManagedInstanceLicenseType licenseType)

Set the licenseType property: 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).

Parameters:

licenseType - the licenseType value to set.

Returns:

the ManagedInstanceInner object itself.

withLocation

public ManagedInstanceInner withLocation(String location)

Overrides:

ManagedInstanceInner.withLocation(String location)

Parameters:

location

withMaintenanceConfigurationId

public ManagedInstanceInner withMaintenanceConfigurationId(String maintenanceConfigurationId)

Set the maintenanceConfigurationId property: Specifies maintenance configuration id to apply to this managed instance.

Parameters:

maintenanceConfigurationId - the maintenanceConfigurationId value to set.

Returns:

the ManagedInstanceInner object itself.

withManagedInstanceCreateMode

public ManagedInstanceInner withManagedInstanceCreateMode(ManagedServerCreateMode managedInstanceCreateMode)

Set the managedInstanceCreateMode property: 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.

Parameters:

managedInstanceCreateMode - the managedInstanceCreateMode value to set.

Returns:

the ManagedInstanceInner object itself.

withMinimalTlsVersion

public ManagedInstanceInner withMinimalTlsVersion(String minimalTlsVersion)

Set the minimalTlsVersion property: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'.

Parameters:

minimalTlsVersion - the minimalTlsVersion value to set.

Returns:

the ManagedInstanceInner object itself.

withPrimaryUserAssignedIdentityId

public ManagedInstanceInner withPrimaryUserAssignedIdentityId(String primaryUserAssignedIdentityId)

Set the primaryUserAssignedIdentityId property: The resource id of a user assigned identity to be used by default.

Parameters:

primaryUserAssignedIdentityId - the primaryUserAssignedIdentityId value to set.

Returns:

the ManagedInstanceInner object itself.

withProxyOverride

public ManagedInstanceInner withProxyOverride(ManagedInstanceProxyOverride proxyOverride)

Set the proxyOverride property: Connection type used for connecting to the instance.

Parameters:

proxyOverride - the proxyOverride value to set.

Returns:

the ManagedInstanceInner object itself.

withPublicDataEndpointEnabled

public ManagedInstanceInner withPublicDataEndpointEnabled(Boolean publicDataEndpointEnabled)

Set the publicDataEndpointEnabled property: Whether or not the public data endpoint is enabled.

Parameters:

publicDataEndpointEnabled - the publicDataEndpointEnabled value to set.

Returns:

the ManagedInstanceInner object itself.

withRequestedBackupStorageRedundancy

public ManagedInstanceInner withRequestedBackupStorageRedundancy(BackupStorageRedundancy requestedBackupStorageRedundancy)

Set the requestedBackupStorageRedundancy property: 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).

Parameters:

requestedBackupStorageRedundancy - the requestedBackupStorageRedundancy value to set.

Returns:

the ManagedInstanceInner object itself.

withRestorePointInTime

public ManagedInstanceInner withRestorePointInTime(OffsetDateTime restorePointInTime)

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

Parameters:

restorePointInTime - the restorePointInTime value to set.

Returns:

the ManagedInstanceInner object itself.

withServicePrincipal

public ManagedInstanceInner withServicePrincipal(ServicePrincipal servicePrincipal)

Set the servicePrincipal property: The managed instance's service principal.

Parameters:

servicePrincipal - the servicePrincipal value to set.

Returns:

the ManagedInstanceInner object itself.

withSku

public ManagedInstanceInner withSku(Sku sku)

Set the sku property: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH.

Parameters:

sku - the sku value to set.

Returns:

the ManagedInstanceInner object itself.

withSourceManagedInstanceId

public ManagedInstanceInner withSourceManagedInstanceId(String sourceManagedInstanceId)

Set the sourceManagedInstanceId property: The resource identifier of the source managed instance associated with create operation of this instance.

Parameters:

sourceManagedInstanceId - the sourceManagedInstanceId value to set.

Returns:

the ManagedInstanceInner object itself.

withStorageSizeInGB

public ManagedInstanceInner withStorageSizeInGB(Integer storageSizeInGB)

Set the storageSizeInGB property: 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.

Parameters:

storageSizeInGB - the storageSizeInGB value to set.

Returns:

the ManagedInstanceInner object itself.

withSubnetId

public ManagedInstanceInner withSubnetId(String subnetId)

Set the subnetId property: Subnet resource ID for the managed instance.

Parameters:

subnetId - the subnetId value to set.

Returns:

the ManagedInstanceInner object itself.

withTags

public ManagedInstanceInner withTags(Map tags)

Overrides:

ManagedInstanceInner.withTags(Map<String,String> tags)

Parameters:

tags

withTimezoneId

public ManagedInstanceInner withTimezoneId(String timezoneId)

Set the timezoneId property: 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".

Parameters:

timezoneId - the timezoneId value to set.

Returns:

the ManagedInstanceInner object itself.

withVCores

public ManagedInstanceInner withVCores(Integer vCores)

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

Parameters:

vCores - the vCores value to set.

Returns:

the ManagedInstanceInner object itself.

withZoneRedundant

public ManagedInstanceInner withZoneRedundant(Boolean zoneRedundant)

Set the zoneRedundant property: Whether or not the multi-az is enabled.

Parameters:

zoneRedundant - the zoneRedundant value to set.

Returns:

the ManagedInstanceInner object itself.

zoneRedundant

public Boolean zoneRedundant()

Get the zoneRedundant property: Whether or not the multi-az is enabled.

Returns:

the zoneRedundant value.

Applies to