Package version:

Interface Server

An Azure SQL Database server.

Hierarchy

Properties

administratorLogin? administratorLoginPassword? administrators? externalGovernanceStatus? federatedClientId? fullyQualifiedDomainName? id? identity? keyId? kind? location minimalTlsVersion? name? primaryUserAssignedIdentityId? privateEndpointConnections? publicNetworkAccess? restrictOutboundNetworkAccess? state? tags? type? version? workspaceFeature?

Properties

Optional administratorLogin

administratorLogin?: string

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

Optional administratorLoginPassword

administratorLoginPassword?: string

The administrator login password (required for server creation).

Optional administrators

administrators?: ServerExternalAdministrator

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.

Optional Readonly externalGovernanceStatus

externalGovernanceStatus?: string

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

Optional federatedClientId

federatedClientId?: string

The Client id used for cross tenant CMK scenario

Optional Readonly fullyQualifiedDomainName

fullyQualifiedDomainName?: string

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

Optional Readonly id

id?: string

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

Optional identity

identity?: ResourceIdentity

The Azure Active Directory identity of the server.

Optional keyId

keyId?: string

A CMK URI of the key to use for encryption.

Optional Readonly kind

kind?: string

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.

location

location: string

Resource location.

Optional minimalTlsVersion

minimalTlsVersion?: string

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

Optional Readonly name

name?: string

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

Optional primaryUserAssignedIdentityId

primaryUserAssignedIdentityId?: string

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

Optional Readonly privateEndpointConnections

privateEndpointConnections?: ServerPrivateEndpointConnection[]

List of private endpoint connections on a server NOTE: This property will not be serialized. It can only be populated by the server.

Optional publicNetworkAccess

publicNetworkAccess?: string

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'

Optional restrictOutboundNetworkAccess

restrictOutboundNetworkAccess?: string

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

Optional Readonly state

state?: string

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

Optional tags

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

Resource tags.

Type declaration

  • [propertyName: string]: string

Optional Readonly type

type?: string

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

Optional version

version?: string

The version of the server.

Optional Readonly workspaceFeature

workspaceFeature?: string

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.

Settings

Member Visibility

Theme

Generated using TypeDoc