Share via

Server Class

  • Reference

Represents a 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 Azure.

Constructor

Server(*, location: str, tags: Dict[str, str] | None = None, identity: ResourceIdentity | None = None, sku: Sku | None = None, administrator_login: str | None = None, version: str | ServerVersion | None = None, ssl_enforcement: str | SslEnforcementEnum | None = None, minimal_tls_version: str | MinimalTlsVersionEnum | None = None, infrastructure_encryption: str | InfrastructureEncryption | None = None, user_visible_state: str | ServerState | None = None, fully_qualified_domain_name: str | None = None, earliest_restore_date: datetime | None = None, storage_profile: StorageProfile | None = None, replication_role: str | None = None, master_server_id: str | None = None, replica_capacity: int | None = None, public_network_access: str | PublicNetworkAccessEnum | None = None, **kwargs)

Keyword-Only Parameters

Name Description
tags
dict[str, str]

A set of tags. Resource tags.

Default value: None
location
str

Required. The geo-location where the resource lives.
identity
ResourceIdentity

The Azure Active Directory identity of the server.

Default value: None
sku
Sku

The SKU (pricing tier) of the server.

Default value: None
administrator_login
str

The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).

Default value: None
version
str or ServerVersion

Server version. Possible values include: "5.6", "5.7", "8.0".

Default value: None
ssl_enforcement
str or SslEnforcementEnum

Enable ssl enforcement or not when connect to server. Possible values include: "Enabled", "Disabled".

Default value: None
minimal_tls_version
str or MinimalTlsVersionEnum

Enforce a minimal Tls version for the server. Possible values include: "TLS1_0", "TLS1_1", "TLS1_2", "TLSEnforcementDisabled".

Default value: None
infrastructure_encryption
str or InfrastructureEncryption

Status showing whether the server enabled infrastructure encryption. Possible values include: "Enabled", "Disabled".

Default value: None
user_visible_state
str or ServerState

A state of a server that is visible to user. Possible values include: "Ready", "Dropping", "Disabled", "Inaccessible".

Default value: None
fully_qualified_domain_name
str

The fully qualified domain name of a server.

Default value: None
earliest_restore_date
datetime

Earliest restore point creation time (ISO8601 format).

Default value: None
storage_profile
StorageProfile

Storage profile of a server.

Default value: None
replication_role
str

The replication role of the server.

Default value: None
master_server_id
str

The master server id of a replica server.

Default value: None
replica_capacity
int

The maximum number of replicas that a master server can have.

Default value: None
public_network_access
str or PublicNetworkAccessEnum

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. Possible values include: "Enabled", "Disabled".

Default value: None

Variables

Name Description
id
str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name
str

The name of the resource.
type
str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
tags
dict[str, str]

A set of tags. Resource tags.
location
str

Required. The geo-location where the resource lives.
identity
ResourceIdentity

The Azure Active Directory identity of the server.
sku
Sku

The SKU (pricing tier) of the server.
administrator_login
str

The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
version
str or ServerVersion

Server version. Possible values include: "5.6", "5.7", "8.0".
ssl_enforcement
str or SslEnforcementEnum

Enable ssl enforcement or not when connect to server. Possible values include: "Enabled", "Disabled".
minimal_tls_version
str or MinimalTlsVersionEnum

Enforce a minimal Tls version for the server. Possible values include: "TLS1_0", "TLS1_1", "TLS1_2", "TLSEnforcementDisabled".
byok_enforcement
str

Status showing whether the server data encryption is enabled with customer-managed keys.
infrastructure_encryption
str or InfrastructureEncryption

Status showing whether the server enabled infrastructure encryption. Possible values include: "Enabled", "Disabled".
user_visible_state
str or ServerState

A state of a server that is visible to user. Possible values include: "Ready", "Dropping", "Disabled", "Inaccessible".
fully_qualified_domain_name
str

The fully qualified domain name of a server.
earliest_restore_date
datetime

Earliest restore point creation time (ISO8601 format).
storage_profile
StorageProfile

Storage profile of a server.
replication_role
str

The replication role of the server.
master_server_id
str

The master server id of a replica server.
replica_capacity
int

The maximum number of replicas that a master server can have.
public_network_access
str or PublicNetworkAccessEnum

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. Possible values include: "Enabled", "Disabled".
private_endpoint_connections
list[ServerPrivateEndpointConnection]

List of private endpoint connections on a server.