ServerProperties Class

Package:

com.azure.resourcemanager.sql.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-sql:2.53.7

• java.lang.Object
• • com.azure.resourcemanager.sql.fluent.models.ServerProperties

Implements

JsonSerializable<ServerProperties>

public final class ServerProperties
implements JsonSerializable<ServerProperties>

The properties of a server.

Constructor Summary

Constructor	Description
ServerProperties()	Creates an instance of ServerProperties 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 of the server.
UUID	federatedClientId() Get the federatedClientId property: The Client id used for cross tenant CMK scenario.
static ServerProperties	fromJson(JsonReader jsonReader) Reads an instance of ServerProperties from the JsonReader.
String	fullyQualifiedDomainName() Get the fullyQualifiedDomainName property: The fully qualified domain name of the server.
String	keyId() Get the keyId property: A CMK URI of the key to use for encryption.
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<ServerPrivateEndpointConnection>	privateEndpointConnections() Get the privateEndpointConnections property: List of private endpoint connections on a server.
ServerNetworkAccessFlag	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.
String	state() Get the state property: The state of the server.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
String	version() Get the version property: The version of the server.
ServerProperties	withAdministratorLogin(String administratorLogin) Set the administratorLogin property: Administrator username for the server.
ServerProperties	withAdministratorLoginPassword(String administratorLoginPassword) Set the administratorLoginPassword property: The administrator login password (required for server creation).
ServerProperties	withAdministrators(ServerExternalAdministrator administrators) Set the administrators property: The Azure Active Directory administrator of the server.
ServerProperties	withFederatedClientId(UUID federatedClientId) Set the federatedClientId property: The Client id used for cross tenant CMK scenario.
ServerProperties	withKeyId(String keyId) Set the keyId property: A CMK URI of the key to use for encryption.
ServerProperties	withMinimalTlsVersion(String minimalTlsVersion) Set the minimalTlsVersion property: Minimal TLS version.
ServerProperties	withPrimaryUserAssignedIdentityId(String primaryUserAssignedIdentityId) Set the primaryUserAssignedIdentityId property: The resource id of a user assigned identity to be used by default.
ServerProperties	withPublicNetworkAccess(ServerNetworkAccessFlag publicNetworkAccess) Set the publicNetworkAccess property: Whether or not public endpoint access is allowed for this server.
ServerProperties	withRestrictOutboundNetworkAccess(ServerNetworkAccessFlag restrictOutboundNetworkAccess) Set the restrictOutboundNetworkAccess property: Whether or not to restrict outbound network access for this server.
ServerProperties	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 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ServerProperties

public ServerProperties()

Creates an instance of ServerProperties 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 of the server.

Returns:

the administrators 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 ServerProperties fromJson(JsonReader jsonReader)

Reads an instance of ServerProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

fullyQualifiedDomainName

public String fullyQualifiedDomainName()

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

Returns:

the fullyQualifiedDomainName value.

keyId

public String keyId()

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

Returns:

the keyId value.

minimalTlsVersion

public String minimalTlsVersion()

Get the minimalTlsVersion property: Minimal TLS version. Allowed values: '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<ServerPrivateEndpointConnection> privateEndpointConnections()

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

Returns:

the privateEndpointConnections value.

publicNetworkAccess

public ServerNetworkAccessFlag 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'.

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.

state

public String state()

Get the state property: The state of the server.

Returns:

the state value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

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

withAdministratorLoginPassword

public ServerProperties withAdministratorLoginPassword(String administratorLoginPassword)

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

Parameters:

administratorLoginPassword - the administratorLoginPassword value to set.

Returns:

the ServerProperties object itself.

withAdministrators

public ServerProperties withAdministrators(ServerExternalAdministrator administrators)

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

Parameters:

administrators - the administrators value to set.

Returns:

the ServerProperties object itself.

withFederatedClientId

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

withKeyId

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

withMinimalTlsVersion

public ServerProperties withMinimalTlsVersion(String minimalTlsVersion)

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

Parameters:

minimalTlsVersion - the minimalTlsVersion value to set.

Returns:

the ServerProperties object itself.

withPrimaryUserAssignedIdentityId

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

withPublicNetworkAccess

public ServerProperties withPublicNetworkAccess(ServerNetworkAccessFlag 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'.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the ServerProperties object itself.

withRestrictOutboundNetworkAccess

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

withVersion

public ServerProperties withVersion(String version)

Set the version property: The version of the server.

Parameters:

version - the version value to set.

Returns:

the ServerProperties 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.