servers

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

Overview

Name	servers
Type	Resource
Id	azure.postgresql_hsc.servers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The properties of a server in a cluster.

list_by_cluster

Name	Datatype	Description
properties	object	The properties of a server in a cluster.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, serverName		Gets information about a server in cluster.
list_by_cluster	select	subscriptionId, resourceGroupName, clusterName		Lists servers of a 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
clusterName	string	The name of the cluster.
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

get

Gets information about a server in cluster.

SELECT
properties
FROM azure.postgresql_hsc.servers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND serverName = '{{ serverName }}' -- required
;

list_by_cluster

Lists servers of a cluster.

SELECT
properties
FROM azure.postgresql_hsc.servers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;