Replicas - List By Server

Dienst:

MySQL

API-Version:

2024-06-01-preview

Listet alle Replikate für einen bestimmten Server auf.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/replicas?api-version=2024-06-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serverName	path	True	string	Der Name des Servers. RegEx-Muster: ^[a-z0-9][-a-z0-9]*(?<!-)$
subscriptionId	path	True	string uuid	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	ServerListResult	OKAY
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List replicas for a server

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/replicas?api-version=2024-06-01-preview

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.mysqlflexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mysqlflexibleservers
# USAGE
    python replicas_list_by_server.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MySQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.replicas.list_by_server(
        resource_group_name="TestGroup",
        server_name="mysqltestserver",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-06-01-preview/examples/ReplicasListByServer.json
if __name__ == "__main__":
    main()

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

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "sku": {
        "name": "Standard_D2ds_v4",
        "tier": "GeneralPurpose"
      },
      "properties": {
        "administratorLogin": "cloudsa",
        "storage": {
          "storageSizeGB": 20,
          "iops": 360,
          "autoGrow": "Enabled",
          "storageSku": "Premium_LRS"
        },
        "version": "5.7",
        "state": "Ready",
        "fullyQualifiedDomainName": "mysqltestserver-repl.orcabrci-seas1-a.mscds.com",
        "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver",
        "availabilityZone": "1",
        "maintenancePolicy": {
          "patchStrategy": "Regular"
        },
        "maintenanceWindow": {
          "customWindow": "Disabled",
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0
        },
        "replicationRole": "Replica",
        "replicaCapacity": 0,
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "backup": {
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled",
          "earliestRestoreDate": "2021-06-24T08:19:18.00+00:00"
        },
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        }
      },
      "location": "Southeast Asia",
      "tags": {
        "num": "1"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver-repl",
      "name": "mysqltestserver-repl",
      "type": "Microsoft.DBforMySQL/flexibleServers"
    },
    {
      "sku": {
        "name": "Standard_D2ds_v4",
        "tier": "GeneralPurpose"
      },
      "properties": {
        "administratorLogin": "cloudsa",
        "storage": {
          "storageSizeGB": 20,
          "iops": 360,
          "autoGrow": "Enabled",
          "storageSku": "Premium_LRS"
        },
        "version": "5.7",
        "state": "Ready",
        "fullyQualifiedDomainName": "mysqltestserver-repl2.orcabrci-seas1-a.mscds.com",
        "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver",
        "availabilityZone": "1",
        "maintenancePolicy": {
          "patchStrategy": "Default"
        },
        "maintenanceWindow": {
          "customWindow": "Disabled",
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0
        },
        "replicationRole": "Replica",
        "replicaCapacity": 0,
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "backup": {
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled",
          "earliestRestoreDate": "2021-06-23T08:19:18.00+00:00"
        },
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        }
      },
      "location": "Southeast Asia",
      "tags": {
        "num": "1"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver-repl2",
      "name": "mysqltestserver-repl",
      "type": "Microsoft.DBforMySQL/flexibleServers"
    }
  ]
}

Definitionen

Name	Beschreibung
Backup	Speicherprofileigenschaften eines Servers
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CreateMode	Der Modus zum Erstellen eines neuen MySQL-Servers.
DataEncryption	Die Datumsverschlüsselung für cmk.
DataEncryptionType	Der Schlüsseltyp AzureKeyVault zum Aktivieren von cmk, SystemManaged für die Deaktivierung von cmk.
EnableStatusEnum	Enumeration, um anzugeben, ob der Wert "Aktiviert" oder "Deaktiviert" ist
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
HighAvailability	Eigenschaften mit hoher Verfügbarkeit eines Servers
HighAvailabilityMode	Hochverfügbarkeitsmodus für einen Server.
HighAvailabilityState	Der Status der hohen Serververfügbarkeit.
ImportSourceProperties	Importieren Sie quellbezogene Eigenschaften.
ImportSourceStorageType	Speichertyp der Importquelle.
MaintenancePolicy	Wartungsrichtlinie eines Servers.
MaintenanceWindow	Wartungsfenster eines Servers.
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität.
MySQLServerSku	Abrechnungsinformationen im Zusammenhang mit Eigenschaften eines Servers.
Network	Netzwerkbezogene Eigenschaften eines Servers
PatchStrategy	Aufzählung zur Angabe der Patchstrategie eines Servers
PrivateEndpoint	Die private Endpunktressource.
PrivateEndpointConnection	Die private Endpunktverbindungsressource.
PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus.
PrivateEndpointServiceConnectionStatus	Der Status der privaten Endpunktverbindung.
PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
ReplicationRole	Die Replikationsrolle.
Server	Stellt einen Server dar.
ServerListResult	Eine Liste der Server.
ServerSkuTier	Die Ebene der jeweiligen SKU, z. B. GeneralPurpose.
ServerState	Der Status eines Servers.
ServerVersion	Die Version eines Servers.
Storage	Speicherprofileigenschaften eines Servers
StorageRedundancyEnum	Aufzählung, um anzugeben, ob der Speicherskuwert "ZoneRedundancy" oder "LocalRedundancy" lautet.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

Backup

Speicherprofileigenschaften eines Servers

Name	Typ	Standardwert	Beschreibung
backupIntervalHours	integer		Sicherungsintervallstunden für den Server.
backupRetentionDays	integer		Sicherungsaufbewahrungstage für den Server.
earliestRestoreDate	string		Früheste Zeit für die Erstellung von Wiederherstellungspunkten (ISO8601 Format)
geoRedundantBackup	EnableStatusEnum	Disabled	Gibt an, ob die georedundante Sicherung aktiviert ist.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Der Modus zum Erstellen eines neuen MySQL-Servers.

Name	Typ	Beschreibung
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string

DataEncryption

Die Datumsverschlüsselung für cmk.

Name	Typ	Beschreibung
geoBackupKeyURI	string	Geo-Sicherungsschlüssel-URI, da der Schlüsseltresor nicht regionübergreifend sein kann, cmk in derselben Region wie geo-Sicherung benötigt
geoBackupUserAssignedIdentityId	string	Geo-Sicherungsbenutzeridentitätsressourcen-ID als Identität kann nicht regionübergreifend sein, benötigen Identität in derselben Region wie geo-Sicherung
primaryKeyURI	string	Primärschlüssel-URI
primaryUserAssignedIdentityId	string	Primäre Benutzeridentitätsressourcen-ID
type	DataEncryptionType	Der Schlüsseltyp AzureKeyVault zum Aktivieren von cmk, SystemManaged für die Deaktivierung von cmk.

DataEncryptionType

Der Schlüsseltyp AzureKeyVault zum Aktivieren von cmk, SystemManaged für die Deaktivierung von cmk.

Name	Typ	Beschreibung
AzureKeyVault	string
SystemManaged	string

EnableStatusEnum

Enumeration, um anzugeben, ob der Wert "Aktiviert" oder "Deaktiviert" ist

Name	Typ	Beschreibung
Disabled	string
Enabled	string

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

HighAvailability

Eigenschaften mit hoher Verfügbarkeit eines Servers

Name	Typ	Beschreibung
mode	HighAvailabilityMode	Hochverfügbarkeitsmodus für einen Server.
standbyAvailabilityZone	string	Verfügbarkeitszone des Standbyservers.
state	HighAvailabilityState	Der Status der hohen Serververfügbarkeit.

HighAvailabilityMode

Hochverfügbarkeitsmodus für einen Server.

Name	Typ	Beschreibung
Disabled	string
SameZone	string
ZoneRedundant	string

HighAvailabilityState

Der Status der hohen Serververfügbarkeit.

Name	Typ	Beschreibung
CreatingStandby	string
FailingOver	string
Healthy	string
NotEnabled	string
RemovingStandby	string

ImportSourceProperties

Importieren Sie quellbezogene Eigenschaften.

Name	Typ	Beschreibung
dataDirPath	string	Relativer Pfad des Datenverzeichnisses im Speicher.
sasToken	string	Sas-Token für den Zugriff auf den Quellspeicher. Lese- und Listenberechtigungen sind für sas-Token erforderlich.
storageType	ImportSourceStorageType	Speichertyp der Importquelle.
storageUrl	string	URI des Importquellspeichers.

ImportSourceStorageType

Speichertyp der Importquelle.

Name	Typ	Beschreibung
AzureBlob	string

MaintenancePolicy

Wartungsrichtlinie eines Servers.

Name	Typ	Beschreibung
patchStrategy	PatchStrategy	Die Patchstrategie dieses Servers

MaintenanceWindow

Wartungsfenster eines Servers.

Name	Typ	Beschreibung
customWindow	string	gibt an, ob das benutzerdefinierte Fenster aktiviert oder deaktiviert ist.
dayOfWeek	integer	Wochentag für Wartungsfenster
startHour	integer	Startstunde für Wartungsfenster
startMinute	integer	Startminute für Wartungsfenster

ManagedServiceIdentityType

Typ der verwalteten Dienstidentität.

Name	Typ	Beschreibung
UserAssigned	string

MySQLServerSku

Abrechnungsinformationen im Zusammenhang mit Eigenschaften eines Servers.

Name	Typ	Beschreibung
name	string	Der Name der Sku, z. B. Standard_D32s_v3.
tier	ServerSkuTier	Die Ebene der jeweiligen SKU, z. B. GeneralPurpose.

Network

Netzwerkbezogene Eigenschaften eines Servers

Name	Typ	Beschreibung
delegatedSubnetResourceId	string	Delegierte Subnetzressourcen-ID, die zum Einrichten von vnet für einen Server verwendet wird.
privateDnsZoneResourceId	string	Private DNS-Zonenressourcen-ID.
publicNetworkAccess	EnableStatusEnum	Gibt an, ob der Zugriff auf öffentliche Netzwerke für diesen Server zulässig ist. Der Wert ist "Deaktiviert", wenn der Server über die VNet-Integration verfügt.

PatchStrategy

Aufzählung zur Angabe der Patchstrategie eines Servers

Name	Typ	Beschreibung
Regular	string
VirtualCanary	string

PrivateEndpoint

Die private Endpunktressource.

Name	Typ	Beschreibung
id	string	Der ARM-Bezeichner für privaten Endpunkt.

PrivateEndpointConnection

Die private Endpunktverbindungsressource.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.groupIds	string[]	Die Gruppen-IDs für die private Endpunktressource.
properties.privateEndpoint	PrivateEndpoint	Die private Endpunktressource.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Der Bereitstellungsstatus der privaten Endpunktverbindungsressource.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.

Name	Typ	Beschreibung
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

Der Status der privaten Endpunktverbindung.

Name	Typ	Beschreibung
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.

Name	Typ	Beschreibung
actionsRequired	string	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern.
description	string	Der Grund für die Genehmigung/Ablehnung der Verbindung.
status	PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde.

ReplicationRole

Die Replikationsrolle.

Name	Typ	Beschreibung
None	string
Replica	string
Source	string

Server

Stellt einen Server dar.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity.principalId	string	ObjectId aus keyVault
identity.tenantId	string	TenantId aus keyVault
identity.type	ManagedServiceIdentityType	Typ der verwalteten Dienstidentität.
identity.userAssignedIdentities	object	Metadaten der vom Benutzer zugewiesenen Identität.
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.administratorLogin	string	Der Anmeldename des Administrators eines Servers. Kann nur angegeben werden, wenn der Server erstellt wird (und für die Erstellung erforderlich ist).
properties.administratorLoginPassword	string	Das Kennwort der Administratoranmeldung (erforderlich für die Servererstellung).
properties.availabilityZone	string	Verfügbarkeitszoneninformationen des Servers.
properties.backup	Backup	Sicherungsbezogene Eigenschaften eines Servers.
properties.createMode	CreateMode	Der Modus zum Erstellen eines neuen MySQL-Servers.
properties.dataEncryption	DataEncryption	Die Datenverschlüsselung für CMK.
properties.databasePort	integer	Der Serverdatenbankport. Kann nur angegeben werden, wenn der Server erstellt wird.
properties.fullyQualifiedDomainName	string	Der vollqualifizierte Domänenname eines Servers.
properties.highAvailability	HighAvailability	Hochverfügbarkeitsbezogene Eigenschaften eines Servers.
properties.importSourceProperties	ImportSourceProperties	Quelleigenschaften für den Import aus dem Speicher.
properties.maintenancePolicy	MaintenancePolicy	Wartungsrichtlinie eines Servers.
properties.maintenanceWindow	MaintenanceWindow	Wartungsfenster eines Servers. Bekanntes Problem: Kann während der Servererstellung nicht festgelegt oder mit anderen Eigenschaften während der Serveraktualisierung aktualisiert werden; muss separat aktualisiert werden.
properties.network	Network	Netzwerkbezogene Eigenschaften eines Servers.
properties.privateEndpointConnections	PrivateEndpointConnection[]	PrivateEndpointConnections-verwandte Eigenschaften eines Servers.
properties.replicaCapacity	integer	Die maximale Anzahl von Replikaten, die ein primärer Server haben kann.
properties.replicationRole	ReplicationRole	Die Replikationsrolle.
properties.restorePointInTime	string	Zeit für die Wiederherstellung von Punkt (ISO8601 Format) angeben, um die Wiederherstellungszeit anzugeben.
properties.sourceServerResourceId	string	Die MySQL-Quellserver-ID.
properties.state	ServerState	Der Status eines Servers.
properties.storage	Storage	Speicherbezogene Eigenschaften eines Servers.
properties.version	ServerVersion	Serverversion.
sku	MySQLServerSku	Die SKU (Preisebene) des Servers.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ServerListResult

Eine Liste der Server.

Name	Typ	Beschreibung
nextLink	string	Der Link, der zum Abrufen der nächsten Seite von Vorgängen verwendet wird.
value	Server[]	Die Liste der Server

ServerSkuTier

Die Ebene der jeweiligen SKU, z. B. GeneralPurpose.

Name	Typ	Beschreibung
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

ServerState

Der Status eines Servers.

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

ServerVersion

Die Version eines Servers.

Name	Typ	Beschreibung
5.7	string
8.0.21	string

Storage

Speicherprofileigenschaften eines Servers

Name	Typ	Standardwert	Beschreibung
autoGrow	EnableStatusEnum	Disabled	Speicher automatisch vergrößern oder nicht aktivieren.
autoIoScaling	EnableStatusEnum	Enabled	Aktivieren Sie die automatische E/A-Skalierung.
iops	integer		Speicher-IOPS für einen Server.
logOnDisk	EnableStatusEnum	Disabled	Aktivieren Sie die Anmeldung auf dem Datenträger oder nicht.
storageRedundancy	StorageRedundancyEnum	LocalRedundancy	Der redundante Typ des Serverspeichers. Der Parameter wird für die Servererstellung verwendet.
storageSizeGB	integer		Maximale Speichergröße für einen Server zulässig.
storageSku	string		Der SKU-Name des Serverspeichers.

StorageRedundancyEnum

Aufzählung, um anzugeben, ob der Speicherskuwert "ZoneRedundancy" oder "LocalRedundancy" lautet.

Name	Typ	Beschreibung
LocalRedundancy	string
ZoneRedundancy	string

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.