Package com.azure.resourcemanager.sql.fluent.models

Class ManagedInstanceProperties

java.lang.Object
com.azure.resourcemanager.sql.fluent.models.ManagedInstanceProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<ManagedInstanceProperties>
public final class ManagedInstanceProperties extends Object implements com.azure.json.JsonSerializable<ManagedInstanceProperties>
The properties of a managed instance.

  • Constructor Details

    • ManagedInstanceProperties

      public ManagedInstanceProperties()
      Creates an instance of ManagedInstanceProperties class.

  • Method Details

    • provisioningState

      public ManagedInstancePropertiesProvisioningState provisioningState()
      Get the provisioningState property: The provisioningState property.
      Returns:
      the provisioningState 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.

    • withManagedInstanceCreateMode

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

    • fullyQualifiedDomainName

      public String fullyQualifiedDomainName()
      Get the fullyQualifiedDomainName property: The fully qualified domain name of the managed instance.
      Returns:
      the fullyQualifiedDomainName value.

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

    • withAdministratorLogin

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

    • administratorLoginPassword

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

    • withAdministratorLoginPassword

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

    • subnetId

      public String subnetId()
      Get the subnetId property: Subnet resource ID for the managed instance.
      Returns:
      the subnetId value.

    • withSubnetId

      public ManagedInstanceProperties withSubnetId(String subnetId)
      Set the subnetId property: Subnet resource ID for the managed instance.
      Parameters:
      subnetId - the subnetId value to set.
      Returns:
      the ManagedInstanceProperties object itself.

    • state

      public String state()
      Get the state property: The state of the managed instance.
      Returns:
      the state 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.

    • withLicenseType

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

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

    • withVCores

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

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

    • withStorageSizeInGB

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

    • collation

      public String collation()
      Get the collation property: Collation of the managed instance.
      Returns:
      the collation value.

    • withCollation

      public ManagedInstanceProperties withCollation(String collation)
      Set the collation property: Collation of the managed instance.
      Parameters:
      collation - the collation value to set.
      Returns:
      the ManagedInstanceProperties object itself.

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

    • withDnsZonePartner

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

    • publicDataEndpointEnabled

      public Boolean publicDataEndpointEnabled()
      Get the publicDataEndpointEnabled property: Whether or not the public data endpoint is enabled.
      Returns:
      the publicDataEndpointEnabled value.

    • withPublicDataEndpointEnabled

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

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

    • withSourceManagedInstanceId

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

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

    • withRestorePointInTime

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

    • proxyOverride

      public ManagedInstanceProxyOverride proxyOverride()
      Get the proxyOverride property: Connection type used for connecting to the instance.
      Returns:
      the proxyOverride value.

    • withProxyOverride

      public ManagedInstanceProperties withProxyOverride(ManagedInstanceProxyOverride proxyOverride)
      Set the proxyOverride property: Connection type used for connecting to the instance.
      Parameters:
      proxyOverride - the proxyOverride value to set.
      Returns:
      the ManagedInstanceProperties object itself.

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

    • withTimezoneId

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

    • instancePoolId

      public String instancePoolId()
      Get the instancePoolId property: The Id of the instance pool this managed server belongs to.
      Returns:
      the instancePoolId value.

    • withInstancePoolId

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

    • maintenanceConfigurationId

      public String maintenanceConfigurationId()
      Get the maintenanceConfigurationId property: Specifies maintenance configuration id to apply to this managed instance.
      Returns:
      the maintenanceConfigurationId value.

    • withMaintenanceConfigurationId

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

    • privateEndpointConnections

      public List<ManagedInstancePecProperty> privateEndpointConnections()
      Get the privateEndpointConnections property: List of private endpoint connections on a managed instance.
      Returns:
      the privateEndpointConnections 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.

    • withMinimalTlsVersion

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

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

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

    • withRequestedBackupStorageRedundancy

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

    • zoneRedundant

      public Boolean zoneRedundant()
      Get the zoneRedundant property: Whether or not the multi-az is enabled.
      Returns:
      the zoneRedundant value.

    • withZoneRedundant

      public ManagedInstanceProperties withZoneRedundant(Boolean zoneRedundant)
      Set the zoneRedundant property: Whether or not the multi-az is enabled.
      Parameters:
      zoneRedundant - the zoneRedundant value to set.
      Returns:
      the ManagedInstanceProperties object itself.

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

    • withPrimaryUserAssignedIdentityId

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

    • keyId

      public String keyId()
      Get the keyId property: A CMK URI of the key to use for encryption.
      Returns:
      the keyId value.

    • withKeyId

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

    • administrators

      public ManagedInstanceExternalAdministrator administrators()
      Get the administrators property: The Azure Active Directory administrator of the server.
      Returns:
      the administrators value.

    • withAdministrators

      public ManagedInstanceProperties withAdministrators(ManagedInstanceExternalAdministrator administrators)
      Set the administrators property: The Azure Active Directory administrator of the server.
      Parameters:
      administrators - the administrators value to set.
      Returns:
      the ManagedInstanceProperties object itself.

    • servicePrincipal

      public ServicePrincipal servicePrincipal()
      Get the servicePrincipal property: The managed instance's service principal.
      Returns:
      the servicePrincipal value.

    • withServicePrincipal

      public ManagedInstanceProperties withServicePrincipal(ServicePrincipal servicePrincipal)
      Set the servicePrincipal property: The managed instance's service principal.
      Parameters:
      servicePrincipal - the servicePrincipal value to set.
      Returns:
      the ManagedInstanceProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ManagedInstanceProperties>
      Throws:
      IOException

    • fromJson

      public static ManagedInstanceProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ManagedInstanceProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ManagedInstanceProperties 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 ManagedInstanceProperties.