ManagedInstanceInner Class
- java.
lang. Object - com.
azure. core. management. ProxyResource - com.
azure. core. management. Resource - com.
azure. resourcemanager. sql. fluent. models. ManagedInstanceInner
- com.
- com.
- com.
public final class ManagedInstanceInner
extends Resource
An Azure SQL managed instance.
Constructor Summary
| Constructor | Description |
|---|---|
| ManagedInstanceInner() |
Creates an instance of Managed |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
| String |
administratorLogin()
Get the administrator |
| String |
administratorLoginPassword()
Get the administrator |
|
Managed |
administrators()
Get the administrators property: The Azure Active Directory administrator of the instance. |
|
Auth |
authenticationMetadata()
Get the authentication |
| String |
collation()
Get the collation property: Collation of the managed instance. |
|
Offset |
createTime()
Get the create |
|
Backup |
currentBackupStorageRedundancy()
Get the current |
|
Managed |
databaseFormat()
Get the database |
| String |
dnsZone()
Get the dns |
| String |
dnsZonePartner()
Get the dns |
|
External |
externalGovernanceStatus()
Get the external |
|
static
Managed |
fromJson(JsonReader jsonReader)
Reads an instance of Managed |
| String |
fullyQualifiedDomainName()
Get the fully |
|
Hybrid |
hybridSecondaryUsage()
Get the hybrid |
|
Hybrid |
hybridSecondaryUsageDetected()
Get the hybrid |
| String |
id()
Get the id property: Fully qualified resource Id for the resource. |
|
Resource |
identity()
Get the identity property: The Azure Active Directory identity of the managed instance. |
| String |
instancePoolId()
Get the instance |
| Boolean |
isGeneralPurposeV2()
Get the is |
| String |
keyId()
Get the key |
|
Managed |
licenseType()
Get the license |
| String |
maintenanceConfigurationId()
Get the maintenance |
|
Managed |
managedInstanceCreateMode()
Get the managed |
| String |
minimalTlsVersion()
Get the minimal |
| String |
name()
Get the name property: The name of the resource. |
|
Freemium |
pricingModel()
Get the pricing |
| String |
primaryUserAssignedIdentityId()
Get the primary |
|
List<Managed |
privateEndpointConnections()
Get the private |
|
Provisioning |
provisioningState()
Get the provisioning |
|
Managed |
proxyOverride()
Get the proxy |
| Boolean |
publicDataEndpointEnabled()
Get the public |
|
Backup |
requestedBackupStorageRedundancy()
Get the requested |
|
Offset |
restorePointInTime()
Get the restore |
|
Service |
servicePrincipal()
Get the service |
| Sku |
sku()
Get the sku property: Managed instance SKU. |
| String |
sourceManagedInstanceId()
Get the source |
| String |
state()
Get the state property: The state of the managed instance. |
| Integer |
storageIOps()
Get the storage |
| Integer |
storageSizeInGB()
Get the storage |
| Integer |
storageThroughputMBps()
Get the storage |
| String |
subnetId()
Get the subnet |
| String |
timezoneId()
Get the timezone |
|
Json |
toJson(JsonWriter jsonWriter) |
| String |
type()
Get the type property: The type of the resource. |
| void |
validate()
Validates the instance. |
| Integer |
vCores()
Get the v |
| String |
virtualClusterId()
Get the virtual |
|
Managed |
withAdministratorLogin(String administratorLogin)
Set the administrator |
|
Managed |
withAdministratorLoginPassword(String administratorLoginPassword)
Set the administrator |
|
Managed |
withAdministrators(ManagedInstanceExternalAdministrator administrators)
Set the administrators property: The Azure Active Directory administrator of the instance. |
|
Managed |
withAuthenticationMetadata(AuthMetadataLookupModes authenticationMetadata)
Set the authentication |
|
Managed |
withCollation(String collation)
Set the collation property: Collation of the managed instance. |
|
Managed |
withDatabaseFormat(ManagedInstanceDatabaseFormat databaseFormat)
Set the database |
|
Managed |
withDnsZonePartner(String dnsZonePartner)
Set the dns |
|
Managed |
withHybridSecondaryUsage(HybridSecondaryUsage hybridSecondaryUsage)
Set the hybrid |
|
Managed |
withIdentity(ResourceIdentity identity)
Set the identity property: The Azure Active Directory identity of the managed instance. |
|
Managed |
withInstancePoolId(String instancePoolId)
Set the instance |
|
Managed |
withIsGeneralPurposeV2(Boolean isGeneralPurposeV2)
Set the is |
|
Managed |
withKeyId(String keyId)
Set the key |
|
Managed |
withLicenseType(ManagedInstanceLicenseType licenseType)
Set the license |
|
Managed |
withLocation(String location) |
|
Managed |
withMaintenanceConfigurationId(String maintenanceConfigurationId)
Set the maintenance |
|
Managed |
withManagedInstanceCreateMode(ManagedServerCreateMode managedInstanceCreateMode)
Set the managed |
|
Managed |
withMinimalTlsVersion(String minimalTlsVersion)
Set the minimal |
|
Managed |
withPricingModel(FreemiumType pricingModel)
Set the pricing |
|
Managed |
withPrimaryUserAssignedIdentityId(String primaryUserAssignedIdentityId)
Set the primary |
|
Managed |
withProxyOverride(ManagedInstanceProxyOverride proxyOverride)
Set the proxy |
|
Managed |
withPublicDataEndpointEnabled(Boolean publicDataEndpointEnabled)
Set the public |
|
Managed |
withRequestedBackupStorageRedundancy(BackupStorageRedundancy requestedBackupStorageRedundancy)
Set the requested |
|
Managed |
withRestorePointInTime(OffsetDateTime restorePointInTime)
Set the restore |
|
Managed |
withServicePrincipal(ServicePrincipal servicePrincipal)
Set the service |
|
Managed |
withSku(Sku sku)
Set the sku property: Managed instance SKU. |
|
Managed |
withSourceManagedInstanceId(String sourceManagedInstanceId)
Set the source |
|
Managed |
withStorageIOps(Integer storageIOps)
Set the storage |
|
Managed |
withStorageSizeInGB(Integer storageSizeInGB)
Set the storage |
|
Managed |
withStorageThroughputMBps(Integer storageThroughputMBps)
Set the storage |
|
Managed |
withSubnetId(String subnetId)
Set the subnet |
|
Managed |
withTags(Map<String,String> tags) |
|
Managed |
withTimezoneId(String timezoneId)
Set the timezone |
|
Managed |
withVCores(Integer vCores)
Set the v |
|
Managed |
withZoneRedundant(Boolean zoneRedundant)
Set the zone |
| Boolean |
zoneRedundant()
Get the zone |
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:
administratorLoginPassword
public String administratorLoginPassword()
Get the administratorLoginPassword property: The administrator login password (required for managed instance creation).
Returns:
administrators
public ManagedInstanceExternalAdministrator administrators()
Get the administrators property: The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used.
Returns:
authenticationMetadata
public AuthMetadataLookupModes authenticationMetadata()
Get the authenticationMetadata property: The managed instance's authentication metadata lookup mode.
Returns:
collation
public String collation()
Get the collation property: Collation of the managed instance.
Returns:
createTime
public OffsetDateTime createTime()
Get the createTime property: Specifies the point in time (ISO8601 format) of the Managed Instance creation.
Returns:
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:
databaseFormat
public ManagedInstanceDatabaseFormat databaseFormat()
Get the databaseFormat property: Specifies the internal format of instance databases specific to the SQL engine version.
Returns:
dnsZone
public String dnsZone()
Get the dnsZone property: The Dns Zone that the managed instance is in.
Returns:
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:
externalGovernanceStatus
public ExternalGovernanceStatus externalGovernanceStatus()
Get the externalGovernanceStatus property: Status of external governance.
Returns:
fromJson
public static ManagedInstanceInner fromJson(JsonReader jsonReader)
Reads an instance of ManagedInstanceInner from the JsonReader.
Parameters:
Returns:
Throws:
fullyQualifiedDomainName
public String fullyQualifiedDomainName()
Get the fullyQualifiedDomainName property: The fully qualified domain name of the managed instance.
Returns:
hybridSecondaryUsage
public HybridSecondaryUsage hybridSecondaryUsage()
Get the hybridSecondaryUsage property: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR).
Returns:
hybridSecondaryUsageDetected
public HybridSecondaryUsageDetected hybridSecondaryUsageDetected()
Get the hybridSecondaryUsageDetected property: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR).
Returns:
id
public String id()
Get the id property: Fully qualified resource Id for the resource.
Overrides:
ManagedInstanceInner.id()Returns:
identity
public ResourceIdentity identity()
Get the identity property: The Azure Active Directory identity of the managed instance.
Returns:
instancePoolId
public String instancePoolId()
Get the instancePoolId property: The Id of the instance pool this managed server belongs to.
Returns:
isGeneralPurposeV2
public Boolean isGeneralPurposeV2()
Get the isGeneralPurposeV2 property: Whether or not this is a GPv2 variant of General Purpose edition.
Returns:
keyId
public String keyId()
Get the keyId property: A CMK URI of the key to use for encryption.
Returns:
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:
maintenanceConfigurationId
public String maintenanceConfigurationId()
Get the maintenanceConfigurationId property: Specifies maintenance configuration id to apply to this managed instance.
Returns:
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:
minimalTlsVersion
public String minimalTlsVersion()
Get the minimalTlsVersion property: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'.
Returns:
name
public String name()
Get the name property: The name of the resource.
Overrides:
ManagedInstanceInner.name()Returns:
pricingModel
public FreemiumType pricingModel()
Get the pricingModel property: Weather or not Managed Instance is freemium.
Returns:
primaryUserAssignedIdentityId
public String primaryUserAssignedIdentityId()
Get the primaryUserAssignedIdentityId property: The resource id of a user assigned identity to be used by default.
Returns:
privateEndpointConnections
public List<ManagedInstancePecProperty> privateEndpointConnections()
Get the privateEndpointConnections property: List of private endpoint connections on a managed instance.
Returns:
provisioningState
public ProvisioningState provisioningState()
Get the provisioningState property: Provisioning state of managed instance.
Returns:
proxyOverride
public ManagedInstanceProxyOverride proxyOverride()
Get the proxyOverride property: Connection type used for connecting to the instance.
Returns:
publicDataEndpointEnabled
public Boolean publicDataEndpointEnabled()
Get the publicDataEndpointEnabled property: Whether or not the public data endpoint is enabled.
Returns:
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:
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:
servicePrincipal
public ServicePrincipal servicePrincipal()
Get the servicePrincipal property: The managed instance's service principal.
Returns:
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:
sourceManagedInstanceId
public String sourceManagedInstanceId()
Get the sourceManagedInstanceId property: The resource identifier of the source managed instance associated with create operation of this instance.
Returns:
state
public String state()
Get the state property: The state of the managed instance.
Returns:
storageIOps
public Integer storageIOps()
Get the storageIOps property: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores.
Returns:
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:
storageThroughputMBps
public Integer storageThroughputMBps()
Get the storageThroughputMBps property: Storage throughput MBps parameter is not supported in the instance create/update operation.
Returns:
subnetId
public String subnetId()
Get the subnetId property: Subnet resource ID for the managed instance.
Returns:
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:
toJson
public JsonWriter toJson(JsonWriter jsonWriter)
Overrides:
ManagedInstanceInner.toJson(JsonWriter jsonWriter)Parameters:
Throws:
type
public String type()
Get the type property: The type of the resource.
Overrides:
ManagedInstanceInner.type()Returns:
validate
public void validate()
Validates the instance.
vCores
public Integer vCores()
Get the vCores property: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
Returns:
virtualClusterId
public String virtualClusterId()
Get the virtualClusterId property: Virtual cluster resource id for the Managed Instance.
Returns:
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:
Returns:
withAdministratorLoginPassword
public ManagedInstanceInner withAdministratorLoginPassword(String administratorLoginPassword)
Set the administratorLoginPassword property: The administrator login password (required for managed instance creation).
Parameters:
Returns:
withAdministrators
public ManagedInstanceInner withAdministrators(ManagedInstanceExternalAdministrator administrators)
Set the administrators property: The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used.
Parameters:
Returns:
withAuthenticationMetadata
public ManagedInstanceInner withAuthenticationMetadata(AuthMetadataLookupModes authenticationMetadata)
Set the authenticationMetadata property: The managed instance's authentication metadata lookup mode.
Parameters:
Returns:
withCollation
public ManagedInstanceInner withCollation(String collation)
Set the collation property: Collation of the managed instance.
Parameters:
Returns:
withDatabaseFormat
public ManagedInstanceInner withDatabaseFormat(ManagedInstanceDatabaseFormat databaseFormat)
Set the databaseFormat property: Specifies the internal format of instance databases specific to the SQL engine version.
Parameters:
Returns:
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:
Returns:
withHybridSecondaryUsage
public ManagedInstanceInner withHybridSecondaryUsage(HybridSecondaryUsage hybridSecondaryUsage)
Set the hybridSecondaryUsage property: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR).
Parameters:
Returns:
withIdentity
public ManagedInstanceInner withIdentity(ResourceIdentity identity)
Set the identity property: The Azure Active Directory identity of the managed instance.
Parameters:
Returns:
withInstancePoolId
public ManagedInstanceInner withInstancePoolId(String instancePoolId)
Set the instancePoolId property: The Id of the instance pool this managed server belongs to.
Parameters:
Returns:
withIsGeneralPurposeV2
public ManagedInstanceInner withIsGeneralPurposeV2(Boolean isGeneralPurposeV2)
Set the isGeneralPurposeV2 property: Whether or not this is a GPv2 variant of General Purpose edition.
Parameters:
Returns:
withKeyId
public ManagedInstanceInner withKeyId(String keyId)
Set the keyId property: A CMK URI of the key to use for encryption.
Parameters:
Returns:
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:
Returns:
withLocation
public ManagedInstanceInner withLocation(String location)
Overrides:
ManagedInstanceInner.withLocation(String location)Parameters:
withMaintenanceConfigurationId
public ManagedInstanceInner withMaintenanceConfigurationId(String maintenanceConfigurationId)
Set the maintenanceConfigurationId property: Specifies maintenance configuration id to apply to this managed instance.
Parameters:
Returns:
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:
Returns:
withMinimalTlsVersion
public ManagedInstanceInner withMinimalTlsVersion(String minimalTlsVersion)
Set the minimalTlsVersion property: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'.
Parameters:
Returns:
withPricingModel
public ManagedInstanceInner withPricingModel(FreemiumType pricingModel)
Set the pricingModel property: Weather or not Managed Instance is freemium.
Parameters:
Returns:
withPrimaryUserAssignedIdentityId
public ManagedInstanceInner withPrimaryUserAssignedIdentityId(String primaryUserAssignedIdentityId)
Set the primaryUserAssignedIdentityId property: The resource id of a user assigned identity to be used by default.
Parameters:
Returns:
withProxyOverride
public ManagedInstanceInner withProxyOverride(ManagedInstanceProxyOverride proxyOverride)
Set the proxyOverride property: Connection type used for connecting to the instance.
Parameters:
Returns:
withPublicDataEndpointEnabled
public ManagedInstanceInner withPublicDataEndpointEnabled(Boolean publicDataEndpointEnabled)
Set the publicDataEndpointEnabled property: Whether or not the public data endpoint is enabled.
Parameters:
Returns:
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:
Returns:
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:
Returns:
withServicePrincipal
public ManagedInstanceInner withServicePrincipal(ServicePrincipal servicePrincipal)
Set the servicePrincipal property: The managed instance's service principal.
Parameters:
Returns:
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:
Returns:
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:
Returns:
withStorageIOps
public ManagedInstanceInner withStorageIOps(Integer storageIOps)
Set the storageIOps property: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores.
Parameters:
Returns:
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:
Returns:
withStorageThroughputMBps
public ManagedInstanceInner withStorageThroughputMBps(Integer storageThroughputMBps)
Set the storageThroughputMBps property: Storage throughput MBps parameter is not supported in the instance create/update operation.
Parameters:
Returns:
withSubnetId
public ManagedInstanceInner withSubnetId(String subnetId)
Set the subnetId property: Subnet resource ID for the managed instance.
Parameters:
Returns:
withTags
public ManagedInstanceInner withTags(Map<String,String> tags)
Overrides:
ManagedInstanceInner.withTags(Map<String,String> tags)Parameters:
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:
Returns:
withVCores
public ManagedInstanceInner withVCores(Integer vCores)
Set the vCores property: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
Parameters:
Returns:
withZoneRedundant
public ManagedInstanceInner withZoneRedundant(Boolean zoneRedundant)
Set the zoneRedundant property: Whether or not the multi-az is enabled.
Parameters:
Returns:
zoneRedundant
public Boolean zoneRedundant()
Get the zoneRedundant property: Whether or not the multi-az is enabled.
Returns: