Replicas - List By Server

Reference

Služba:: PostgreSQL

Verze rozhraní API:: 2022-12-01

Vypište všechny repliky pro daný server.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
serverName	path	True	string	Název serveru. Vzor regulárního výrazu: `^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*`
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	ServerListResult	OK
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ReplicasListByServer

Ukázkový požadavek

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

/** Samples for Replicas ListByServer. */
public final class Main {
    /*
     * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-12-01/examples/ReplicasListByServer.json
     */
    /**
     * Sample code: ReplicasListByServer.
     *
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void replicasListByServer(
        com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        manager.replicas().listByServer("testrg", "sourcepgservername", com.azure.core.util.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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/75ece9197dbac70ac0ba651c53a79c1841944be2/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-12-01/examples/ReplicasListByServer.json
func ExampleReplicasClient_NewListByServerPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpostgresqlflexibleservers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewReplicasClient().NewListByServerPager("testrg", "sourcepgservername", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ServerListResult = armpostgresqlflexibleservers.ServerListResult{
		// 	Value: []*armpostgresqlflexibleservers.Server{
		// 		{
		// 			Name: to.Ptr("pgtestsvc5rep"),
		// 			Type: to.Ptr("Microsoft.DBforPostgreSQL/flexibleServers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5rep"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 				"ElasticServer": to.Ptr("1"),
		// 			},
		// 			Properties: &armpostgresqlflexibleservers.ServerProperties{
		// 				AdministratorLogin: to.Ptr("cloudsa"),
		// 				AuthConfig: &armpostgresqlflexibleservers.AuthConfig{
		// 					ActiveDirectoryAuth: to.Ptr(armpostgresqlflexibleservers.ActiveDirectoryAuthEnumDisabled),
		// 					PasswordAuth: to.Ptr(armpostgresqlflexibleservers.PasswordAuthEnumEnabled),
		// 				},
		// 				AvailabilityZone: to.Ptr("2"),
		// 				Backup: &armpostgresqlflexibleservers.Backup{
		// 					BackupRetentionDays: to.Ptr[int32](7),
		// 					EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-27T00:28:17.727Z"); return t}()),
		// 					GeoRedundantBackup: to.Ptr(armpostgresqlflexibleservers.GeoRedundantBackupEnumDisabled),
		// 				},
		// 				DataEncryption: &armpostgresqlflexibleservers.DataEncryption{
		// 					Type: to.Ptr(armpostgresqlflexibleservers.ArmServerKeyTypeSystemManaged),
		// 				},
		// 				FullyQualifiedDomainName: to.Ptr("pgtestsvc5rep.postgres.database.azure.com"),
		// 				HighAvailability: &armpostgresqlflexibleservers.HighAvailability{
		// 					Mode: to.Ptr(armpostgresqlflexibleservers.HighAvailabilityModeDisabled),
		// 					State: to.Ptr(armpostgresqlflexibleservers.ServerHAStateNotEnabled),
		// 				},
		// 				MaintenanceWindow: &armpostgresqlflexibleservers.MaintenanceWindow{
		// 					CustomWindow: to.Ptr("Disabled"),
		// 					DayOfWeek: to.Ptr[int32](0),
		// 					StartHour: to.Ptr[int32](0),
		// 					StartMinute: to.Ptr[int32](0),
		// 				},
		// 				MinorVersion: to.Ptr("6"),
		// 				Network: &armpostgresqlflexibleservers.Network{
		// 					PublicNetworkAccess: to.Ptr(armpostgresqlflexibleservers.ServerPublicNetworkAccessStateEnabled),
		// 				},
		// 				ReplicaCapacity: to.Ptr[int32](0),
		// 				ReplicationRole: to.Ptr(armpostgresqlflexibleservers.ReplicationRoleAsyncReplica),
		// 				State: to.Ptr(armpostgresqlflexibleservers.ServerStateReady),
		// 				Storage: &armpostgresqlflexibleservers.Storage{
		// 					StorageSizeGB: to.Ptr[int32](512),
		// 				},
		// 				Version: to.Ptr(armpostgresqlflexibleservers.ServerVersionTwelve),
		// 			},
		// 			SKU: &armpostgresqlflexibleservers.SKU{
		// 				Name: to.Ptr("Standard_D4s_v3"),
		// 				Tier: to.Ptr(armpostgresqlflexibleservers.SKUTierGeneralPurpose),
		// 			},
		// 	}},
		// }
	}
}

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 replicas for a given server.
 *
 * @summary List all the replicas for a given server.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-12-01/examples/ReplicasListByServer.json
 */
async function replicasListByServer() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "testrg";
  const serverName = "sourcepgservername";
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.replicas.listByServer(resourceGroupName, serverName)) {
    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

Ukázková odpověď

Stavový kód:: 200

{
  "value": [
    {
      "sku": {
        "name": "Standard_D4s_v3",
        "tier": "GeneralPurpose"
      },
      "properties": {
        "fullyQualifiedDomainName": "pgtestsvc5rep.postgres.database.azure.com",
        "version": "12",
        "minorVersion": "6",
        "administratorLogin": "cloudsa",
        "state": "Ready",
        "availabilityZone": "2",
        "storage": {
          "storageSizeGB": 512
        },
        "dataEncryption": {
          "type": "SystemManaged"
        },
        "authConfig": {
          "activeDirectoryAuth": "Disabled",
          "passwordAuth": "Enabled"
        },
        "backup": {
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled",
          "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00"
        },
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        },
        "maintenanceWindow": {
          "customWindow": "Disabled",
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0
        },
        "replicationRole": "AsyncReplica",
        "replicaCapacity": 0
      },
      "location": "westus",
      "tags": {
        "ElasticServer": "1"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5rep",
      "name": "pgtestsvc5rep",
      "type": "Microsoft.DBforPostgreSQL/flexibleServers"
    }
  ]
}

Definice

Name	Description
activeDirectoryAuthEnum	Pokud je povoleno, ověřování Azure Active Directory je povolené.
ArmServerKeyType	Typ šifrování dat, který znázorňuje, jestli se jedná o službu System Managed vs. Azure Key Vault.
AuthConfig	Vlastnosti konfigurace ověřování serveru
Backup	Vlastnosti zálohování serveru
createdByType	Typ identity, která vytvořila prostředek.
CreateMode	Režim pro vytvoření nového serveru PostgreSQL.
DataEncryption	Vlastnosti šifrování dat serveru
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď
GeoRedundantBackupEnum	Hodnota označující, jestli je na serveru povolené zálohování Geo-Redundant.
HighAvailability	Vlastnosti vysoké dostupnosti serveru
HighAvailabilityMode	Režim vysoké dostupnosti pro server.
IdentityType	typy identit přidružených k tomuto prostředku; v současné době je omezeno na žádné a přiřazené uživatele.
MaintenanceWindow	Vlastnosti časového období údržby serveru.
Network	Síťové vlastnosti serveru.
passwordAuthEnum	Pokud je povoleno, ověřování heslem je povolené.
ReplicationRole	Slouží k označení role serveru v sadě replikace.
Server	Představuje server.
ServerHAState	Stav serveru vysoké dostupnosti, který je viditelný pro uživatele.
ServerListResult	Seznam serverů.
ServerPublicNetworkAccessState	přístup z veřejné sítě je nebo není povolený
ServerState	Stav serveru, který je viditelný pro uživatele.
ServerVersion	Verze serveru.
Sku	Vlastnosti serveru související s informacemi o skladové pouce.
SkuTier	Úroveň konkrétní skladové položky, například nárazová.
Storage	Vlastnosti úložiště serveru
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
UserAssignedIdentity	Informace popisující identity přidružené k této aplikaci
UserIdentity	Popisuje jednu identitu přiřazenou uživatelem přidruženou k aplikaci.

activeDirectoryAuthEnum

Pokud je povoleno, ověřování Azure Active Directory je povolené.

Name	Typ	Description
Disabled	string
Enabled	string

ArmServerKeyType

Typ šifrování dat, který znázorňuje, jestli se jedná o službu System Managed vs. Azure Key Vault.

Name	Typ	Description
AzureKeyVault	string
SystemManaged	string

AuthConfig

Vlastnosti konfigurace ověřování serveru

Name	Typ	Default value	Description
activeDirectoryAuth	activeDirectoryAuthEnum		Pokud je povoleno, je povolené ověřování Azure Active Directory.
passwordAuth	passwordAuthEnum	Enabled	Pokud je povoleno, ověřování heslem je povolené.
tenantId	string		ID tenanta serveru.

Backup

Vlastnosti zálohování serveru

Name	Typ	Default value	Description
backupRetentionDays	integer	7	Dny uchovávání záloh pro server.
earliestRestoreDate	string		Nejstarší čas bodu obnovení (ISO8601 formát) pro server.
geoRedundantBackup	GeoRedundantBackupEnum	Disabled	Hodnota označující, jestli je na serveru povolené zálohování Geo-Redundant.

createdByType

Typ identity, která vytvořila prostředek.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Režim pro vytvoření nového serveru PostgreSQL.

Name	Typ	Description
Create	string
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string
Update	string

DataEncryption

Vlastnosti šifrování dat serveru

Name	Typ	Description
primaryKeyURI	string	Identifikátor URI pro klíč pro šifrování dat pro primární server.
primaryUserAssignedIdentityId	string	ID prostředku pro identitu přiřazenou uživatelem, která se má použít k šifrování dat na primárním serveru.
type	ArmServerKeyType	Typ šifrování dat, který znázorňuje, jestli se jedná o službu System Managed nebo Azure Key Vault.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

GeoRedundantBackupEnum

Hodnota označující, jestli je na serveru povolené zálohování Geo-Redundant.

Name	Typ	Description
Disabled	string
Enabled	string

HighAvailability

Vlastnosti vysoké dostupnosti serveru

Name	Typ	Default value	Description
mode	HighAvailabilityMode	Disabled	Režim vysoké dostupnosti pro server.
standbyAvailabilityZone	string		informace o zóně dostupnosti pohotovostního režimu.
state	ServerHAState		Stav serveru s vysokou dostupností, který je viditelný pro uživatele.

HighAvailabilityMode

Režim vysoké dostupnosti pro server.

Name	Typ	Description
Disabled	string
SameZone	string
ZoneRedundant	string

IdentityType

typy identit přidružených k tomuto prostředku; v současné době je omezeno na žádné a přiřazené uživatele.

Name	Typ	Description
None	string
UserAssigned	string

MaintenanceWindow

Vlastnosti časového období údržby serveru.

Name	Typ	Default value	Description
customWindow	string	Disabled	označuje, jestli je vlastní okno povolené nebo zakázané.
dayOfWeek	integer	0	den v týdnu pro časové období údržby
startHour	integer	0	počáteční hodina pro časové období údržby
startMinute	integer	0	počáteční minuta pro časové období údržby

Network

Síťové vlastnosti serveru.

Name	Typ	Description
delegatedSubnetResourceId	string	ID prostředku ARM delegovaného podsítě To se musí předat během vytváření, pokud chceme, aby byl server vložený do virtuální sítě, tj. server s privátním přístupem. Během aktualizace tuto možnost předejte pouze v případě, že chceme aktualizovat hodnotu pro Privátní DNS zónu.
privateDnsZoneArmResourceId	string	ID prostředku ARM zóny privátního DNS To se musí předat během vytváření, pokud chceme, aby byl server vložený do virtuální sítě, tj. server s privátním přístupem. Během aktualizace tuto možnost předejte pouze v případě, že chceme aktualizovat hodnotu pro Privátní DNS zónu.
publicNetworkAccess	ServerPublicNetworkAccessState	přístup z veřejné sítě je nebo není povolený

passwordAuthEnum

Pokud je povoleno, ověřování heslem je povolené.

Name	Typ	Description
Disabled	string
Enabled	string

ReplicationRole

Slouží k označení role serveru v sadě replikace.

Name	Typ	Description
AsyncReplica	string
GeoAsyncReplica	string
None	string
Primary	string

Server

Představuje server.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
identity	UserAssignedIdentity	Popisuje identitu aplikace.
location	string	Geografické umístění, kde se prostředek nachází
name	string	Název prostředku
properties.administratorLogin	string	Přihlašovací jméno správce serveru. Lze zadat pouze při vytváření serveru (a vyžaduje se k vytvoření).
properties.administratorLoginPassword	string	Přihlašovací heslo správce (vyžadované pro vytvoření serveru)
properties.authConfig	AuthConfig	Vlastnosti AuthConfig serveru.
properties.availabilityZone	string	informace o zóně dostupnosti serveru.
properties.backup	Backup	Vlastnosti zálohování serveru.
properties.createMode	CreateMode	Režim pro vytvoření nového serveru PostgreSQL.
properties.dataEncryption	DataEncryption	Vlastnosti šifrování dat serveru.
properties.fullyQualifiedDomainName	string	Plně kvalifikovaný název domény serveru.
properties.highAvailability	HighAvailability	Vlastnosti vysoké dostupnosti serveru.
properties.maintenanceWindow	MaintenanceWindow	Vlastnosti časového období údržby serveru.
properties.minorVersion	string	Podverze serveru.
properties.network	Network	Síťové vlastnosti serveru. Tato vlastnost Network musí být předána pouze v případě, že chcete, aby server byl serverem privátního přístupu.
properties.pointInTimeUTC	string	Čas vytvoření bodu obnovení (ISO8601 formát) a určení času, ze které se má provést obnovení. Vyžaduje se, když createMode je PointInTimeRestore nebo GeoRestore.
properties.replicaCapacity	integer	Repliky povolené pro server
properties.replicationRole	ReplicationRole	Role replikace serveru
properties.sourceServerResourceId	string	ID prostředku zdrojového serveru, ze které se má provést obnovení. Vyžaduje se, když createMode je PointInTimeRestore, GeoRestore nebo Replika. Tato vlastnost se vrátí jenom pro server repliky.
properties.state	ServerState	Stav serveru, který je viditelný pro uživatele.
properties.storage	Storage	Vlastnosti úložiště serveru.
properties.version	ServerVersion	Verze serveru PostgreSQL.
sku	Sku	Skladová položka (cenová úroveň) serveru.
systemData	systemData	Systémová metadata vztahující se k tomuto prostředku.
tags	object	Značky prostředků.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ServerHAState

Stav serveru vysoké dostupnosti, který je viditelný pro uživatele.

Name	Typ	Description
CreatingStandby	string
FailingOver	string
Healthy	string
NotEnabled	string
RemovingStandby	string
ReplicatingData	string

ServerListResult

Seznam serverů.

Name	Typ	Description
nextLink	string	Odkaz použitý k získání další stránky operací.
value	Server[]	Seznam flexibilních serverů

ServerPublicNetworkAccessState

přístup z veřejné sítě je nebo není povolený

Name	Typ	Description
Disabled	string
Enabled	string

ServerState

Stav serveru, který je viditelný pro uživatele.

Name	Typ	Description
Disabled	string
Dropping	string
Ready	string
Starting	string
Stopped	string
Stopping	string
Updating	string

ServerVersion

Verze serveru.

Name	Typ	Description
11	string
12	string
13	string
14	string

Sku

Vlastnosti serveru související s informacemi o skladové pouce.

Name	Typ	Description
name	string	Název skladové položky, obvykle úroveň + rodina + jádra, například Standard_D4s_v3.
tier	SkuTier	Úroveň konkrétní skladové položky, například nárazová.

SkuTier

Úroveň konkrétní skladové položky, například nárazová.

Name	Typ	Description
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

Storage

Vlastnosti úložiště serveru

Name	Typ	Description
storageSizeGB	integer	Maximální povolené úložiště pro server

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UserAssignedIdentity

Informace popisující identity přidružené k této aplikaci

Name	Typ	Description
tenantId	string	ID tenanta serveru.
type	IdentityType	typy identit přidružených k tomuto prostředku; Aktuálně je omezeno na žádné a přiřazené uživatele.
userAssignedIdentities	<string, UserIdentity>	představuje mapování identit přiřazených uživatelem.

UserIdentity

Popisuje jednu identitu přiřazenou uživatelem přidruženou k aplikaci.

Name	Typ	Description
clientId	string	identifikátor klienta instančního objektu, který tato identita představuje.
principalId	string	identifikátor objektu instančního objektu, který tato identita představuje.

Sdílet prostřednictvím

Replicas - List By Server

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

ReplicasListByServer

Ukázkový požadavek

Ukázková odpověď

Definice

activeDirectoryAuthEnum

ArmServerKeyType

AuthConfig

Backup

createdByType

CreateMode

DataEncryption

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoRedundantBackupEnum

HighAvailability

HighAvailabilityMode

IdentityType

MaintenanceWindow

Network

passwordAuthEnum

ReplicationRole

Server

ServerHAState

ServerListResult

ServerPublicNetworkAccessState

ServerState

ServerVersion

Sku

SkuTier

Storage

systemData

UserAssignedIdentity

UserIdentity

Další materiály