Server interface
An Azure SQL Database server.
- Extends
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 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. |
| create |
Create mode for server, only valid values for this are Normal and Restore. |
| external |
Status of external governance. |
| federated |
The Client id used for cross tenant CMK scenario |
| fully |
The fully qualified domain name of the server. |
| identity | The Azure Active Directory identity of the server. |
| is |
Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' |
| key |
A CMK URI of the key to use for encryption. |
| kind | Kind of sql server. This is metadata used for the Azure portal experience. |
| minimal |
Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' |
| primary |
The resource id of a user assigned identity to be used by default. |
| private |
List of private endpoint connections on a 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' |
| retention |
Number of days this server will stay soft-deleted. |
| state | The state of the server. |
| version | The version of the server. |
| workspace |
Whether or not existing server has a workspace created and if it allows connection from workspace |
Inherited Properties
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location | The geo-location where the resource lives |
| name | The name of the resource |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| tags | Resource tags. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Property Details
administratorLogin
Administrator username for the server. Once created it cannot be changed.
administratorLogin?: stringProperty Value
string
administratorLoginPassword
The administrator login password (required for server creation).
administratorLoginPassword?: stringProperty 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?: ServerExternalAdministratorProperty Value
createMode
Create mode for server, only valid values for this are Normal and Restore.
createMode?: stringProperty Value
string
externalGovernanceStatus
Status of external governance.
externalGovernanceStatus?: stringProperty Value
string
federatedClientId
The Client id used for cross tenant CMK scenario
federatedClientId?: stringProperty Value
string
fullyQualifiedDomainName
The fully qualified domain name of the server.
fullyQualifiedDomainName?: stringProperty Value
string
identity
The Azure Active Directory identity of the server.
identity?: ResourceIdentityProperty Value
isIPv6Enabled
Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
isIPv6Enabled?: stringProperty Value
string
keyId
A CMK URI of the key to use for encryption.
keyId?: stringProperty Value
string
kind
Kind of sql server. This is metadata used for the Azure portal experience.
kind?: stringProperty Value
string
minimalTlsVersion
Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3'
minimalTlsVersion?: stringProperty Value
string
primaryUserAssignedIdentityId
The resource id of a user assigned identity to be used by default.
primaryUserAssignedIdentityId?: stringProperty Value
string
privateEndpointConnections
List of private endpoint connections on a 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?: stringProperty 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?: stringProperty Value
string
retentionDays
Number of days this server will stay soft-deleted.
retentionDays?: numberProperty Value
number
state
The state of the server.
state?: stringProperty Value
string
version
The version of the server.
version?: stringProperty Value
string
workspaceFeature
Whether or not existing server has a workspace created and if it allows connection from workspace
workspaceFeature?: stringProperty Value
string
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: stringProperty Value
string
Inherited From TrackedResource.id
location
The geo-location where the resource lives
location: stringProperty Value
string
Inherited From TrackedResource.location
name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemData?: SystemDataProperty Value
Inherited From TrackedResource.systemData
tags
Resource tags.
tags?: Record<string, string>Property Value
Record<string, string>
Inherited From TrackedResource.tags
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
type?: stringProperty Value
string
Inherited From TrackedResource.type