replicas

Creates, updates, deletes, gets or lists a replicas resource.

Overview

Name	replicas
Type	Resource
Id	azure.postgresql_flexible_servers.replicas

Fields

The following fields are returned by SELECT queries:

list_by_server

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
administratorLogin	string	Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn't deleted.
administratorLoginPassword	string	Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.
authConfig	object	Authentication configuration properties of a server.
availabilityZone	string	Availability zone of a server.
backup	object	Backup properties of a server.
cluster	object	Cluster properties of a server.
createMode	string	Creation mode of a new server. Known values are: "Default", "Create", "Update", "PointInTimeRestore", "GeoRestore", "Replica", and "ReviveDropped". (Default, Create, Update, PointInTimeRestore, GeoRestore, Replica, ReviveDropped)
dataEncryption	object	Data encryption properties of a server.
fullyQualifiedDomainName	string	Fully qualified domain name of a server.
highAvailability	object	High availability properties of a server.
identity	object	User assigned managed identities assigned to the server.
location	string	The geo-location where the resource lives. Required.
maintenanceWindow	object	Maintenance window properties of a server.
minorVersion	string	Minor version of PostgreSQL database engine.
network	object	Network properties of a server. Only required if you want your server to be integrated into a virtual network provided by customer.
pointInTimeUTC	string (date-time)	Creation time (in ISO8601 format) of the backup which you want to restore in the new server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'.
privateEndpointConnections	array	List of private endpoint connections associated with the specified server.
replica	object	Read replica properties of a server. Required only in case that you want to promote a server.
replicaCapacity	integer	Maximum number of read replicas allowed for a server.
replicationRole	string	Role of the server in a replication set. Known values are: "None", "Primary", "AsyncReplica", and "GeoAsyncReplica". (None, Primary, AsyncReplica, GeoAsyncReplica)
sku	object	Compute tier and size of a server.
sourceServerResourceId	string	Identifier of the server to be used as the source of the new server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target server is a read replica.
state	string	Possible states of a server. Known values are: "Ready", "Dropping", "Disabled", "Starting", "Stopping", "Stopped", "Updating", "Restarting", "Inaccessible", and "Provisioning". (Ready, Dropping, Disabled, Starting, Stopping, Stopped, Updating, Restarting, Inaccessible, Provisioning)
storage	object	Storage properties of a server.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Major version of PostgreSQL database engine. Known values are: "18", "17", "16", "15", "14", "13", "12", and "11". (18, 17, 16, 15, 14, 13, 12, 11)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_server	select	resource_group_name, server_name, subscription_id		Lists all read replicas of a server.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

list_by_server

Lists all read replicas of a server.

SELECT
id,
name,
administratorLogin,
administratorLoginPassword,
authConfig,
availabilityZone,
backup,
cluster,
createMode,
dataEncryption,
fullyQualifiedDomainName,
highAvailability,
identity,
location,
maintenanceWindow,
minorVersion,
network,
pointInTimeUTC,
privateEndpointConnections,
replica,
replicaCapacity,
replicationRole,
sku,
sourceServerResourceId,
state,
storage,
systemData,
tags,
type,
version
FROM azure.postgresql_flexible_servers.replicas
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;