replicas

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

Overview

Name	replicas
Type	Resource
Id	azure.mysql_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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
administratorLogin	string	The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
administratorLoginPassword	string	The password of the administrator login (required for server creation).
availabilityZone	string	availability Zone information of the server.
backup	object	Backup related properties of a server.
createMode	string	The mode to create a new MySQL server. Known values are: "Default", "PointInTimeRestore", "Replica", and "GeoRestore".
dataEncryption	object	The Data Encryption for CMK.
databasePort	integer	The server database port. Can only be specified when the server is being created.
fullVersion	string	Major version and actual engine version.
fullyQualifiedDomainName	string	The fully qualified domain name of a server.
highAvailability	object	High availability related properties of a server.
identity	object	The cmk identity for the server.
importSourceProperties	object	Source properties for import from storage.
location	string	The geo-location where the resource lives. Required.
lowerCaseTableNames	integer	The mysql parameter lower_case_table_names. Can only be specified when the server is being created. Allowed values 1 or 2.
maintenancePolicy	object	Maintenance policy of a server.
maintenanceWindow	object	Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately.
network	object	Network related properties of a server.
privateEndpointConnections	array	PrivateEndpointConnections related properties of a server.
replicaCapacity	integer	The maximum number of replicas that a primary server can have.
replicationRole	string	The replication role. Known values are: "None", "Source", and "Replica".
restorePointInTime	string (date-time)	Restore point creation time (ISO8601 format), specifying the time to restore from.
sku	object	The SKU (pricing tier) of the server.
sourceServerResourceId	string	The source MySQL server id.
state	string	The state of a server. Known values are: "Ready", "Dropping", "Disabled", "Starting", "Stopping", "Stopped", and "Updating".
storage	object	Storage related 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 MySQL. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7. Known values are: "5.7", "8.0.21", and "8.4".

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		List all the replicas for a given 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

List all the replicas for a given server.

SELECT
id,
name,
administratorLogin,
administratorLoginPassword,
availabilityZone,
backup,
createMode,
dataEncryption,
databasePort,
fullVersion,
fullyQualifiedDomainName,
highAvailability,
identity,
importSourceProperties,
location,
lowerCaseTableNames,
maintenancePolicy,
maintenanceWindow,
network,
privateEndpointConnections,
replicaCapacity,
replicationRole,
restorePointInTime,
sku,
sourceServerResourceId,
state,
storage,
systemData,
tags,
type,
version
FROM azure.mysql_flexible_servers.replicas
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;