ManagedInstanceUpdate Class

Package:

com.microsoft.azure.management.sql

• java.lang.Object
• • com.microsoft.azure.management.sql.ManagedInstanceUpdate

public class ManagedInstanceUpdate

An update request for an Azure SQL Database managed instance.

Method Summary

Modifier and Type	Method and Description
String	administratorLogin() Get administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).
String	administratorLoginPassword() Get the administrator login password (required for managed instance creation).
String	collation() Get collation of the managed instance.
String	dnsZone() Get the Dns Zone that the managed instance is in.
String	dnsZonePartner() Get the resource id of another managed instance whose DNS zone this managed instance will share after creation.
String	fullyQualifiedDomainName() Get the fully qualified domain name of the managed instance.
String	instancePoolId() Get the Id of the instance pool this managed server belongs to.
ManagedInstanceLicenseType	licenseType() Get 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'.
ManagedServerCreateMode	managedInstanceCreateMode() Get 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'.
ManagedInstanceProxyOverride	proxyOverride() Get connection type used for connecting to the instance. Possible values include: 'Proxy', 'Redirect', 'Default'.
Boolean	publicDataEndpointEnabled() Get whether or not the public data endpoint is enabled.
DateTime	restorePointInTime() Get specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
Sku	sku() Get managed instance sku.
String	sourceManagedInstanceId() Get the resource identifier of the source managed instance associated with create operation of this instance.
String	state() Get the state of the managed instance.
Integer	storageSizeInGB() Get storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only.
String	subnetId() Get subnet resource ID for the managed instance.
Map<String, String>	tags() Get resource tags.
String	timezoneId() Get 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 NT 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".
Integer	vCores() Get the number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
ManagedInstanceUpdate	withAdministratorLogin(String administratorLogin) Set administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).
ManagedInstanceUpdate	withAdministratorLoginPassword(String administratorLoginPassword) Set the administrator login password (required for managed instance creation).
ManagedInstanceUpdate	withCollation(String collation) Set collation of the managed instance.
ManagedInstanceUpdate	withDnsZonePartner(String dnsZonePartner) Set the resource id of another managed instance whose DNS zone this managed instance will share after creation.
ManagedInstanceUpdate	withInstancePoolId(String instancePoolId) Set the Id of the instance pool this managed server belongs to.
ManagedInstanceUpdate	withLicenseType(ManagedInstanceLicenseType licenseType) Set 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'.
ManagedInstanceUpdate	withManagedInstanceCreateMode(ManagedServerCreateMode managedInstanceCreateMode) Set 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'.
ManagedInstanceUpdate	withProxyOverride(ManagedInstanceProxyOverride proxyOverride) Set connection type used for connecting to the instance. Possible values include: 'Proxy', 'Redirect', 'Default'.
ManagedInstanceUpdate	withPublicDataEndpointEnabled(Boolean publicDataEndpointEnabled) Set whether or not the public data endpoint is enabled.
ManagedInstanceUpdate	withRestorePointInTime(DateTime restorePointInTime) Set specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
ManagedInstanceUpdate	withSku(Sku sku) Set managed instance sku.
ManagedInstanceUpdate	withSourceManagedInstanceId(String sourceManagedInstanceId) Set the resource identifier of the source managed instance associated with create operation of this instance.
ManagedInstanceUpdate	withStorageSizeInGB(Integer storageSizeInGB) Set storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only.
ManagedInstanceUpdate	withSubnetId(String subnetId) Set subnet resource ID for the managed instance.
ManagedInstanceUpdate	withTags(Map<String, String> tags) Set resource tags.
ManagedInstanceUpdate	withTimezoneId(String timezoneId) Set 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 NT 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".
ManagedInstanceUpdate	withVCores(Integer vCores) Set the number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.

Method Details

administratorLogin

public String administratorLogin()

Get 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 administrator login password (required for managed instance creation).

Returns:

the administratorLoginPassword value

collation

public String collation()

Get collation of the managed instance.

Returns:

the collation value

dnsZone

public String dnsZone()

Get the Dns Zone that the managed instance is in.

Returns:

the dnsZone value

dnsZonePartner

public String dnsZonePartner()

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

Returns:

the dnsZonePartner value

fullyQualifiedDomainName

public String fullyQualifiedDomainName()

Get the fully qualified domain name of the managed instance.

Returns:

the fullyQualifiedDomainName value

instancePoolId

public String instancePoolId()

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

Returns:

the instancePoolId value

licenseType

public ManagedInstanceLicenseType licenseType()

Get 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'.

Returns:

the licenseType value

managedInstanceCreateMode

public ManagedServerCreateMode managedInstanceCreateMode()

Get 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'.

Returns:

the managedInstanceCreateMode value

proxyOverride

public ManagedInstanceProxyOverride proxyOverride()

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

Returns:

the proxyOverride value

publicDataEndpointEnabled

public Boolean publicDataEndpointEnabled()

Get whether or not the public data endpoint is enabled.

Returns:

the publicDataEndpointEnabled value

restorePointInTime

public DateTime restorePointInTime()

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

Returns:

the restorePointInTime value

sku

public Sku sku()

Get managed instance sku.

Returns:

the sku value

sourceManagedInstanceId

public String sourceManagedInstanceId()

Get 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 of the managed instance.

Returns:

the state value

storageSizeInGB

public Integer storageSizeInGB()

Get storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only.

Returns:

the storageSizeInGB value

subnetId

public String subnetId()

Get subnet resource ID for the managed instance.

Returns:

the subnetId value

tags

public Map tags()

Get resource tags.

Returns:

the tags value

timezoneId

public String timezoneId()

Get 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 NT 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

vCores

public Integer vCores()

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

Returns:

the vCores value

withAdministratorLogin

public ManagedInstanceUpdate withAdministratorLogin(String administratorLogin)

Set 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 administrator login password (required for managed instance creation).

Parameters:

administratorLoginPassword - the administratorLoginPassword value to set

Returns:

the ManagedInstanceUpdate object itself.

withCollation

public ManagedInstanceUpdate withCollation(String collation)

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

withInstancePoolId

public ManagedInstanceUpdate withInstancePoolId(String instancePoolId)

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

Parameters:

instancePoolId - the instancePoolId value to set

Returns:

the ManagedInstanceUpdate object itself.

withLicenseType

public ManagedInstanceUpdate withLicenseType(ManagedInstanceLicenseType licenseType)

Set 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'.

Parameters:

licenseType - the licenseType value to set

Returns:

the ManagedInstanceUpdate object itself.

withManagedInstanceCreateMode

public ManagedInstanceUpdate withManagedInstanceCreateMode(ManagedServerCreateMode managedInstanceCreateMode)

Set 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'.

Parameters:

managedInstanceCreateMode - the managedInstanceCreateMode value to set

Returns:

the ManagedInstanceUpdate object itself.

withProxyOverride

public ManagedInstanceUpdate withProxyOverride(ManagedInstanceProxyOverride proxyOverride)

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

Parameters:

proxyOverride - the proxyOverride value to set

Returns:

the ManagedInstanceUpdate object itself.

withPublicDataEndpointEnabled

public ManagedInstanceUpdate withPublicDataEndpointEnabled(Boolean publicDataEndpointEnabled)

Set whether or not the public data endpoint is enabled.

Parameters:

publicDataEndpointEnabled - the publicDataEndpointEnabled value to set

Returns:

the ManagedInstanceUpdate object itself.

withRestorePointInTime

public ManagedInstanceUpdate withRestorePointInTime(DateTime restorePointInTime)

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

withSku

public ManagedInstanceUpdate withSku(Sku sku)

Set managed instance sku.

Parameters:

sku - the sku value to set

Returns:

the ManagedInstanceUpdate object itself.

withSourceManagedInstanceId

public ManagedInstanceUpdate withSourceManagedInstanceId(String sourceManagedInstanceId)

Set 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 storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only.

Parameters:

storageSizeInGB - the storageSizeInGB value to set

Returns:

the ManagedInstanceUpdate object itself.

withSubnetId

public ManagedInstanceUpdate withSubnetId(String subnetId)

Set 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 resource tags.

Parameters:

tags - the tags value to set

Returns:

the ManagedInstanceUpdate object itself.

withTimezoneId

public ManagedInstanceUpdate withTimezoneId(String timezoneId)

Set 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 NT 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 number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.

Parameters:

vCores - the vCores value to set

Returns:

the ManagedInstanceUpdate object itself.