Replicas - List By Server

Référence

Service:: MySQL

Version d'API:: 2024-06-01-preview

Répertorie tous les réplicas d’un serveur donné.

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

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	Nom du serveur. Modèle d’expression régulière: `^[a-z0-9][-a-z0-9]*(?<!-)$`
subscriptionId	path	True	string uuid	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ServerListResult	D’ACCORD
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

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

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

Exemple de réponse

Code d’état:: 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"
    }
  ]
}

Définitions

Nom	Description
Backup	Propriétés du profil de stockage d’un serveur
createdByType	Type d’identité qui a créé la ressource.
CreateMode	Mode de création d’un serveur MySQL.
DataEncryption	Chiffrement de date pour cmk.
DataEncryptionType	Type de clé, AzureKeyVault pour activer cmk, SystemManaged pour désactiver cmk.
EnableStatusEnum	Énumération pour indiquer si la valeur est « Enabled » ou « Disabled »
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
HighAvailability	Propriétés de haute disponibilité d’un serveur
HighAvailabilityMode	Mode haute disponibilité pour un serveur.
HighAvailabilityState	État de la haute disponibilité du serveur.
ImportSourceProperties	Importer les propriétés associées à la source.
ImportSourceStorageType	Type de stockage de la source d’importation.
MaintenancePolicy	Stratégie de maintenance d’un serveur.
MaintenanceWindow	Fenêtre de maintenance d’un serveur.
ManagedServiceIdentityType	Type d’identité de service managé.
MySQLServerSku	Propriétés associées aux informations de facturation d’un serveur.
Network	Propriétés liées au réseau d’un serveur
PatchStrategy	Énumération pour indiquer la stratégie de correctif d’un serveur
PrivateEndpoint	Ressource de point de terminaison privé.
PrivateEndpointConnection	Ressource de connexion de point de terminaison privé.
PrivateEndpointConnectionProvisioningState	État d’approvisionnement actuel.
PrivateEndpointServiceConnectionStatus	État de la connexion de point de terminaison privé.
PrivateLinkServiceConnectionState	Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.
ReplicationRole	Rôle de réplication.
Server	Représente un serveur.
ServerListResult	Liste des serveurs.
ServerSkuTier	Niveau de la référence SKU particulière, par exemple GeneralPurpose.
ServerState	État d’un serveur.
ServerVersion	Version d’un serveur.
Storage	Propriétés du profil de stockage d’un serveur
StorageRedundancyEnum	Énumération pour indiquer si la valeur de référence de stockage est « ZoneRedundancy » ou « LocalRedundancy »
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

Backup

Propriétés du profil de stockage d’un serveur

Nom	Type	Valeur par défaut	Description
backupIntervalHours	integer		Heures d’intervalle de sauvegarde pour le serveur.
backupRetentionDays	integer		Jours de rétention de sauvegarde pour le serveur.
earliestRestoreDate	string		Heure de création du point de restauration la plus ancienne (format ISO8601)
geoRedundantBackup	EnableStatusEnum	Disabled	Indique si la sauvegarde géoredondante est activée ou non.

createdByType

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

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Mode de création d’un serveur MySQL.

Nom	Type	Description
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string

DataEncryption

Chiffrement de date pour cmk.

Nom	Type	Description
geoBackupKeyURI	string	Uri de clé de sauvegarde géographique comme coffre de clés ne peut pas traverser la région, besoin de cmk dans la même région que la géo-sauvegarde
geoBackupUserAssignedIdentityId	string	Id de ressource d’identité utilisateur de la géo-sauvegarde, car l’identité ne peut pas traverser la région, vous avez besoin d’une identité dans la même région que la géo-sauvegarde
primaryKeyURI	string	URI de clé primaire
primaryUserAssignedIdentityId	string	ID de ressource d’identité d’utilisateur principal
type	DataEncryptionType	Type de clé, AzureKeyVault pour activer cmk, SystemManaged pour désactiver cmk.

DataEncryptionType

Type de clé, AzureKeyVault pour activer cmk, SystemManaged pour désactiver cmk.

Nom	Type	Description
AzureKeyVault	string
SystemManaged	string

EnableStatusEnum

Énumération pour indiquer si la valeur est « Enabled » ou « Disabled »

Nom	Type	Description
Disabled	string
Enabled	string

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émentaire.

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 d’erreur.

HighAvailability

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

Nom	Type	Description
mode	HighAvailabilityMode	Mode haute disponibilité pour un serveur.
standbyAvailabilityZone	string	Zone de disponibilité du serveur de secours.
state	HighAvailabilityState	État de la haute disponibilité du serveur.

HighAvailabilityMode

Mode haute disponibilité pour un serveur.

Nom	Type	Description
Disabled	string
SameZone	string
ZoneRedundant	string

HighAvailabilityState

État de la haute disponibilité du serveur.

Nom	Type	Description
CreatingStandby	string
FailingOver	string
Healthy	string
NotEnabled	string
RemovingStandby	string

ImportSourceProperties

Importer les propriétés associées à la source.

Nom	Type	Description
dataDirPath	string	Chemin relatif du répertoire de données dans le stockage.
sasToken	string	Jeton sas pour accéder au stockage source. Les autorisations de lecture et de liste sont requises pour le jeton sas.
storageType	ImportSourceStorageType	Type de stockage de la source d’importation.
storageUrl	string	Uri du stockage source d’importation.

ImportSourceStorageType

Type de stockage de la source d’importation.

Nom	Type	Description
AzureBlob	string

MaintenancePolicy

Stratégie de maintenance d’un serveur.

Nom	Type	Description
patchStrategy	PatchStrategy	Stratégie de correctif de ce serveur

MaintenanceWindow

Fenêtre de maintenance d’un serveur.

Nom	Type	Description
customWindow	string	indique si la fenêtre personnalisée est activée ou désactivée
dayOfWeek	integer	jour de semaine pour la fenêtre de maintenance
startHour	integer	heure de début de la fenêtre de maintenance
startMinute	integer	minute de démarrage de la fenêtre de maintenance

ManagedServiceIdentityType

Type d’identité de service managé.

Nom	Type	Description
UserAssigned	string

MySQLServerSku

Propriétés associées aux informations de facturation d’un serveur.

Nom	Type	Description
name	string	Nom de la référence SKU, par exemple Standard_D32s_v3.
tier	ServerSkuTier	Niveau de la référence SKU particulière, par exemple GeneralPurpose.

Network

Propriétés liées au réseau d’un serveur

Nom	Type	Description
delegatedSubnetResourceId	string	ID de ressource de sous-réseau délégué utilisé pour configurer le réseau virtuel pour un serveur.
privateDnsZoneResourceId	string	ID de ressource de zone DNS privée.
publicNetworkAccess	EnableStatusEnum	Indique si l’accès au réseau public est autorisé pour ce serveur. La valeur est « Disabled » lorsque le serveur a une intégration de réseau virtuel.

PatchStrategy

Énumération pour indiquer la stratégie de correctif d’un serveur

Nom	Type	Description
Regular	string
VirtualCanary	string

PrivateEndpoint

Ressource de point de terminaison privé.

Nom	Type	Description
id	string	Identificateur ARM pour le point de terminaison privé.

PrivateEndpointConnection

Ressource de connexion de point de terminaison privé.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.groupIds	string[]	ID de groupe pour la ressource de point de terminaison privé.
properties.privateEndpoint	PrivateEndpoint	Ressource de point de terminaison privé.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	État d’approvisionnement de la ressource de connexion de point de terminaison privé.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateEndpointConnectionProvisioningState

État d’approvisionnement actuel.

Nom	Type	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

État de la connexion de point de terminaison privé.

Nom	Type	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

Nom	Type	Description
actionsRequired	string	Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.
description	string	Raison de l’approbation/rejet de la connexion.
status	PrivateEndpointServiceConnectionStatus	Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service.

ReplicationRole

Rôle de réplication.

Nom	Type	Description
None	string
Replica	string
Source	string

Server

Représente un serveur.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
identity.principalId	string	ObjectId à partir de KeyVault
identity.tenantId	string	TenantId à partir de KeyVault
identity.type	ManagedServiceIdentityType	Type d’identité de service managé.
identity.userAssignedIdentities	object	Métadonnées de l’identité affectée par l’utilisateur.
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. Ne peut être spécifié que lorsque le serveur est en cours de création (et est requis pour la création).
properties.administratorLoginPassword	string	Mot de passe de la connexion administrateur (requis pour la création du serveur).
properties.availabilityZone	string	informations de zone de disponibilité du serveur.
properties.backup	Backup	Sauvegardez les propriétés associées d’un serveur.
properties.createMode	CreateMode	Mode de création d’un serveur MySQL.
properties.dataEncryption	DataEncryption	Chiffrement des données pour CMK.
properties.databasePort	integer	Port de base de données du serveur. Ne peut être spécifié que lorsque le serveur est en cours de création.
properties.fullyQualifiedDomainName	string	Nom de domaine complet d’un serveur.
properties.highAvailability	HighAvailability	Propriétés associées à la haute disponibilité d’un serveur.
properties.importSourceProperties	ImportSourceProperties	Propriétés sources pour l’importation à partir du stockage.
properties.maintenancePolicy	MaintenancePolicy	Stratégie de maintenance d’un serveur.
properties.maintenanceWindow	MaintenanceWindow	Fenêtre de maintenance d’un serveur. Problème connu : ne peut pas être défini lors de la création du serveur ou mis à jour avec d’autres propriétés pendant la mise à jour du serveur ; doit être mis à jour séparément.
properties.network	Network	Propriétés associées au réseau d’un serveur.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Propriétés associées à PrivateEndpointConnections d’un serveur.
properties.replicaCapacity	integer	Nombre maximal de réplicas qu’un serveur principal peut avoir.
properties.replicationRole	ReplicationRole	Rôle de réplication.
properties.restorePointInTime	string	Heure de création du point de restauration (format ISO8601), en spécifiant l’heure de restauration à partir de laquelle effectuer la restauration.
properties.sourceServerResourceId	string	ID de serveur MySQL source.
properties.state	ServerState	État d’un serveur.
properties.storage	Storage	Propriétés associées au stockage d’un serveur.
properties.version	ServerVersion	Version du serveur.
sku	MySQLServerSku	Référence SKU (niveau tarifaire) du serveur.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ServerListResult

Liste des serveurs.

Nom	Type	Description
nextLink	string	Lien utilisé pour obtenir la page suivante des opérations.
value	Server[]	Liste des serveurs

ServerSkuTier

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

Nom	Type	Description
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

ServerState

État d’un serveur.

Nom	Type	Description
Disabled	string
Dropping	string
Ready	string
Starting	string
Stopped	string
Stopping	string
Updating	string

ServerVersion

Version d’un serveur.

Nom	Type	Description
5.7	string
8.0.21	string

Storage