Servers - List By Resource Group

Servizio:: PostgreSQL

Versione API:: 2021-06-01

Elencare tutti i server in un determinato gruppo di risorse.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	ServerListResult	Va bene
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ServerListByResourceGroup

Esempio di richiesta

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

import com.azure.core.util.Context;

/** Samples for Servers ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerListByResourceGroup.json
     */
    /**
     * Sample code: ServerListByResourceGroup.
     *
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void serverListByResourceGroup(
        com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        manager.servers().listByResourceGroup("testrg", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armpostgresqlflexibleservers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/postgresql/armpostgresqlflexibleservers"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerListByResourceGroup.json
func ExampleServersClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armpostgresqlflexibleservers.NewServersClient("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("testrg",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { PostgreSQLManagementFlexibleServerClient } = require("@azure/arm-postgresql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List all the servers in a given resource group.
 *
 * @summary List all the servers in a given resource group.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerListByResourceGroup.json
 */
async function serverListByResourceGroup() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "testrg";
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.servers.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Risposta di esempio

Codice di stato:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2021-06-01&$top=3&$skiptoken=skiptoken",
  "value": [
    {
      "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
        },
        "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"
        }
      },
      "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"
    },
    {
      "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
        },
        "backup": {
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled",
          "earliestRestoreDate": "2021-05-26T23:15:38.8131437+00:00"
        },
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        }
      },
      "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"
    }
  ]
}

Definizioni

Nome	Descrizione
Backup	Proprietà di backup di un server
CloudError	Risposta di errore dal servizio Batch.
createdByType	Tipo di identità che ha creato la risorsa.
CreateMode	Modalità per creare un nuovo server PostgreSQL.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorResponse	Risposta di errore
GeoRedundantBackupEnum	Valore che indica se Geo-Redundant backup è abilitato nel server.
HighAvailability	Proprietà a disponibilità elevata di un server
HighAvailabilityMode	Modalità a disponibilità elevata per il server.
MaintenanceWindow	Proprietà della finestra di manutenzione di un server.
Network	Proprietà di rete di un server
Server	Rappresenta un server.
ServerHAState	Stato di un server a disponibilità elevata visibile all'utente.
ServerListResult	Elenco di server.
ServerPublicNetworkAccessState	l'accesso alla rete pubblica è abilitato o meno
ServerState	Stato di un server visibile all'utente.
ServerVersion	Versione di un server.
Sku	Informazioni sullo SKU relative alle proprietà di un server.
SkuTier	Livello dello SKU specifico, ad esempio Burstable.
Storage	Proprietà di archiviazione di un server
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

Backup

Object

Proprietà di backup di un server

Nome	Tipo	Valore predefinito	Descrizione
backupRetentionDays	integer (int32)	7	Giorni di conservazione dei backup per il server.
earliestRestoreDate	string (date-time)		Ora del punto di ripristino meno recente (formato ISO8601) per il server.
geoRedundantBackup	GeoRedundantBackupEnum	Disabled	Valore che indica se Geo-Redundant backup è abilitato nel server.

CloudError

Object

Risposta di errore dal servizio Batch.

Nome	Tipo	Descrizione
error	ErrorResponse	Risposta di errore Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

CreateMode

Enumerazione

Modalità per creare un nuovo server PostgreSQL.

Valore	Descrizione
Default
Create
Update
PointInTimeRestore

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorResponse[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

GeoRedundantBackupEnum

Enumerazione

Valore che indica se Geo-Redundant backup è abilitato nel server.

Valore	Descrizione
Enabled
Disabled

HighAvailability

Object

Proprietà a disponibilità elevata di un server

Nome	Tipo	Valore predefinito	Descrizione
mode	HighAvailabilityMode	Disabled	Modalità a disponibilità elevata per il server.
standbyAvailabilityZone	string		informazioni sulla zona di disponibilità dello standby.
state	ServerHAState		Stato di un server a disponibilità elevata visibile all'utente.

HighAvailabilityMode

Enumerazione

Modalità a disponibilità elevata per il server.

Valore	Descrizione
Disabled
ZoneRedundant

MaintenanceWindow

Object

Proprietà della finestra di manutenzione di un server.

Nome	Tipo	Valore predefinito	Descrizione
customWindow	string	Disabled	indica se la finestra personalizzata è abilitata o disabilitata
dayOfWeek	integer (int32)	0	giorno della settimana per la finestra di manutenzione
startHour	integer (int32)	0	ora di inizio per la finestra di manutenzione
startMinute	integer (int32)	0	inizio minuto per la finestra di manutenzione

Network

Object

Proprietà di rete di un server

Nome	Tipo	Descrizione
delegatedSubnetResourceId	string (arm-id)	ID risorsa arm della subnet delegata.
privateDnsZoneArmResourceId	string (arm-id)	ID risorsa arm della zona DNS privata.
publicNetworkAccess	ServerPublicNetworkAccessState	l'accesso alla rete pubblica è abilitato o meno

Server

Object

Rappresenta un server.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Posizione geografica in cui risiede la risorsa
name	string	Nome della risorsa
properties.administratorLogin	string	Nome di accesso dell'amministratore di un server. Può essere specificato solo quando il server viene creato (ed è necessario per la creazione).
properties.administratorLoginPassword	string (password)	Password di accesso dell'amministratore (necessaria per la creazione del server).
properties.availabilityZone	string	informazioni sulla zona di disponibilità del server.
properties.backup	Backup	Proprietà di backup di un server.
properties.createMode	CreateMode	Modalità per creare un nuovo server PostgreSQL.
properties.fullyQualifiedDomainName	string	Nome di dominio completo di un server.
properties.highAvailability	HighAvailability	Proprietà a disponibilità elevata di un server.
properties.maintenanceWindow	MaintenanceWindow	Proprietà della finestra di manutenzione di un server.
properties.minorVersion	string	Versione secondaria del server.
properties.network	Network	Proprietà di rete di un server.
properties.pointInTimeUTC	string (date-time)	Tempo di creazione del punto di ripristino (formato ISO8601), specificando il tempo da cui eseguire il ripristino. È necessario quando 'createMode' è 'PointInTimeRestore'.
properties.sourceServerResourceId	string (arm-id)	ID risorsa del server di origine da cui eseguire il ripristino. È necessario quando 'createMode' è 'PointInTimeRestore'.
properties.state	ServerState	Stato di un server visibile all'utente.
properties.storage	Storage	Proprietà di archiviazione di un server.
properties.version	ServerVersion	Versione del server PostgreSQL.
sku	Sku	SKU (piano tariffario) del server.
systemData	systemData	Metadati di sistema relativi a questa risorsa.
tags	object	Tag di risorsa.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ServerHAState

Enumerazione

Stato di un server a disponibilità elevata visibile all'utente.

Valore	Descrizione
NotEnabled
CreatingStandby
ReplicatingData
FailingOver
Healthy
RemovingStandby

ServerListResult

Object

Elenco di server.

Nome	Tipo	Descrizione
nextLink	string	Collegamento utilizzato per ottenere la pagina successiva delle operazioni.
value	Server[]	Elenco di server flessibili

ServerPublicNetworkAccessState

Enumerazione

l'accesso alla rete pubblica è abilitato o meno

Valore	Descrizione
Enabled
Disabled

ServerState

Enumerazione

Stato di un server visibile all'utente.

Valore	Descrizione
Ready
Dropping
Disabled
Starting
Stopping
Stopped
Updating

ServerVersion

Enumerazione

Versione di un server.

Valore	Descrizione
14
13
12
11

Sku

Object

Informazioni sullo SKU relative alle proprietà di un server.

Nome	Tipo	Descrizione
name	string	Nome dello SKU, in genere, tier + family + core, ad esempio Standard_D4s_v3.
tier	SkuTier	Livello dello SKU specifico, ad esempio Burstable.

SkuTier

Enumerazione

Livello dello SKU specifico, ad esempio Burstable.

Valore	Descrizione
Burstable
GeneralPurpose
MemoryOptimized

Storage

Object

Proprietà di archiviazione di un server

Nome	Tipo	Descrizione
storageSizeGB	integer (int32)	Spazio di archiviazione massimo consentito per un server.

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.