Replicas - List By Server

Service:

MySQL

API-versie:

2024-06-01-preview

Geef alle replica's voor een bepaalde server weer.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serverName	path	True	string	De naam van de server. Regex-patroon: ^[a-z0-9][-a-z0-9]*(?<!-)$
subscriptionId	path	True	string uuid	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	ServerListResult	OK
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

List replicas for a server

Voorbeeldaanvraag

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

Voorbeeldrespons

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"
    }
  ]
}

Definities

Name	Description
Backup	Eigenschappen van een opslagprofiel van een server
createdByType	Het type identiteit waarmee de resource is gemaakt.
CreateMode	De modus voor het maken van een nieuwe MySQL-server.
DataEncryption	De datumversleuteling voor cmk.
DataEncryptionType	Het sleuteltype, AzureKeyVault voor het inschakelen van cmk, SystemManaged voor het uitschakelen van cmk.
EnableStatusEnum	Opsomming om aan te geven of de waarde 'Ingeschakeld' of 'Uitgeschakeld' is
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
HighAvailability	Eigenschappen van hoge beschikbaarheid van een server
HighAvailabilityMode	Modus voor hoge beschikbaarheid voor een server.
HighAvailabilityState	De status van hoge beschikbaarheid van de server.
ImportSourceProperties	Brongerelateerde eigenschappen importeren.
ImportSourceStorageType	Opslagtype van importbron.
MaintenancePolicy	Onderhoudsbeleid van een server.
MaintenanceWindow	Onderhoudsvenster van een server.
ManagedServiceIdentityType	Type beheerde service-identiteit.
MySQLServerSku	Factureringsgegevens gerelateerde eigenschappen van een server.
Network	Netwerkgerelateerde eigenschappen van een server
PatchStrategy	Enum om de patchstrategie van een server aan te geven
PrivateEndpoint	De privé-eindpuntresource.
PrivateEndpointConnection	De privé-eindpuntverbindingsresource.
PrivateEndpointConnectionProvisioningState	De huidige inrichtingsstatus.
PrivateEndpointServiceConnectionStatus	De verbindingsstatus van het privé-eindpunt.
PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.
ReplicationRole	De replicatierol.
Server	Vertegenwoordigt een server.
ServerListResult	Een lijst met servers.
ServerSkuTier	De laag van de specifieke SKU, bijvoorbeeld GeneralPurpose.
ServerState	De status van een server.
ServerVersion	De versie van een server.
Storage	Eigenschappen van een opslagprofiel van een server
StorageRedundancyEnum	Enum om aan te geven of de opslag-sKU-waarde ZoneRedundancy of LocalRedundancy is
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Backup

Eigenschappen van een opslagprofiel van een server

Name	Type	Default value	Description
backupIntervalHours	integer		Back-upintervaluren voor de server.
backupRetentionDays	integer		Bewaardagen voor back-ups voor de server.
earliestRestoreDate	string		Vroegste aanmaaktijd van herstelpunt (ISO8601-indeling)
geoRedundantBackup	EnableStatusEnum	Disabled	Of geografisch redundante back-up al dan niet is ingeschakeld.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

De modus voor het maken van een nieuwe MySQL-server.

Name	Type	Description
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string

DataEncryption

De datumversleuteling voor cmk.

Name	Type	Description
geoBackupKeyURI	string	De URI van de geo-back-upsleutel omdat de sleutelkluis geen meerdere regio's kan bevatten, moet cmk zich in dezelfde regio bevinden als geo-back-up
geoBackupUserAssignedIdentityId	string	Resource-id van geo-back-upgebruikersidentiteit als identiteit kan niet tussen regio's, identiteit in dezelfde regio nodig hebben als geo-back-up
primaryKeyURI	string	Primaire-sleutel-URI
primaryUserAssignedIdentityId	string	Resource-id van primaire gebruikersidentiteit
type	DataEncryptionType	Het sleuteltype, AzureKeyVault voor het inschakelen van cmk, SystemManaged voor het uitschakelen van cmk.

DataEncryptionType

Het sleuteltype, AzureKeyVault voor het inschakelen van cmk, SystemManaged voor het uitschakelen van cmk.

Name	Type	Description
AzureKeyVault	string
SystemManaged	string

EnableStatusEnum

Opsomming om aan te geven of de waarde 'Ingeschakeld' of 'Uitgeschakeld' is

Name	Type	Description
Disabled	string
Enabled	string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

HighAvailability

Eigenschappen van hoge beschikbaarheid van een server

Name	Type	Description
mode	HighAvailabilityMode	Modus voor hoge beschikbaarheid voor een server.
standbyAvailabilityZone	string	Beschikbaarheidszone van de stand-byserver.
state	HighAvailabilityState	De status van hoge beschikbaarheid van de server.

HighAvailabilityMode

Modus voor hoge beschikbaarheid voor een server.

Name	Type	Description
Disabled	string
SameZone	string
ZoneRedundant	string

HighAvailabilityState

De status van hoge beschikbaarheid van de server.

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

ImportSourceProperties

Brongerelateerde eigenschappen importeren.

Name	Type	Description
dataDirPath	string	Relatief pad van gegevensmap in opslag.
sasToken	string	Sas-token voor toegang tot bronopslag. Lees- en lijstmachtigingen zijn vereist voor sas-token.
storageType	ImportSourceStorageType	Opslagtype van importbron.
storageUrl	string	Uri van de bronopslag importeren.

ImportSourceStorageType

Opslagtype van importbron.

Name	Type	Description
AzureBlob	string

MaintenancePolicy

Onderhoudsbeleid van een server.

Name	Type	Description
patchStrategy	PatchStrategy	De patchstrategie van deze server

MaintenanceWindow

Onderhoudsvenster van een server.

Name	Type	Description
customWindow	string	geeft aan of aangepast venster is ingeschakeld of uitgeschakeld
dayOfWeek	integer	dag van de week voor onderhoudsvenster
startHour	integer	beginuur voor onderhoudsvenster
startMinute	integer	beginminut voor onderhoudsvenster

ManagedServiceIdentityType

Type beheerde service-identiteit.

Name	Type	Description
UserAssigned	string

MySQLServerSku

Factureringsgegevens gerelateerde eigenschappen van een server.

Name	Type	Description
name	string	De naam van de SKU, bijvoorbeeld Standard_D32s_v3.
tier	ServerSkuTier	De laag van de specifieke SKU, bijvoorbeeld GeneralPurpose.

Network

Netwerkgerelateerde eigenschappen van een server

Name	Type	Description
delegatedSubnetResourceId	string	Gedelegeerde subnetresource-id die wordt gebruikt voor het instellen van vnet voor een server.
privateDnsZoneResourceId	string	Resource-id van privé-DNS-zone.
publicNetworkAccess	EnableStatusEnum	Of openbare netwerktoegang wel of niet is toegestaan voor deze server. De waarde is uitgeschakeld wanneer de server VNet-integratie heeft.

PatchStrategy

Enum om de patchstrategie van een server aan te geven

Name	Type	Description
Regular	string
VirtualCanary	string

PrivateEndpoint

De privé-eindpuntresource.

Name	Type	Description
id	string	De ARM-id voor privé-eindpunt.

PrivateEndpointConnection

De privé-eindpuntverbindingsresource.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.groupIds	string[]	De groeps-id's voor de privé-eindpuntresource.
properties.privateEndpoint	PrivateEndpoint	De privé-eindpuntresource.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	De inrichtingsstatus van de privé-eindpuntverbindingsresource.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrivateEndpointConnectionProvisioningState

De huidige inrichtingsstatus.

Name	Type	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.

Name	Type	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.

Name	Type	Description
actionsRequired	string	Een bericht dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen.
description	string	De reden voor goedkeuring/afwijzing van de verbinding.
status	PrivateEndpointServiceConnectionStatus	Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service.

ReplicationRole

De replicatierol.

Name	Type	Description
None	string
Replica	string
Source	string

Server

Vertegenwoordigt een server.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
identity.principalId	string	ObjectId van KeyVault
identity.tenantId	string	TenantId van KeyVault
identity.type	ManagedServiceIdentityType	Type beheerde service-identiteit.
identity.userAssignedIdentities	object	Metagegevens van door de gebruiker toegewezen identiteit.
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.administratorLogin	string	De aanmeldingsnaam van de beheerder van een server. Kan alleen worden opgegeven wanneer de server wordt gemaakt (en is vereist voor het maken).
properties.administratorLoginPassword	string	Het wachtwoord van de aanmelding van de beheerder (vereist voor het maken van de server).
properties.availabilityZone	string	informatie over beschikbaarheidszone van de server.
properties.backup	Backup	Back-up van gerelateerde eigenschappen van een server.
properties.createMode	CreateMode	De modus voor het maken van een nieuwe MySQL-server.
properties.dataEncryption	DataEncryption	De gegevensversleuteling voor CMK.
properties.databasePort	integer	De serverdatabasepoort. Kan alleen worden opgegeven wanneer de server wordt gemaakt.
properties.fullyQualifiedDomainName	string	De volledig gekwalificeerde domeinnaam van een server.
properties.highAvailability	HighAvailability	Hoge beschikbaarheid gerelateerde eigenschappen van een server.
properties.importSourceProperties	ImportSourceProperties	Broneigenschappen voor importeren uit opslag.
properties.maintenancePolicy	MaintenancePolicy	Onderhoudsbeleid van een server.
properties.maintenanceWindow	MaintenanceWindow	Onderhoudsvenster van een server. Bekend probleem: kan niet worden ingesteld tijdens het maken van de server of bijgewerkt met andere eigenschappen tijdens het bijwerken van de server; moet afzonderlijk worden bijgewerkt.
properties.network	Network	Netwerkgerelateerde eigenschappen van een server.
properties.privateEndpointConnections	PrivateEndpointConnection[]	PrivateEndpointConnections gerelateerde eigenschappen van een server.
properties.replicaCapacity	integer	Het maximum aantal replica's dat een primaire server kan hebben.
properties.replicationRole	ReplicationRole	De replicatierol.
properties.restorePointInTime	string	Tijd voor het maken van herstelpunten (ISO8601-indeling), waarin de tijd wordt opgegeven waaruit u wilt herstellen.
properties.sourceServerResourceId	string	De mySQL-bronserver-id.
properties.state	ServerState	De status van een server.
properties.storage	Storage	Opslaggerelateerde eigenschappen van een server.
properties.version	ServerVersion	Serverversie.
sku	MySQLServerSku	De SKU (prijscategorie) van de server.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ServerListResult

Een lijst met servers.

Name	Type	Description
nextLink	string	De koppeling wordt gebruikt om de volgende pagina met bewerkingen op te halen.
value	Server[]	De lijst met servers

ServerSkuTier

De laag van de specifieke SKU, bijvoorbeeld GeneralPurpose.

Name	Type	Description
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

ServerState

De status van een server.

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

ServerVersion

De versie van een server.

Name	Type	Description
5.7	string
8.0.21	string

Storage

Eigenschappen van een opslagprofiel van een server

Name	Type	Default value	Description
autoGrow	EnableStatusEnum	Disabled	Automatisch vergroten van opslag inschakelen of niet.
autoIoScaling	EnableStatusEnum	Enabled	Schakel automatisch schalen van IO in of niet.
iops	integer		Opslag-IOPS voor een server.
logOnDisk	EnableStatusEnum	Disabled	Schakel de aanmeldingsschijf in of niet.
storageRedundancy	StorageRedundancyEnum	LocalRedundancy	Het redundante type serveropslag. De parameter wordt gebruikt voor het maken van de server.
storageSizeGB	integer		Maximale opslaggrootte die is toegestaan voor een server.
storageSku	string		De sKU-naam van de serveropslag.

StorageRedundancyEnum

Enum om aan te geven of de opslag-sKU-waarde ZoneRedundancy of LocalRedundancy is

Name	Type	Description
LocalRedundancy	string
ZoneRedundancy	string

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.