replicas
Creates, updates, deletes, gets or lists a replicas
resource.
Overview
Name | replicas |
Type | Resource |
Id | azure.postgresql.replicas |
Fields
The following fields are returned by SELECT
queries:
- list_by_server
Name | Datatype | Description |
---|---|---|
identity | object | Describes the identity of the application. |
location | string | The geo-location where the resource lives |
properties | object | Properties of the server. |
sku | object | Sku information related properties of a server. |
tags | object | Resource tags. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
list_by_server | select | subscriptionId , resourceGroupName , serverName | 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 |
---|---|---|
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
serverName | string | The name of the server. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
SELECT
examples
- list_by_server
List all the replicas for a given server.
SELECT
identity,
location,
properties,
sku,
tags
FROM azure.postgresql.replicas
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
;