replicas
Creates, updates, deletes, gets or lists a replicas resource.
Overview
| Name | replicas |
| Type | Resource |
| Id | azure_isv.mongo_db.replicas |
Fields
The following fields are returned by SELECT queries:
- list_by_parent
Azure operation completed successfully.
| Name | Datatype | Description |
|---|---|---|
properties | object | The resource-specific properties for this resource. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_by_parent | select | subscriptionId, resourceGroupName, mongoClusterName | 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 |
|---|---|---|
mongoClusterName | string | The name of the mongo cluster. |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
SELECT examples
- list_by_parent
List all the replicas for the mongo cluster.
SELECT
properties
FROM azure_isv.mongo_db.replicas
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND mongoClusterName = '{{ mongoClusterName }}' -- required
;