replicas

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

Overview

Name	replicas
Type	Resource
Id	azure.mongo_cluster.replicas

Fields

The following fields are returned by SELECT queries:

list_by_parent

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.
administrator	object	The local administrator properties for the mongo cluster.
authConfig	object	The authentication configuration for the cluster.
backup	object	The backup properties of the mongo cluster.
clusterStatus	string	The status of the mongo cluster. Known values are: "Ready", "Provisioning", "Updating", "Starting", "Stopping", "Stopped", and "Dropping". (Ready, Provisioning, Updating, Starting, Stopping, Stopped, Dropping)
compute	object	The compute properties of the mongo cluster.
connectionString	string	The default mongo connection string for the cluster.
createMode	string	The mode to create a mongo cluster. Known values are: "Default", "PointInTimeRestore", "GeoReplica", and "Replica". (Default, PointInTimeRestore, GeoReplica, Replica)
dataApi	object	The Data API properties of the mongo cluster.
encryption	object	The encryption configuration for the cluster. Depends on identity being configured.
highAvailability	object	The high availability properties of the mongo cluster.
infrastructureVersion	string	The infrastructure version the cluster is provisioned on.
networkBypassMode	string	The network bypass mode for the cluster. Setting to 'AzureCosmosDB' allows Azure Cosmos DB service to bypass network restrictions. Known values are: "None" and "AzureCosmosDB". (None, AzureCosmosDB)
previewFeatures	array	List of private endpoint connections.
privateEndpointConnections	array	List of private endpoint connections.
provisioningState	string	The provisioning state of the mongo cluster. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", "Updating", and "Dropping". (Succeeded, Failed, Canceled, InProgress, Updating, Dropping)
publicNetworkAccess	string	Whether or not public endpoint access is allowed for this mongo cluster. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
replica	object	The replication properties for the mongo cluster.
replicaParameters	object	The parameters to create a replica mongo cluster.
restoreParameters	object	The parameters to create a point-in-time restore mongo cluster.
serverVersion	string	The Mongo DB server version. Defaults to the latest available version if not specified.
sharding	object	The sharding properties of the mongo cluster.
storage	object	The storage properties of the mongo cluster.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_parent	select	resource_group_name, mongo_cluster_name, subscription_id		List all the replicas for the mongo cluster.

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
mongo_cluster_name	string	The name of the mongo cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

list_by_parent

List all the replicas for the mongo cluster.

SELECT
id,
name,
administrator,
authConfig,
backup,
clusterStatus,
compute,
connectionString,
createMode,
dataApi,
encryption,
highAvailability,
infrastructureVersion,
networkBypassMode,
previewFeatures,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
replica,
replicaParameters,
restoreParameters,
serverVersion,
sharding,
storage,
systemData,
type
FROM azure.mongo_cluster.replicas
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND mongo_cluster_name = '{{ mongo_cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;