ManagedInstanceUpdate Class

Package:

com.azure.resourcemanager.sql.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-sql:2.46.0

• java.lang.Object
• • com.azure.resourcemanager.sql.models.ManagedInstanceUpdate

Implements

JsonSerializable<ManagedInstanceUpdate>

public final class ManagedInstanceUpdate
implements JsonSerializable<ManagedInstanceUpdate>

An update request for an Azure SQL Database managed instance.

Constructor Summary

Constructor	Description
ManagedInstanceUpdate()	Creates an instance of ManagedInstanceUpdate 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 ManagedInstanceUpdate	fromJson(JsonReader jsonReader) Reads an instance of ManagedInstanceUpdate from the JsonReader.
String	fullyQualifiedDomainName() Get the fullyQualifiedDomainName property: The fully qualified domain name of the managed instance.
ResourceIdentity	identity() Get the identity property: Managed instance identity.
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	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.
Map<String,String>	tags() Get the tags property: Resource tags.
String	timezoneId() Get the timezoneId property: Id of the timezone.
JsonWriter	toJson(JsonWriter jsonWriter)
Integer	vCores() Get the vCores property: The number of vCores.
void	validate() Validates the instance.
ManagedInstanceUpdate	withAdministratorLogin(String administratorLogin) Set the administratorLogin property: Administrator username for the managed instance.
ManagedInstanceUpdate	withAdministratorLoginPassword(String administratorLoginPassword) Set the administratorLoginPassword property: The administrator login password (required for managed instance creation).
ManagedInstanceUpdate	withAdministrators(ManagedInstanceExternalAdministrator administrators) Set the administrators property: The Azure Active Directory administrator of the server.
ManagedInstanceUpdate	withCollation(String collation) Set the collation property: Collation of the managed instance.
ManagedInstanceUpdate	withDnsZonePartner(String dnsZonePartner) Set the dnsZonePartner property: The resource id of another managed instance whose DNS zone this managed instance will share after creation.
ManagedInstanceUpdate	withIdentity(ResourceIdentity identity) Set the identity property: Managed instance identity.
ManagedInstanceUpdate	withInstancePoolId(String instancePoolId) Set the instancePoolId property: The Id of the instance pool this managed server belongs to.
ManagedInstanceUpdate	withKeyId(String keyId) Set the keyId property: A CMK URI of the key to use for encryption.
ManagedInstanceUpdate	withLicenseType(ManagedInstanceLicenseType licenseType) Set the licenseType property: The license type.
ManagedInstanceUpdate	withMaintenanceConfigurationId(String maintenanceConfigurationId) Set the maintenanceConfigurationId property: Specifies maintenance configuration id to apply to this managed instance.
ManagedInstanceUpdate	withManagedInstanceCreateMode(ManagedServerCreateMode managedInstanceCreateMode) Set the managedInstanceCreateMode property: Specifies the mode of database creation.
ManagedInstanceUpdate	withMinimalTlsVersion(String minimalTlsVersion) Set the minimalTlsVersion property: Minimal TLS version.
ManagedInstanceUpdate	withPrimaryUserAssignedIdentityId(String primaryUserAssignedIdentityId) Set the primaryUserAssignedIdentityId property: The resource id of a user assigned identity to be used by default.
ManagedInstanceUpdate	withProxyOverride(ManagedInstanceProxyOverride proxyOverride) Set the proxyOverride property: Connection type used for connecting to the instance.
ManagedInstanceUpdate	withPublicDataEndpointEnabled(Boolean publicDataEndpointEnabled) Set the publicDataEndpointEnabled property: Whether or not the public data endpoint is enabled.
ManagedInstanceUpdate	withRequestedBackupStorageRedundancy(BackupStorageRedundancy requestedBackupStorageRedundancy) Set the requestedBackupStorageRedundancy property: The storage account type to be used to store backups for this instance.
ManagedInstanceUpdate	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.
ManagedInstanceUpdate	withServicePrincipal(ServicePrincipal servicePrincipal) Set the servicePrincipal property: The managed instance's service principal.
ManagedInstanceUpdate	withSku(Sku sku) Set the sku property: Managed instance sku.
ManagedInstanceUpdate	withSourceManagedInstanceId(String sourceManagedInstanceId) Set the sourceManagedInstanceId property: The resource identifier of the source managed instance associated with create operation of this instance.
ManagedInstanceUpdate	withStorageSizeInGB(Integer storageSizeInGB) Set the storageSizeInGB property: Storage size in GB.
ManagedInstanceUpdate	withSubnetId(String subnetId) Set the subnetId property: Subnet resource ID for the managed instance.
ManagedInstanceUpdate	withTags(Map<String,String> tags) Set the tags property: Resource tags.
ManagedInstanceUpdate	withTimezoneId(String timezoneId) Set the timezoneId property: Id of the timezone.
ManagedInstanceUpdate	withVCores(Integer vCores) Set the vCores property: The number of vCores.
ManagedInstanceUpdate	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 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ManagedInstanceUpdate

public ManagedInstanceUpdate()

Creates an instance of ManagedInstanceUpdate 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 ManagedInstanceUpdate fromJson(JsonReader jsonReader)

Reads an instance of ManagedInstanceUpdate from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If an error occurs while reading the ManagedInstanceUpdate.

fullyQualifiedDomainName

public String fullyQualifiedDomainName()

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

Returns:

the fullyQualifiedDomainName value.

identity

public ResourceIdentity identity()

Get the identity property: Managed instance identity.

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.

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.

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.

tags

public Map tags()

Get the tags property: Resource tags.

Returns:

the tags 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)

Parameters:

jsonWriter

Throws:

IOException

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 ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withAdministratorLoginPassword

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withAdministrators

public ManagedInstanceUpdate withAdministrators(ManagedInstanceExternalAdministrator administrators)

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

Parameters:

administrators - the administrators value to set.

Returns:

the ManagedInstanceUpdate object itself.

withCollation

public ManagedInstanceUpdate withCollation(String collation)

Set the collation property: Collation of the managed instance.

Parameters:

collation - the collation value to set.

Returns:

the ManagedInstanceUpdate object itself.

withDnsZonePartner

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withIdentity

public ManagedInstanceUpdate withIdentity(ResourceIdentity identity)

Set the identity property: Managed instance identity.

Parameters:

identity - the identity value to set.

Returns:

the ManagedInstanceUpdate object itself.

withInstancePoolId

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withKeyId

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withLicenseType

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withMaintenanceConfigurationId

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withManagedInstanceCreateMode

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withMinimalTlsVersion

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withPrimaryUserAssignedIdentityId

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withProxyOverride

public ManagedInstanceUpdate withProxyOverride(ManagedInstanceProxyOverride proxyOverride)

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

Parameters:

proxyOverride - the proxyOverride value to set.

Returns:

the ManagedInstanceUpdate object itself.

withPublicDataEndpointEnabled

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withRequestedBackupStorageRedundancy

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withRestorePointInTime

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withServicePrincipal

public ManagedInstanceUpdate withServicePrincipal(ServicePrincipal servicePrincipal)

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

Parameters:

servicePrincipal - the servicePrincipal value to set.

Returns:

the ManagedInstanceUpdate object itself.

withSku

public ManagedInstanceUpdate withSku(Sku sku)

Set the sku property: Managed instance sku.

Parameters:

sku - the sku value to set.

Returns:

the ManagedInstanceUpdate object itself.

withSourceManagedInstanceId

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withStorageSizeInGB

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withSubnetId

public ManagedInstanceUpdate withSubnetId(String subnetId)

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

Parameters:

subnetId - the subnetId value to set.

Returns:

the ManagedInstanceUpdate object itself.

withTags

public ManagedInstanceUpdate withTags(Map tags)

Set the tags property: Resource tags.

Parameters:

tags - the tags value to set.

Returns:

the ManagedInstanceUpdate object itself.

withTimezoneId

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withVCores

public ManagedInstanceUpdate 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 ManagedInstanceUpdate object itself.

withZoneRedundant

public ManagedInstanceUpdate withZoneRedundant(Boolean zoneRedundant)

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

Parameters:

zoneRedundant - the zoneRedundant value to set.

Returns:

the ManagedInstanceUpdate object itself.

zoneRedundant

public Boolean zoneRedundant()

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

Returns:

the zoneRedundant value.