ServerInner Class

Package:

com.azure.resourcemanager.sql.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-sql:2.54.0-beta.1

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.sql.fluent.models.ServerInner

public final class ServerInner
extends Resource

An Azure SQL Database server.

Constructor Summary

Constructor	Description
ServerInner()	Creates an instance of ServerInner class.

Method Summary

Modifier and Type	Method and Description
String	administratorLogin() Get the administratorLogin property: Administrator username for the server.
String	administratorLoginPassword() Get the administratorLoginPassword property: The administrator login password (required for server creation).
ServerExternalAdministrator	administrators() Get the administrators property: The Azure Active Directory administrator can be utilized during server creation and for server updates, except for the azureADOnlyAuthentication property.
ServerCreateMode	createMode() Get the createMode property: Create mode for server, only valid values for this are Normal and Restore.
ExternalGovernanceStatus	externalGovernanceStatus() Get the externalGovernanceStatus property: Status of external governance.
UUID	federatedClientId() Get the federatedClientId property: The Client id used for cross tenant CMK scenario.
static ServerInner	fromJson(JsonReader jsonReader) Reads an instance of ServerInner from the JsonReader.
String	fullyQualifiedDomainName() Get the fullyQualifiedDomainName property: The fully qualified domain name of the server.
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 server.
ServerNetworkAccessFlag	isIPv6Enabled() Get the isIPv6Enabled property: Whether or not to enable IPv6 support for this server.
String	keyId() Get the keyId property: A CMK URI of the key to use for encryption.
String	kind() Get the kind property: Kind of sql server.
MinimalTlsVersion	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<ServerPrivateEndpointConnection>	privateEndpointConnections() Get the privateEndpointConnections property: List of private endpoint connections on a server.
ServerPublicNetworkAccessFlag	publicNetworkAccess() Get the publicNetworkAccess property: Whether or not public endpoint access is allowed for this server.
ServerNetworkAccessFlag	restrictOutboundNetworkAccess() Get the restrictOutboundNetworkAccess property: Whether or not to restrict outbound network access for this server.
Integer	retentionDays() Get the retentionDays property: Number of days this server will stay soft-deleted.
String	state() Get the state property: The state of the server.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
void	validate() Validates the instance.
String	version() Get the version property: The version of the server.
ServerInner	withAdministratorLogin(String administratorLogin) Set the administratorLogin property: Administrator username for the server.
ServerInner	withAdministratorLoginPassword(String administratorLoginPassword) Set the administratorLoginPassword property: The administrator login password (required for server creation).
ServerInner	withAdministrators(ServerExternalAdministrator administrators) Set the administrators property: The Azure Active Directory administrator can be utilized during server creation and for server updates, except for the azureADOnlyAuthentication property.
ServerInner	withCreateMode(ServerCreateMode createMode) Set the createMode property: Create mode for server, only valid values for this are Normal and Restore.
ServerInner	withFederatedClientId(UUID federatedClientId) Set the federatedClientId property: The Client id used for cross tenant CMK scenario.
ServerInner	withIdentity(ResourceIdentity identity) Set the identity property: The Azure Active Directory identity of the server.
ServerInner	withIsIPv6Enabled(ServerNetworkAccessFlag isIPv6Enabled) Set the isIPv6Enabled property: Whether or not to enable IPv6 support for this server.
ServerInner	withKeyId(String keyId) Set the keyId property: A CMK URI of the key to use for encryption.
ServerInner	withLocation(String location)
ServerInner	withMinimalTlsVersion(MinimalTlsVersion minimalTlsVersion) Set the minimalTlsVersion property: Minimal TLS version.
ServerInner	withPrimaryUserAssignedIdentityId(String primaryUserAssignedIdentityId) Set the primaryUserAssignedIdentityId property: The resource id of a user assigned identity to be used by default.
ServerInner	withPublicNetworkAccess(ServerPublicNetworkAccessFlag publicNetworkAccess) Set the publicNetworkAccess property: Whether or not public endpoint access is allowed for this server.
ServerInner	withRestrictOutboundNetworkAccess(ServerNetworkAccessFlag restrictOutboundNetworkAccess) Set the restrictOutboundNetworkAccess property: Whether or not to restrict outbound network access for this server.
ServerInner	withRetentionDays(Integer retentionDays) Set the retentionDays property: Number of days this server will stay soft-deleted.
ServerInner	withTags(Map<String,String> tags)
ServerInner	withVersion(String version) Set the version property: The version of the server.
ServerWorkspaceFeature	workspaceFeature() Get the workspaceFeature property: Whether or not existing server has a workspace created and if it allows connection from workspace.

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ServerInner

public ServerInner()

Creates an instance of ServerInner class.

Method Details

administratorLogin

public String administratorLogin()

Get the administratorLogin property: Administrator username for the server. Once created it cannot be changed.

Returns:

the administratorLogin value.

administratorLoginPassword

public String administratorLoginPassword()

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

Returns:

the administratorLoginPassword value.

administrators

public ServerExternalAdministrator administrators()

Get the administrators property: The Azure Active Directory administrator can be utilized during server creation and for server updates, except for the azureADOnlyAuthentication property. To update the azureADOnlyAuthentication property, individual API must be used.

Returns:

the administrators value.

createMode

public ServerCreateMode createMode()

Get the createMode property: Create mode for server, only valid values for this are Normal and Restore.

Returns:

the createMode value.

externalGovernanceStatus

public ExternalGovernanceStatus externalGovernanceStatus()

Get the externalGovernanceStatus property: Status of external governance.

Returns:

the externalGovernanceStatus value.

federatedClientId

public UUID federatedClientId()

Get the federatedClientId property: The Client id used for cross tenant CMK scenario.

Returns:

the federatedClientId value.

fromJson

public static ServerInner fromJson(JsonReader jsonReader)

Reads an instance of ServerInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ServerInner 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 server.

Returns:

the fullyQualifiedDomainName value.

id

public String id()

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

Overrides:

ServerInner.id()

Returns:

the id value.

identity

public ResourceIdentity identity()

Get the identity property: The Azure Active Directory identity of the server.

Returns:

the identity value.

isIPv6Enabled

public ServerNetworkAccessFlag isIPv6Enabled()

Get the isIPv6Enabled property: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.

Returns:

the isIPv6Enabled value.

keyId

public String keyId()

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

Returns:

the keyId value.

kind

public String kind()

Get the kind property: Kind of sql server. This is metadata used for the Azure portal experience.

Returns:

the kind value.

minimalTlsVersion

public MinimalTlsVersion minimalTlsVersion()

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

Returns:

the minimalTlsVersion value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

ServerInner.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<ServerPrivateEndpointConnection> privateEndpointConnections()

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

Returns:

the privateEndpointConnections value.

publicNetworkAccess

public ServerPublicNetworkAccessFlag publicNetworkAccess()

Get the publicNetworkAccess property: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter'.

Returns:

the publicNetworkAccess value.

restrictOutboundNetworkAccess

public ServerNetworkAccessFlag restrictOutboundNetworkAccess()

Get the restrictOutboundNetworkAccess property: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.

Returns:

the restrictOutboundNetworkAccess value.

retentionDays

public Integer retentionDays()

Get the retentionDays property: Number of days this server will stay soft-deleted.

Returns:

the retentionDays value.

state

public String state()

Get the state property: The state of the server.

Returns:

the state value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ServerInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

ServerInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

version

public String version()

Get the version property: The version of the server.

Returns:

the version value.

withAdministratorLogin

public ServerInner withAdministratorLogin(String administratorLogin)

Set the administratorLogin property: Administrator username for the server. Once created it cannot be changed.

Parameters:

administratorLogin - the administratorLogin value to set.

Returns:

the ServerInner object itself.

withAdministratorLoginPassword

public ServerInner withAdministratorLoginPassword(String administratorLoginPassword)

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

Parameters:

administratorLoginPassword - the administratorLoginPassword value to set.

Returns:

the ServerInner object itself.

withAdministrators

public ServerInner withAdministrators(ServerExternalAdministrator administrators)

Set the administrators property: The Azure Active Directory administrator can be utilized during server creation and for server updates, except for the azureADOnlyAuthentication property. To update the azureADOnlyAuthentication property, individual API must be used.

Parameters:

administrators - the administrators value to set.

Returns:

the ServerInner object itself.

withCreateMode

public ServerInner withCreateMode(ServerCreateMode createMode)

Set the createMode property: Create mode for server, only valid values for this are Normal and Restore.

Parameters:

createMode - the createMode value to set.

Returns:

the ServerInner object itself.

withFederatedClientId

public ServerInner withFederatedClientId(UUID federatedClientId)

Set the federatedClientId property: The Client id used for cross tenant CMK scenario.

Parameters:

federatedClientId - the federatedClientId value to set.

Returns:

the ServerInner object itself.

withIdentity

public ServerInner withIdentity(ResourceIdentity identity)

Set the identity property: The Azure Active Directory identity of the server.

Parameters:

identity - the identity value to set.

Returns:

the ServerInner object itself.

withIsIPv6Enabled

public ServerInner withIsIPv6Enabled(ServerNetworkAccessFlag isIPv6Enabled)

Set the isIPv6Enabled property: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.

Parameters:

isIPv6Enabled - the isIPv6Enabled value to set.

Returns:

the ServerInner object itself.

withKeyId

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

withLocation

public ServerInner withLocation(String location)

Overrides:

ServerInner.withLocation(String location)

Parameters:

location

withMinimalTlsVersion

public ServerInner withMinimalTlsVersion(MinimalTlsVersion minimalTlsVersion)

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

Parameters:

minimalTlsVersion - the minimalTlsVersion value to set.

Returns:

the ServerInner object itself.

withPrimaryUserAssignedIdentityId

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

withPublicNetworkAccess

public ServerInner withPublicNetworkAccess(ServerPublicNetworkAccessFlag publicNetworkAccess)

Set the publicNetworkAccess property: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter'.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the ServerInner object itself.

withRestrictOutboundNetworkAccess

public ServerInner withRestrictOutboundNetworkAccess(ServerNetworkAccessFlag restrictOutboundNetworkAccess)

Set the restrictOutboundNetworkAccess property: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.

Parameters:

restrictOutboundNetworkAccess - the restrictOutboundNetworkAccess value to set.

Returns:

the ServerInner object itself.

withRetentionDays

public ServerInner withRetentionDays(Integer retentionDays)

Set the retentionDays property: Number of days this server will stay soft-deleted.

Parameters:

retentionDays - the retentionDays value to set.

Returns:

the ServerInner object itself.

withTags

public ServerInner withTags(Map<String,String> tags)

Overrides:

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

Parameters:

tags

withVersion

public ServerInner withVersion(String version)

Set the version property: The version of the server.

Parameters:

version - the version value to set.

Returns:

the ServerInner object itself.

workspaceFeature

public ServerWorkspaceFeature workspaceFeature()

Get the workspaceFeature property: Whether or not existing server has a workspace created and if it allows connection from workspace.

Returns:

the workspaceFeature value.