Partager via

Servers - Get

  • Référence
Service:
PostgreSQL
Version d'API:
2022-12-01

Obtient des informations sur un serveur.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}?api-version=2022-12-01

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
 path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.
serverName
 path True

string

Le nom du serveur

Modèle d’expression régulière: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*
subscriptionId
 path True

string

ID de l’abonnement cible.
api-version
 query True

string

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

Server

Ok
Other Status Codes

ErrorResponse

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

ServerGet
ServerGetWithVnet

ServerGet

Exemple de requête

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1?api-version=2022-12-01

Exemple de réponse

Code d’état:
200 
{
  "sku": {
    "name": "Standard_D4s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "storage": {
      "storageSizeGB": 512
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00"
    },
    "network": {
      "publicNetworkAccess": "Enabled"
    },
    "highAvailability": {
      "mode": "Disabled",
      "state": "NotEnabled"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1",
  "name": "pgtestsvc1",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

ServerGetWithVnet

Exemple de requête

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4?api-version=2022-12-01

Exemple de réponse

Code d’état:
200 
{
  "sku": {
    "name": "Standard_D4s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "storage": {
      "storageSizeGB": 512
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4",
  "name": "pgtestsvc4",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

Définitions

Nom Description
activeDirectoryAuthEnum

Si cette option est activée, l’authentification Azure Active Directory est activée.
ArmServerKeyType

Type de chiffrement de données pour représenter s’il s’agit d’un coffre géré par le système ou d’Azure Key Vault.
AuthConfig

Propriétés AuthConfig d’un serveur.
Backup

Propriétés de sauvegarde d’un serveur.
createdByType

Type d’identité qui a créé la ressource.
CreateMode

Mode pour créer un serveur PostgreSQL.
DataEncryption

Propriétés de chiffrement des données d’un serveur.
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
GeoRedundantBackupEnum

Valeur indiquant si Geo-Redundant sauvegarde est activée sur le serveur.
HighAvailability

Propriétés de haute disponibilité d’un serveur.
HighAvailabilityMode

Mode haute disponibilité pour le serveur.
IdentityType

les types d’identités associés à cette ressource ; actuellement limité à « None and UserAssigned »
MaintenanceWindow

Propriétés de la fenêtre de maintenance d’un serveur.
Network

Propriétés réseau d’un serveur. Cette propriété Network doit être transmise uniquement si vous souhaitez que le serveur soit un serveur d’accès privé.
passwordAuthEnum

Si cette option est activée, l’authentification par mot de passe est activée.
ReplicationRole

Rôle de réplication du serveur
Server

Représente un serveur.
ServerHAState

État d’un serveur à haute disponibilité visible par l’utilisateur.
ServerPublicNetworkAccessState

l’accès au réseau public est activé ou non
ServerState

État d’un serveur visible par l’utilisateur.
ServerVersion

Version du serveur PostgreSQL.
Sku

Référence SKU (niveau tarifaire) du serveur.
SkuTier

Niveau de la référence SKU particulière, par exemple Burstable.
Storage

Propriétés de stockage d’un serveur.
systemData

Métadonnées système relatives à cette ressource.
UserAssignedIdentity

Décrit l’identité de l’application.
UserIdentity

Décrit une identité affectée par l’utilisateur unique associée à l’application.

activeDirectoryAuthEnum

Si cette option est activée, l’authentification Azure Active Directory est activée.

Nom Type Description
Disabled

string

Enabled

string

ArmServerKeyType

Type de chiffrement de données pour représenter s’il s’agit d’un coffre géré par le système ou d’Azure Key Vault.

Nom Type Description
AzureKeyVault

string

SystemManaged

string

AuthConfig

Propriétés AuthConfig d’un serveur.

Nom Type Valeur par défaut Description
activeDirectoryAuth

activeDirectoryAuthEnum

Si cette option est activée, l’authentification Azure Active Directory est activée.
passwordAuth

passwordAuthEnum

Enabled

Si cette option est activée, l’authentification par mot de passe est activée.
tenantId

string

ID de locataire du serveur.

Backup

Propriétés de sauvegarde d’un serveur.

Nom Type Valeur par défaut Description
backupRetentionDays

integer

7

Jours de rétention des sauvegardes pour le serveur.
earliestRestoreDate

string

Heure de point de restauration la plus ancienne (format ISO8601) pour le serveur.
geoRedundantBackup

GeoRedundantBackupEnum

Disabled

Valeur indiquant si Geo-Redundant sauvegarde est activée sur le serveur.

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

CreateMode

Mode pour créer un serveur PostgreSQL.

Nom Type Description
Create

string

Default

string

GeoRestore

string

PointInTimeRestore

string

Replica

string

Update

string

DataEncryption

Propriétés de chiffrement des données d’un serveur.

Nom Type Description
primaryKeyURI

string

URI de la clé pour le chiffrement des données pour le serveur principal.
primaryUserAssignedIdentityId

string

ID de ressource de l’identité affectée par l’utilisateur à utiliser pour le chiffrement des données pour le serveur principal.
type

ArmServerKeyType

Type de chiffrement de données pour représenter s’il s’agit d’un coffre géré par le système ou d’Azure Key Vault.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires
type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d'erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet error.

GeoRedundantBackupEnum

Valeur indiquant si Geo-Redundant sauvegarde est activée sur le serveur.

Nom Type Description
Disabled

string

Enabled

string

HighAvailability

Propriétés de haute disponibilité d’un serveur.

Nom Type Valeur par défaut Description
mode

HighAvailabilityMode

Disabled

Mode haute disponibilité pour le serveur.
standbyAvailabilityZone

string

informations sur la zone de disponibilité du serveur de secours.
state

ServerHAState

État d’un serveur à haute disponibilité visible par l’utilisateur.

HighAvailabilityMode

Mode haute disponibilité pour le serveur.

Nom Type Description
Disabled

string

SameZone

string

ZoneRedundant

string

IdentityType

les types d’identités associés à cette ressource ; actuellement limité à « None and UserAssigned »

Nom Type Description
None

string

UserAssigned

string

MaintenanceWindow

Propriétés de la fenêtre de maintenance d’un serveur.

Nom Type Valeur par défaut Description
customWindow

string

Disabled

indique si la fenêtre personnalisée est activée ou désactivée
dayOfWeek

integer

0

jour de la semaine pour la fenêtre de maintenance
startHour

integer

0

heure de début de la fenêtre de maintenance
startMinute

integer

0

minute de démarrage pour la fenêtre de maintenance

Network

Propriétés réseau d’un serveur. Cette propriété Network doit être transmise uniquement si vous souhaitez que le serveur soit un serveur d’accès privé.

Nom Type Description
delegatedSubnetResourceId

string

ID de ressource arm de sous-réseau délégué. Cela doit être passé lors de la création, au cas où nous voulons que le serveur soit injecté sur un réseau virtuel, c’est-à-dire un serveur d’accès privé. Pendant la mise à jour, transmettez-le uniquement si nous voulons mettre à jour la valeur de DNS privé zone.
privateDnsZoneArmResourceId

string

ID de ressource arm de zone DNS privée. Cela doit être passé lors de la création, au cas où nous voulons que le serveur soit injecté sur un réseau virtuel, c’est-à-dire un serveur d’accès privé. Pendant la mise à jour, transmettez-le uniquement si nous voulons mettre à jour la valeur de DNS privé zone.
publicNetworkAccess

ServerPublicNetworkAccessState

l’accès au réseau public est activé ou non

passwordAuthEnum

Si cette option est activée, l’authentification par mot de passe est activée.

Nom Type Description
Disabled

string

Enabled

string

ReplicationRole

Rôle de réplication du serveur

Nom Type Description
AsyncReplica

string

GeoAsyncReplica

string

None

string

Primary

string

Server

Représente un serveur.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

UserAssignedIdentity

Décrit l’identité de l’application.
location

string

Emplacement géographique où réside la ressource
name

string

nom de la ressource.
properties.administratorLogin

string

Nom de connexion de l’administrateur d’un serveur. Peut être spécifié uniquement lors de la création du serveur (et est requis pour la création).
properties.administratorLoginPassword

string

Mot de passe de connexion administrateur (requis pour la création du serveur).
properties.authConfig

AuthConfig

Propriétés AuthConfig d’un serveur.
properties.availabilityZone

string

informations sur la zone de disponibilité du serveur.
properties.backup

Backup

Propriétés de sauvegarde d’un serveur.
properties.createMode

CreateMode

Mode pour créer un serveur PostgreSQL.
properties.dataEncryption

DataEncryption

Propriétés de chiffrement des données d’un serveur.
properties.fullyQualifiedDomainName

string

Nom de domaine complet d’un serveur.
properties.highAvailability

HighAvailability

Propriétés de haute disponibilité d’un serveur.
properties.maintenanceWindow

MaintenanceWindow

Propriétés de la fenêtre de maintenance d’un serveur.
properties.minorVersion

string

Version mineure du serveur.
properties.network

Network

Propriétés réseau d’un serveur. Cette propriété Network doit être transmise uniquement si vous souhaitez que le serveur soit un serveur d’accès privé.
properties.pointInTimeUTC

string

Heure de création du point de restauration (format ISO8601), en spécifiant l’heure à partir de laquelle effectuer la restauration. Elle est obligatoire lorsque « createMode » est « PointInTimeRestore » ou « GeoRestore ».
properties.replicaCapacity

integer

Réplicas autorisés pour un serveur.
properties.replicationRole

ReplicationRole

Rôle de réplication du serveur
properties.sourceServerResourceId

string

ID de ressource du serveur source à partir duquel effectuer la restauration. Elle est obligatoire lorsque « createMode » est « PointInTimeRestore » ou « GeoRestore » ou « Replica ». Cette propriété est retournée uniquement pour le serveur réplica
properties.state

ServerState

État d’un serveur visible par l’utilisateur.
properties.storage

Storage

Propriétés de stockage d’un serveur.
properties.version

ServerVersion

Version du serveur PostgreSQL.
sku

Sku

Référence SKU (niveau tarifaire) du serveur.
systemData

systemData

Métadonnées système relatives à cette ressource.
tags

object

Balises de ressource.
type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ServerHAState

État d’un serveur à haute disponibilité visible par l’utilisateur.

Nom Type Description
CreatingStandby

string

FailingOver

string

Healthy

string

NotEnabled

string

RemovingStandby

string

ReplicatingData

string

ServerPublicNetworkAccessState

l’accès au réseau public est activé ou non

Nom Type Description
Disabled

string

Enabled

string

ServerState

État d’un serveur visible par l’utilisateur.

Nom Type Description
Disabled

string

Dropping

string

Ready

string

Starting

string

Stopped

string

Stopping

string

Updating

string

ServerVersion

Version du serveur PostgreSQL.

Nom Type Description
11

string

12

string

13

string

14

string

Sku

Référence SKU (niveau tarifaire) du serveur.

Nom Type Description
name

string

Nom de la référence SKU, généralement niveau + famille + cœurs, par exemple Standard_D4s_v3.
tier

SkuTier

Niveau de la référence SKU particulière, par exemple Burstable.

SkuTier

Niveau de la référence SKU particulière, par exemple Burstable.

Nom Type Description
Burstable

string

GeneralPurpose

string

MemoryOptimized

string

Storage

Propriétés de stockage d’un serveur.

Nom Type Description
storageSizeGB

integer

Stockage maximal autorisé pour un serveur.

systemData

Métadonnées système relatives à cette ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).
createdBy

string

Identité qui a créé la ressource.
createdByType

createdByType

Type d’identité qui a créé la ressource.
lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.

UserAssignedIdentity

Décrit l’identité de l’application.

Nom Type Description
tenantId

string

ID de locataire du serveur.
type

IdentityType

les types d’identités associés à cette ressource ; actuellement limité à « None and UserAssigned »
userAssignedIdentities

<string,  UserIdentity>

représente la carte des identités affectées par l’utilisateur.

UserIdentity

Décrit une identité affectée par l’utilisateur unique associée à l’application.

Nom Type Description
clientId

string

identificateur client du principal de service que cette identité représente.
principalId

string

identificateur d’objet du principal de service que cette identité représente.