Servers - Get
Gets information about a server in cluster.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/servers/{serverName}?api-version=2023-03-02-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
cluster
|
path | True |
string |
The name of the cluster. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
server
|
path | True |
string |
The name of the server. Regex pattern: |
subscription
|
path | True |
string uuid |
The ID of the target subscription. The value must be an UUID. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Impersonate your user account. |
Examples
Get the server of cluster
Sample request
GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1/servers/testcluster1-c?api-version=2023-03-02-preview
Sample response
{
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1/servers/testcluster1-c",
"name": "testcluster1-c",
"type": "Microsoft.DBforPostgreSQL/serverGroupsv2/servers",
"systemData": {
"createdBy": "user1",
"createdByType": "User",
"createdAt": "2020-01-01T17:18:19.1234567Z",
"lastModifiedBy": "user2",
"lastModifiedByType": "User",
"lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
},
"properties": {
"fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com",
"postgresqlVersion": "12",
"citusVersion": "9.5",
"availabilityZone": "1",
"role": "Coordinator",
"serverEdition": "MemoryOptimized",
"storageQuotaInMb": 10000,
"vCores": 4,
"enableHa": true,
"enablePublicIpAccess": true,
"state": "Ready",
"haState": "Healthy",
"administratorLogin": "citus",
"isReadOnly": false
}
}
Definitions
Name | Description |
---|---|
Cluster |
Represents a server in a cluster. |
created |
The type of identity that created the resource. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Server |
The role of a server. |
system |
Metadata pertaining to creation and last modification of the resource. |
ClusterServer
Represents a server in a cluster.
Name | Type | 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 |
properties.administratorLogin |
string |
The administrator's login name of the servers in the cluster. |
properties.availabilityZone |
string |
Availability Zone information of the server. |
properties.citusVersion |
string |
The Citus extension version of server. |
properties.enableHa |
boolean |
If high availability (HA) is enabled or not for the server. |
properties.enablePublicIpAccess |
boolean |
If public access is enabled on server. |
properties.fullyQualifiedDomainName |
string |
The fully qualified domain name of a server. |
properties.haState |
string |
A state of HA feature for the cluster. |
properties.isReadOnly |
boolean |
If server database is set to read-only by system maintenance depending on high disk space usage. |
properties.postgresqlVersion |
string |
The major PostgreSQL version of server. |
properties.role |
The role of server in the cluster. |
|
properties.serverEdition |
string |
The edition of a server. |
properties.state |
string |
A state of a cluster/server that is visible to user. |
properties.storageQuotaInMb |
integer |
The storage of a server in MB. |
properties.vCores |
integer |
The vCores count of a server. |
systemData |
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" |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
ServerRole
The role of a server.
Name | Type | Description |
---|---|---|
Coordinator |
string |
|
Worker |
string |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |