Replicas - List By Server

Riferimento

Servizio:: MySQL

Versione API:: 2024-06-01-preview

Elencare tutte le repliche per un determinato server.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
serverName	path	True	string	Nome del server. Criterio di espressione regolare: `^[a-z0-9][-a-z0-9]*(?<!-)$`
subscriptionId	path	True	string uuid	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	ServerListResult	OK
Other Status Codes	ErrorResponse	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

List replicas for a server

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

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

Risposta di esempio

Codice di stato:: 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"
    }
  ]
}

Definizioni

Nome	Descrizione
Backup	Proprietà del profilo di archiviazione di un server
createdByType	Tipo di identità che ha creato la risorsa.
CreateMode	Modalità per creare un nuovo server MySQL.
DataEncryption	Crittografia della data per cmk.
DataEncryptionType	Tipo di chiave, AzureKeyVault per abilitare cmk, SystemManaged per disabilitare cmk.
EnableStatusEnum	Enumerazione per indicare se il valore è 'Enabled' o 'Disabled'
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
HighAvailability	Proprietà a disponibilità elevata di un server
HighAvailabilityMode	Modalità a disponibilità elevata per un server.
HighAvailabilityState	Stato della disponibilità elevata del server.
ImportSourceProperties	Importare le proprietà correlate all'origine.
ImportSourceStorageType	Tipo di archiviazione dell'origine di importazione.
MaintenancePolicy	Criteri di manutenzione di un server.
MaintenanceWindow	Finestra di manutenzione di un server.
ManagedServiceIdentityType	Tipo di identità del servizio gestito.
MySQLServerSku	Proprietà correlate alle informazioni di fatturazione di un server.
Network	Proprietà correlate alla rete di un server
PatchStrategy	Enumerazione per indicare la strategia di patch di un server
PrivateEndpoint	Risorsa endpoint privato.
PrivateEndpointConnection	Risorsa di connessione dell'endpoint privato.
PrivateEndpointConnectionProvisioningState	Stato di provisioning corrente.
PrivateEndpointServiceConnectionStatus	Stato della connessione dell'endpoint privato.
PrivateLinkServiceConnectionState	Raccolta di informazioni sullo stato della connessione tra consumer di servizi e provider.
ReplicationRole	Ruolo di replica.
Server	Rappresenta un server.
ServerListResult	Elenco di server.
ServerSkuTier	Livello dello SKU specifico, ad esempio GeneralPurpose.
ServerState	Stato di un server.
ServerVersion	Versione di un server.
Storage	Proprietà del profilo di archiviazione di un server
StorageRedundancyEnum	Enumerazione per indicare se il valore dello SKU di archiviazione è 'ZoneRedundancy' o 'LocalRedundancy'
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

Backup

Proprietà del profilo di archiviazione di un server

Nome	Tipo	Valore predefinito	Descrizione
backupIntervalHours	integer		Ore di intervallo di backup per il server.
backupRetentionDays	integer		Giorni di conservazione dei backup per il server.
earliestRestoreDate	string		Tempo di creazione del punto di ripristino meno recente (formato ISO8601)
geoRedundantBackup	EnableStatusEnum	Disabled	Indica se il backup con ridondanza geografica è abilitato o meno.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Modalità per creare un nuovo server MySQL.

Nome	Tipo	Descrizione
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string

DataEncryption

Crittografia della data per cmk.

Nome	Tipo	Descrizione
geoBackupKeyURI	string	L'URI della chiave di backup geografico come insieme di credenziali delle chiavi non può attraversare l'area, è necessario usare cmk nella stessa area del backup geografico
geoBackupUserAssignedIdentityId	string	L'ID risorsa identità utente di backup geografico come identità non può attraversare l'area, è necessaria l'identità nella stessa area del backup geografico
primaryKeyURI	string	URI chiave primaria
primaryUserAssignedIdentityId	string	ID risorsa identità utente primaria
type	DataEncryptionType	Tipo di chiave, AzureKeyVault per abilitare cmk, SystemManaged per disabilitare cmk.

DataEncryptionType

Tipo di chiave, AzureKeyVault per abilitare cmk, SystemManaged per disabilitare cmk.

Nome	Tipo	Descrizione
AzureKeyVault	string
SystemManaged	string

EnableStatusEnum

Enumerazione per indicare se il valore è 'Enabled' o 'Disabled'

Nome	Tipo	Descrizione
Disabled	string
Enabled	string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

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

ErrorDetail

Dettagli dell'errore.

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

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

HighAvailability

Proprietà a disponibilità elevata di un server

Nome	Tipo	Descrizione
mode	HighAvailabilityMode	Modalità a disponibilità elevata per un server.
standbyAvailabilityZone	string	Zona di disponibilità del server di standby.
state	HighAvailabilityState	Stato della disponibilità elevata del server.

HighAvailabilityMode

Modalità a disponibilità elevata per un server.

Nome	Tipo	Descrizione
Disabled	string
SameZone	string
ZoneRedundant	string

HighAvailabilityState

Stato della disponibilità elevata del server.

Nome	Tipo	Descrizione
CreatingStandby	string
FailingOver	string
Healthy	string
NotEnabled	string
RemovingStandby	string

ImportSourceProperties

Importare le proprietà correlate all'origine.

Nome	Tipo	Descrizione
dataDirPath	string	Percorso relativo della directory dei dati nell'archiviazione.
sasToken	string	Token di firma di accesso condiviso per l'accesso all'archiviazione di origine. Le autorizzazioni di lettura ed elenco sono necessarie per il token di firma di accesso condiviso.
storageType	ImportSourceStorageType	Tipo di archiviazione dell'origine di importazione.
storageUrl	string	URI dell'archiviazione di origine di importazione.

ImportSourceStorageType

Tipo di archiviazione dell'origine di importazione.

Nome	Tipo	Descrizione
AzureBlob	string

MaintenancePolicy

Criteri di manutenzione di un server.

Nome	Tipo	Descrizione
patchStrategy	PatchStrategy	Strategia patch di questo server

MaintenanceWindow

Finestra di manutenzione di un server.

Nome	Tipo	Descrizione
customWindow	string	indica se la finestra personalizzata è abilitata o disabilitata
dayOfWeek	integer	giorno della settimana per la finestra di manutenzione
startHour	integer	ora di inizio per la finestra di manutenzione
startMinute	integer	inizio minuto per la finestra di manutenzione

ManagedServiceIdentityType

Tipo di identità del servizio gestito.

Nome	Tipo	Descrizione
UserAssigned	string

MySQLServerSku

Proprietà correlate alle informazioni di fatturazione di un server.

Nome	Tipo	Descrizione
name	string	Nome dello SKU, ad esempio Standard_D32s_v3.
tier	ServerSkuTier	Livello dello SKU specifico, ad esempio GeneralPurpose.

Network

Proprietà correlate alla rete di un server

Nome	Tipo	Descrizione
delegatedSubnetResourceId	string	ID risorsa subnet delegata usato per configurare la rete virtuale per un server.
privateDnsZoneResourceId	string	ID risorsa zona DNS privato.
publicNetworkAccess	EnableStatusEnum	Indica se l'accesso alla rete pubblica è consentito per questo server. Il valore è "Disabled" quando il server dispone dell'integrazione della rete virtuale.

PatchStrategy

Enumerazione per indicare la strategia di patch di un server

Nome	Tipo	Descrizione
Regular	string
VirtualCanary	string

PrivateEndpoint

Risorsa endpoint privato.

Nome	Tipo	Descrizione
id	string	Identificatore arm per l'endpoint privato.

PrivateEndpointConnection

Risorsa di connessione dell'endpoint privato.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nome della risorsa
properties.groupIds	string[]	ID gruppo per la risorsa endpoint privato.
properties.privateEndpoint	PrivateEndpoint	Risorsa endpoint privato.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Raccolta di informazioni sullo stato della connessione tra consumer di servizi e provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stato di provisioning della risorsa di connessione dell'endpoint privato.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Stato di provisioning corrente.

Nome	Tipo	Descrizione
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

Stato della connessione dell'endpoint privato.

Nome	Tipo	Descrizione
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Raccolta di informazioni sullo stato della connessione tra consumer di servizi e provider.

Nome	Tipo	Descrizione
actionsRequired	string	Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti sul consumer.
description	string	Motivo dell'approvazione/rifiuto della connessione.
status	PrivateEndpointServiceConnectionStatus	Indica se la connessione è stata approvata/rifiutata/rimossa dal proprietario del servizio.

ReplicationRole

Ruolo di replica.

Nome	Tipo	Descrizione
None	string
Replica	string
Source	string

Server

Rappresenta un server.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity.principalId	string	ObjectId dall'insieme di credenziali delle chiavi
identity.tenantId	string	TenantId dall'insieme di credenziali delle chiavi
identity.type	ManagedServiceIdentityType	Tipo di identità del servizio gestito.
identity.userAssignedIdentities	object	Metadati dell'identità assegnata dall'utente.
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 dell'account di accesso amministratore (obbligatorio per la creazione del server).
properties.availabilityZone	string	informazioni sulla zona di disponibilità del server.
properties.backup	Backup	Eseguire il backup delle proprietà correlate di un server.
properties.createMode	CreateMode	Modalità per creare un nuovo server MySQL.
properties.dataEncryption	DataEncryption	Crittografia dei dati per cmk.
properties.databasePort	integer	Porta del database del server. Può essere specificato solo quando il server viene creato.
properties.fullyQualifiedDomainName	string	Nome di dominio completo di un server.
properties.highAvailability	HighAvailability	Proprietà correlate alla disponibilità elevata di un server.
properties.importSourceProperties	ImportSourceProperties	Proprietà di origine per l'importazione dall'archiviazione.
properties.maintenancePolicy	MaintenancePolicy	Criteri di manutenzione di un server.
properties.maintenanceWindow	MaintenanceWindow	Finestra di manutenzione di un server. Problema noto: non può essere impostato durante la creazione del server o aggiornato con altre proprietà durante l'aggiornamento del server; deve essere aggiornato separatamente.
properties.network	Network	Proprietà correlate alla rete di un server.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Proprietà correlate privateEndpointConnections di un server.
properties.replicaCapacity	integer	Numero massimo di repliche che un server primario può avere.
properties.replicationRole	ReplicationRole	Ruolo di replica.
properties.restorePointInTime	string	Tempo di creazione del punto di ripristino (formato ISO8601), specificando il tempo da cui eseguire il ripristino.
properties.sourceServerResourceId	string	ID del server MySQL di origine.
properties.state	ServerState	Stato di un server.
properties.storage	Storage	Proprietà correlate all'archiviazione di un server.
properties.version	ServerVersion	Versione del server.
sku	MySQLServerSku	SKU (piano tariffario) del server.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
tags	object	Tag di risorsa.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ServerListResult

Elenco di server.

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

ServerSkuTier

Livello dello SKU specifico, ad esempio GeneralPurpose.

Nome	Tipo	Descrizione
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

ServerState

Stato di un server.

Nome	Tipo	Descrizione
Disabled	string
Dropping	string
Ready	string
Starting	string
Stopped	string
Stopping	string
Updating	string

ServerVersion

Versione di un server.

Nome	Tipo	Descrizione
5.7	string
8.0.21	string

Storage