Share via

Server interface

Package:
@azure/arm-sql

An Azure SQL Database server.

Extends
TrackedResource

Properties

administratorLogin

Administrator username for the server. Once created it cannot be changed.
administratorLoginPassword

The administrator login password (required for server creation).
administrators

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.
createMode

Create mode for server, only valid values for this are Normal and Restore.
externalGovernanceStatus

Status of external governance. NOTE: This property will not be serialized. It can only be populated by the server.
federatedClientId

The Client id used for cross tenant CMK scenario
fullyQualifiedDomainName

The fully qualified domain name of the server. NOTE: This property will not be serialized. It can only be populated by the server.
identity

The Azure Active Directory identity of the server.
isIPv6Enabled

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

A CMK URI of the key to use for encryption.
kind

Kind of sql server. This is metadata used for the Azure portal experience. NOTE: This property will not be serialized. It can only be populated by the server.
minimalTlsVersion

Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3'
primaryUserAssignedIdentityId

The resource id of a user assigned identity to be used by default.
privateEndpointConnections

List of private endpoint connections on a server NOTE: This property will not be serialized. It can only be populated by the server.
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'
restrictOutboundNetworkAccess

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

Number of days this server will stay soft-deleted.
state

The state of the server. NOTE: This property will not be serialized. It can only be populated by the server.
version

The version of the server.
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.

Inherited Properties

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
location

Resource location.
name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

Resource type. 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 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.

administrators?: ServerExternalAdministrator

Property Value

ServerExternalAdministrator

createMode

Create mode for server, only valid values for this are Normal and Restore.

createMode?: string

Property Value

string

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

The Azure Active Directory identity of the server.

identity?: ResourceIdentity

Property Value

ResourceIdentity

isIPv6Enabled

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

isIPv6Enabled?: string

Property Value

string

keyId

A CMK URI of the key to use for encryption.

keyId?: string

Property Value

string

kind

Kind of sql server. This is metadata used for the Azure portal experience. NOTE: This property will not be serialized. It can only be populated by the server.

kind?: string

Property Value

string

minimalTlsVersion

Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3'

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

ServerPrivateEndpointConnection[]

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

retentionDays

Number of days this server will stay soft-deleted.

retentionDays?: number

Property Value

number

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

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

Inherited Property Details

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

Resource location.

location: string

Property Value

string

Inherited From TrackedResource.location

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type