ServerUpdate Class

Package:

com.azure.resourcemanager.sql.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-sql:2.37.0

• java.lang.Object
• • com.azure.resourcemanager.sql.models.ServerUpdate

public final class ServerUpdate

An update request for an Azure SQL Database server.

Constructor Summary

Constructor	Description
ServerUpdate()	Creates an instance of ServerUpdate 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.
String	fullyQualifiedDomainName() Get the fullyQualifiedDomainName property: The fully qualified domain name of the server.
ResourceIdentity	identity() Get the identity property: Server identity.
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.
Map<String,String>	tags() Get the tags property: Resource tags.
void	validate() Validates the instance.
String	version() Get the version property: The version of the server.
ServerUpdate	withAdministratorLogin(String administratorLogin) Set the administratorLogin property: Administrator username for the server.
ServerUpdate	withAdministratorLoginPassword(String administratorLoginPassword) Set the administratorLoginPassword property: The administrator login password (required for server creation).
ServerUpdate	withAdministrators(ServerExternalAdministrator administrators) Set the administrators property: The Azure Active Directory administrator of the server.
ServerUpdate	withFederatedClientId(UUID federatedClientId) Set the federatedClientId property: The Client id used for cross tenant CMK scenario.
ServerUpdate	withIdentity(ResourceIdentity identity) Set the identity property: Server identity.
ServerUpdate	withKeyId(String keyId) Set the keyId property: A CMK URI of the key to use for encryption.
ServerUpdate	withMinimalTlsVersion(String minimalTlsVersion) Set the minimalTlsVersion property: Minimal TLS version.
ServerUpdate	withPrimaryUserAssignedIdentityId(String primaryUserAssignedIdentityId) Set the primaryUserAssignedIdentityId property: The resource id of a user assigned identity to be used by default.
ServerUpdate	withPublicNetworkAccess(ServerNetworkAccessFlag publicNetworkAccess) Set the publicNetworkAccess property: Whether or not public endpoint access is allowed for this server.
ServerUpdate	withRestrictOutboundNetworkAccess(ServerNetworkAccessFlag restrictOutboundNetworkAccess) Set the restrictOutboundNetworkAccess property: Whether or not to restrict outbound network access for this server.
ServerUpdate	withTags(Map<String,String> tags) Set the tags property: Resource tags.
ServerUpdate	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

ServerUpdate

public ServerUpdate()

Creates an instance of ServerUpdate 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.

fullyQualifiedDomainName

public String fullyQualifiedDomainName()

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

Returns:

the fullyQualifiedDomainName value.

identity

public ResourceIdentity identity()

Get the identity property: Server identity.

Returns:

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

tags

public Map tags()

Get the tags property: Resource tags.

Returns:

the tags 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 ServerUpdate 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 ServerUpdate object itself.

withAdministratorLoginPassword

public ServerUpdate withAdministratorLoginPassword(String administratorLoginPassword)

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

Parameters:

administratorLoginPassword - the administratorLoginPassword value to set.

Returns:

the ServerUpdate object itself.

withAdministrators

public ServerUpdate withAdministrators(ServerExternalAdministrator administrators)

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

Parameters:

administrators - the administrators value to set.

Returns:

the ServerUpdate object itself.

withFederatedClientId

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

withIdentity

public ServerUpdate withIdentity(ResourceIdentity identity)

Set the identity property: Server identity.

Parameters:

identity - the identity value to set.

Returns:

the ServerUpdate object itself.

withKeyId

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

withMinimalTlsVersion

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

withPrimaryUserAssignedIdentityId

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

withPublicNetworkAccess

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

withRestrictOutboundNetworkAccess

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

withTags

public ServerUpdate withTags(Map tags)

Set the tags property: Resource tags.

Parameters:

tags - the tags value to set.

Returns:

the ServerUpdate object itself.

withVersion

public ServerUpdate withVersion(String version)

Set the version property: The version of the server.

Parameters:

version - the version value to set.

Returns:

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