Server Class

An Azure SQL Database server.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

Server(*, location: str, tags: dict[str, str] | None = None, identity: _models.ResourceIdentity | None = None, administrator_login: str | None = None, administrator_login_password: str | None = None, version: str | None = None, minimal_tls_version: str | _models.MinimalTlsVersion | None = None, public_network_access: str | _models.ServerPublicNetworkAccessFlag | None = None, primary_user_assigned_identity_id: str | None = None, federated_client_id: str | None = None, key_id: str | None = None, administrators: _models.ServerExternalAdministrator | None = None, restrict_outbound_network_access: str | _models.ServerNetworkAccessFlag | None = None, is_i_pv6_enabled: str | _models.ServerNetworkAccessFlag | None = None, retention_days: int | None = None, create_mode: str | _models.ServerCreateMode | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str Resource location. Required.
tags	dict[str, str] Resource tags. Default value: None
identity	ResourceIdentity The Azure Active Directory identity of the server. Default value: None
administrator_login	str Administrator username for the server. Once created it cannot be changed. Default value: None
administrator_login_password	str The administrator login password (required for server creation). Default value: None
version	str The version of the server. Default value: None
minimal_tls_version	str or MinimalTlsVersion Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3'. Known values are: "None", "1.0", "1.1", "1.2", and "1.3". Default value: None
public_network_access	str or ServerPublicNetworkAccessFlag 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'. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". Default value: None
primary_user_assigned_identity_id	str The resource id of a user assigned identity to be used by default. Default value: None
federated_client_id	str The Client id used for cross tenant CMK scenario. Default value: None
key_id	str A CMK URI of the key to use for encryption. Default value: None
administrators	ServerExternalAdministrator 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. Default value: None
restrict_outbound_network_access	str or ServerNetworkAccessFlag Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". Default value: None
is_i_pv6_enabled	str or ServerNetworkAccessFlag Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". Default value: None
retention_days	int Number of days this server will stay soft-deleted. Default value: None
create_mode	str or ServerCreateMode Create mode for server, only valid values for this are Normal and Restore. Known values are: "Normal" and "Restore". Default value: None

Variables

Name	Description
id	str Resource ID.
name	str Resource name.
type	str Resource type.
location	str Resource location. Required.
tags	dict[str, str] Resource tags.
identity	ResourceIdentity The Azure Active Directory identity of the server.
kind	str Kind of sql server. This is metadata used for the Azure portal experience.
administrator_login	str Administrator username for the server. Once created it cannot be changed.
administrator_login_password	str The administrator login password (required for server creation).
version	str The version of the server.
state	str The state of the server.
fully_qualified_domain_name	str The fully qualified domain name of the server.
private_endpoint_connections	list[ServerPrivateEndpointConnection] List of private endpoint connections on a server.
minimal_tls_version	str or MinimalTlsVersion Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3'. Known values are: "None", "1.0", "1.1", "1.2", and "1.3".
public_network_access	str or ServerPublicNetworkAccessFlag 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'. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter".
workspace_feature	str or ServerWorkspaceFeature Whether or not existing server has a workspace created and if it allows connection from workspace. Known values are: "Connected" and "Disconnected".
primary_user_assigned_identity_id	str The resource id of a user assigned identity to be used by default.
federated_client_id	str The Client id used for cross tenant CMK scenario.
key_id	str A CMK URI of the key to use for encryption.
administrators	ServerExternalAdministrator 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.
restrict_outbound_network_access	str or ServerNetworkAccessFlag Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled".
is_i_pv6_enabled	str or ServerNetworkAccessFlag Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled".
external_governance_status	str or ExternalGovernanceStatus Status of external governance. Known values are: "Enabled" and "Disabled".
retention_days	int Number of days this server will stay soft-deleted.
create_mode	str or ServerCreateMode Create mode for server, only valid values for this are Normal and Restore. Known values are: "Normal" and "Restore".