servers

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

Overview

Name	servers
Type	Resource
Id	azure.cosmosdb_for_postgresql.servers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
administratorLogin	string	The administrator's login name of the servers in the cluster.
availabilityZone	string	Availability Zone information of the server.
citusVersion	string	The Citus extension version of server.
enableHa	boolean	If high availability (HA) is enabled or not for the server.
enablePublicIpAccess	boolean	If public access is enabled on server.
fullyQualifiedDomainName	string	The fully qualified domain name of a server.
haState	string	A state of HA feature for the cluster.
isReadOnly	boolean	If server database is set to read-only by system maintenance depending on high disk space usage.
postgresqlVersion	string	The major PostgreSQL version of server.
role	string	The role of server in the cluster. Known values are: "Coordinator" and "Worker".
serverEdition	string	The edition of a server.
state	string	A state of a cluster/server that is visible to user.
storageQuotaInMb	integer	The storage of a server in MB.
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".
vCores	integer	The vCores count of a server.

list_by_cluster

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
administratorLogin	string	The administrator's login name of the servers in the cluster.
availabilityZone	string	Availability Zone information of the server.
citusVersion	string	The Citus extension version of server.
enableHa	boolean	If high availability (HA) is enabled or not for the server.
enablePublicIpAccess	boolean	If public access is enabled on server.
fullyQualifiedDomainName	string	The fully qualified domain name of a server.
haState	string	A state of HA feature for the cluster.
isReadOnly	boolean	If server database is set to read-only by system maintenance depending on high disk space usage.
postgresqlVersion	string	The major PostgreSQL version of server.
role	string	The role of server in the cluster. Known values are: "Coordinator" and "Worker".
serverEdition	string	The edition of a server.
state	string	A state of a cluster/server that is visible to user.
storageQuotaInMb	integer	The storage of a server in MB.
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".
vCores	integer	The vCores count of a server.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, server_name, subscription_id		Gets information about a server in cluster.
list_by_cluster	select	resource_group_name, cluster_name, subscription_id		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
cluster_name	string	The name of the cluster. Required.
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

get

Gets information about a server in cluster.

SELECT
id,
name,
administratorLogin,
availabilityZone,
citusVersion,
enableHa,
enablePublicIpAccess,
fullyQualifiedDomainName,
haState,
isReadOnly,
postgresqlVersion,
role,
serverEdition,
state,
storageQuotaInMb,
systemData,
type,
vCores
FROM azure.cosmosdb_for_postgresql.servers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_cluster

Lists servers of a cluster.

SELECT
id,
name,
administratorLogin,
availabilityZone,
citusVersion,
enableHa,
enablePublicIpAccess,
fullyQualifiedDomainName,
haState,
isReadOnly,
postgresqlVersion,
role,
serverEdition,
state,
storageQuotaInMb,
systemData,
type,
vCores
FROM azure.cosmosdb_for_postgresql.servers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;