ServerUpdate interface
An update request for an Azure SQL Database server.
Properties
administrator |
Administrator username for the server. Once created it cannot be changed. |
administrator |
The administrator login password (required for server creation). |
administrators | The Azure Active Directory administrator of the server. This can only be used at server create time. If used for server update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. |
external |
Status of external governance. NOTE: This property will not be serialized. It can only be populated by the server. |
federated |
The Client id used for cross tenant CMK scenario |
fully |
The fully qualified domain name of the server. NOTE: This property will not be serialized. It can only be populated by the server. |
identity | Server identity |
key |
A CMK URI of the key to use for encryption. |
minimal |
Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' |
primary |
The resource id of a user assigned identity to be used by default. |
private |
List of private endpoint connections on a server NOTE: This property will not be serialized. It can only be populated by the server. |
public |
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' |
restrict |
Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' |
state | The state of the server. NOTE: This property will not be serialized. It can only be populated by the server. |
tags | Resource tags. |
version | The version of the server. |
workspace |
Whether or not existing server has a workspace created and if it allows connection from workspace NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
administratorLogin
Administrator username for the server. Once created it cannot be changed.
administratorLogin?: string
Property Value
string
administratorLoginPassword
The administrator login password (required for server creation).
administratorLoginPassword?: string
Property Value
string
administrators
The Azure Active Directory administrator of the server. This can only be used at server create time. If used for server update, it will be ignored or it will result in an error. For updates individual APIs will need to be used.
administrators?: ServerExternalAdministrator
Property Value
externalGovernanceStatus
Status of external governance. NOTE: This property will not be serialized. It can only be populated by the server.
externalGovernanceStatus?: string
Property Value
string
federatedClientId
The Client id used for cross tenant CMK scenario
federatedClientId?: string
Property Value
string
fullyQualifiedDomainName
The fully qualified domain name of the server. NOTE: This property will not be serialized. It can only be populated by the server.
fullyQualifiedDomainName?: string
Property Value
string
identity
keyId
A CMK URI of the key to use for encryption.
keyId?: string
Property Value
string
minimalTlsVersion
Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'
minimalTlsVersion?: string
Property Value
string
primaryUserAssignedIdentityId
The resource id of a user assigned identity to be used by default.
primaryUserAssignedIdentityId?: string
Property Value
string
privateEndpointConnections
List of private endpoint connections on a server NOTE: This property will not be serialized. It can only be populated by the server.
privateEndpointConnections?: ServerPrivateEndpointConnection[]
Property Value
publicNetworkAccess
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'
publicNetworkAccess?: string
Property Value
string
restrictOutboundNetworkAccess
Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
restrictOutboundNetworkAccess?: string
Property Value
string
state
The state of the server. NOTE: This property will not be serialized. It can only be populated by the server.
state?: string
Property Value
string
tags
Resource tags.
tags?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
version
The version of the server.
version?: string
Property Value
string
workspaceFeature
Whether or not existing server has a workspace created and if it allows connection from workspace NOTE: This property will not be serialized. It can only be populated by the server.
workspaceFeature?: string
Property Value
string