Share via


Server Class

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

Constructor

Server(*, location: str, tags: dict[str, str] | None = None, sku: _models.Sku | None = None, administrator_login: str | None = None, administrator_login_password: str | None = None, version: str | _models.ServerVersion | None = None, storage: _models.Storage | None = None, backup: _models.Backup | None = None, network: _models.Network | None = None, high_availability: _models.HighAvailability | None = None, maintenance_window: _models.MaintenanceWindow | None = None, source_server_resource_id: str | None = None, point_in_time_utc: datetime | None = None, availability_zone: str = '', create_mode: str | _models.CreateMode | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
tags

Resource tags.

Default value: None
location
str

The geo-location where the resource lives. Required.

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
administrator_login_password
str

The administrator login password (required for server creation).

Default value: None
version

PostgreSQL Server version. Known values are: "14", "13", "12", and "11".

Default value: None
storage

Storage properties of a server.

Default value: None
backup

Backup properties of a server.

Default value: None
network

Network properties of a server.

Default value: None
high_availability

High availability properties of a server.

Default value: None
maintenance_window

Maintenance window properties of a server.

Default value: None
source_server_resource_id
str

The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore'.

Default value: None
point_in_time_utc

Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore'.

Default value: None
availability_zone
str

availability zone information of the server.

create_mode

The mode to create a new PostgreSQL server. Known values are: "Default", "Create", "Update", and "PointInTimeRestore".

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

Resource tags.

location
str

The geo-location where the resource lives. Required.

sku
Sku

The SKU (pricing tier) of the server.

system_data

The system metadata relating to this resource.

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

administrator_login_password
str

The administrator login password (required for server creation).

version

PostgreSQL Server version. Known values are: "14", "13", "12", and "11".

minor_version
str

The minor version of the server.

state

A state of a server that is visible to user. Known values are: "Ready", "Dropping", "Disabled", "Starting", "Stopping", "Stopped", and "Updating".

fully_qualified_domain_name
str

The fully qualified domain name of a server.

storage

Storage properties of a server.

backup

Backup properties of a server.

network

Network properties of a server.

high_availability

High availability properties of a server.

maintenance_window

Maintenance window properties of a server.

source_server_resource_id
str

The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore'.

point_in_time_utc

Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore'.

availability_zone
str

availability zone information of the server.

create_mode

The mode to create a new PostgreSQL server. Known values are: "Default", "Create", "Update", and "PointInTimeRestore".