replicas

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

Overview

Name	replicas
Type	Resource
Id	azure_extras.rdbms.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}. # pylint: disable=line-too-long
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).
byokEnforcement	string	Status showing whether the server data encryption is enabled with customer-managed keys.
earliestRestoreDate	string (date-time)	Earliest restore point creation time (ISO8601 format).
fullyQualifiedDomainName	string	The fully qualified domain name of a server.
identity	object	The Azure Active Directory identity of the server.
infrastructureEncryption	string	Status showing whether the server enabled infrastructure encryption. Known values are: "Enabled" and "Disabled".
location	string	The geo-location where the resource lives. Required.
masterServerId	string	The master server id of a replica server.
minimalTlsVersion	string	Enforce a minimal Tls version for the server. Known values are: "TLS1_0", "TLS1_1", "TLS1_2", and "TLSEnforcementDisabled".
privateEndpointConnections	array	List of private endpoint connections on a server.
publicNetworkAccess	string	Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled".
replicaCapacity	integer	The maximum number of replicas that a master server can have.
replicationRole	string	The replication role of the server.
sku	object	The SKU (pricing tier) of the server.
sslEnforcement	string	Enable ssl enforcement or not when connect to server. Known values are: "Enabled" and "Disabled".
storageProfile	object	Storage profile of a server.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userVisibleState	string	A state of a server that is visible to user. Known values are: "Ready", "Dropping", "Disabled", and "Inaccessible".
version	string	Server version. Known values are: "9.5", "9.6", "10", "10.0", "10.2", and "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		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,
byokEnforcement,
earliestRestoreDate,
fullyQualifiedDomainName,
identity,
infrastructureEncryption,
location,
masterServerId,
minimalTlsVersion,
privateEndpointConnections,
publicNetworkAccess,
replicaCapacity,
replicationRole,
sku,
sslEnforcement,
storageProfile,
tags,
type,
userVisibleState,
version
FROM azure_extras.rdbms.replicas
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;