Replicas - List By Server

Tjänst:

MySQL

API-version:

2024-06-01-preview

Visa en lista över alla repliker för en viss server.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serverName	path	True	string	Namnet på servern. Reguljärt uttrycksmönster: ^[a-z0-9][-a-z0-9]*(?<!-)$
subscriptionId	path	True	string uuid	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	ServerListResult	OKEJ
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

List replicas for a server

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
Backup	Egenskaper för lagringsprofil för en server
createdByType	Den typ av identitet som skapade resursen.
CreateMode	Läget för att skapa en ny MySQL-server.
DataEncryption	Datumkryptering för cmk.
DataEncryptionType	Nyckeltypen AzureKeyVault för enable cmk, SystemManaged for disable cmk.
EnableStatusEnum	Uppräkning för att ange om värdet är "Aktiverat" eller "Inaktiverat"
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
HighAvailability	Egenskaper för hög tillgänglighet för en server
HighAvailabilityMode	Läge för hög tillgänglighet för en server.
HighAvailabilityState	Tillståndet för serverns höga tillgänglighet.
ImportSourceProperties	Importera källrelaterade egenskaper.
ImportSourceStorageType	Lagringstyp för importkälla.
MaintenancePolicy	Underhållsprincip för en server.
MaintenanceWindow	Underhållsperiod för en server.
ManagedServiceIdentityType	Typ av hanterad tjänstidentitet.
MySQLServerSku	Egenskaper relaterade till faktureringsinformation för en server.
Network	Nätverksrelaterade egenskaper för en server
PatchStrategy	Uppräkning som anger korrigeringsstrategin för en server
PrivateEndpoint	Den privata slutpunktsresursen.
PrivateEndpointConnection	Den privata slutpunktsanslutningsresursen.
PrivateEndpointConnectionProvisioningState	Det aktuella etableringstillståndet.
PrivateEndpointServiceConnectionStatus	Anslutningsstatus för privat slutpunkt.
PrivateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.
ReplicationRole	Replikeringsrollen.
Server	Representerar en server.
ServerListResult	En lista över servrar.
ServerSkuTier	Nivån för den specifika SKU:n, t.ex. GeneralPurpose.
ServerState	Tillståndet för en server.
ServerVersion	Versionen av en server.
Storage	Egenskaper för lagringsprofil för en server
StorageRedundancyEnum	Uppräkning för att ange om lagrings-sku-värdet är "ZoneRedundancy" eller "LocalRedundancy"
systemData	Metadata som rör skapande och senaste ändring av resursen.

Backup

Egenskaper för lagringsprofil för en server

Name	Typ	Standardvärde	Description
backupIntervalHours	integer		Säkerhetskopieringsintervalltimmar för servern.
backupRetentionDays	integer		Kvarhållningsdagar för säkerhetskopiering för servern.
earliestRestoreDate	string		Tidigaste skapandetid för återställningspunkt (ISO8601 format)
geoRedundantBackup	EnableStatusEnum	Disabled	Om geo-redundant säkerhetskopiering är aktiverat eller inte.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Läget för att skapa en ny MySQL-server.

Name	Typ	Description
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string

DataEncryption

Datumkryptering för cmk.

Name	Typ	Description
geoBackupKeyURI	string	Geo-säkerhetskopieringsnyckel-URI som nyckelvalv kan inte korsa region, behöver cmk i samma region som geo-säkerhetskopiering
geoBackupUserAssignedIdentityId	string	Geo-säkerhetskopiering av användaridentitetsresurs-ID som identitet kan inte korsa region, behöver identitet i samma region som geo-säkerhetskopiering
primaryKeyURI	string	Primärnyckel-URI
primaryUserAssignedIdentityId	string	Resurs-ID för primär användaridentitet
type	DataEncryptionType	Nyckeltypen AzureKeyVault för enable cmk, SystemManaged for disable cmk.

DataEncryptionType

Nyckeltypen AzureKeyVault för enable cmk, SystemManaged for disable cmk.

Name	Typ	Description
AzureKeyVault	string
SystemManaged	string

EnableStatusEnum

Uppräkning för att ange om värdet är "Aktiverat" eller "Inaktiverat"

Name	Typ	Description
Disabled	string
Enabled	string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

HighAvailability

Egenskaper för hög tillgänglighet för en server

Name	Typ	Description
mode	HighAvailabilityMode	Läge för hög tillgänglighet för en server.
standbyAvailabilityZone	string	Tillgänglighetszon för väntelägesservern.
state	HighAvailabilityState	Tillståndet för serverns höga tillgänglighet.

HighAvailabilityMode

Läge för hög tillgänglighet för en server.

Name	Typ	Description
Disabled	string
SameZone	string
ZoneRedundant	string

HighAvailabilityState

Tillståndet för serverns höga tillgänglighet.

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

ImportSourceProperties

Importera källrelaterade egenskaper.

Name	Typ	Description
dataDirPath	string	Relativ sökväg för datakatalogen i lagringen.
sasToken	string	Sas-token för åtkomst till källlagring. Läs- och listbehörigheter krävs för sas-token.
storageType	ImportSourceStorageType	Lagringstyp för importkälla.
storageUrl	string	Uri för importkällans lagring.

ImportSourceStorageType

Lagringstyp för importkälla.

Name	Typ	Description
AzureBlob	string

MaintenancePolicy

Underhållsprincip för en server.

Name	Typ	Description
patchStrategy	PatchStrategy	Korrigeringsstrategin för den här servern

MaintenanceWindow

Underhållsperiod för en server.

Name	Typ	Description
customWindow	string	anger om anpassat fönster är aktiverat eller inaktiverat
dayOfWeek	integer	dag i veckan för underhållsperiod
startHour	integer	starttimmes för underhållsperiod
startMinute	integer	startminut för underhållsperiod

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet.

Name	Typ	Description
UserAssigned	string

MySQLServerSku

Egenskaper relaterade till faktureringsinformation för en server.

Name	Typ	Description
name	string	Namnet på sku:n, t.ex. Standard_D32s_v3.
tier	ServerSkuTier	Nivån för den specifika SKU:n, t.ex. GeneralPurpose.

Network

Nätverksrelaterade egenskaper för en server

Name	Typ	Description
delegatedSubnetResourceId	string	Delegerat resurs-ID för undernät som används för att konfigurera vnet för en server.
privateDnsZoneResourceId	string	Resurs-ID för privat DNS-zon.
publicNetworkAccess	EnableStatusEnum	Om offentlig nätverksåtkomst tillåts för den här servern eller inte. Värdet är Inaktiverat när servern har VNet-integrering.

PatchStrategy

Uppräkning som anger korrigeringsstrategin för en server

Name	Typ	Description
Regular	string
VirtualCanary	string

PrivateEndpoint

Den privata slutpunktsresursen.

Name	Typ	Description
id	string	ARM-identifieraren för privat slutpunkt.

PrivateEndpointConnection

Den privata slutpunktsanslutningsresursen.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties.groupIds	string[]	Grupp-ID:t för den privata slutpunktsresursen.
properties.privateEndpoint	PrivateEndpoint	Den privata slutpunktsresursen.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Etableringstillståndet för den privata slutpunktsanslutningsresursen.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Det aktuella etableringstillståndet.

Name	Typ	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

Name	Typ	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

Name	Typ	Description
actionsRequired	string	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.
description	string	Orsak till godkännande/avvisande av anslutningen.
status	PrivateEndpointServiceConnectionStatus	Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.

ReplicationRole

Replikeringsrollen.

Name	Typ	Description
None	string
Replica	string
Source	string

Server

Representerar en server.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity.principalId	string	ObjectId från KeyVault
identity.tenantId	string	TenantId från KeyVault
identity.type	ManagedServiceIdentityType	Typ av hanterad tjänstidentitet.
identity.userAssignedIdentities	object	Metadata för användartilldelad identitet.
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.administratorLogin	string	Administratörens inloggningsnamn för en server. Kan bara anges när servern skapas (och krävs för att skapa).
properties.administratorLoginPassword	string	Lösenordet för administratörsinloggningen (krävs för att skapa servern).
properties.availabilityZone	string	tillgänglighet Zoninformation för servern.
properties.backup	Backup	Säkerhetskopiera relaterade egenskaper för en server.
properties.createMode	CreateMode	Läget för att skapa en ny MySQL-server.
properties.dataEncryption	DataEncryption	Datakryptering för CMK.
properties.databasePort	integer	Serverdatabasporten. Det går bara att ange när servern skapas.
properties.fullyQualifiedDomainName	string	Det fullständigt kvalificerade domännamnet för en server.
properties.highAvailability	HighAvailability	Egenskaper relaterade till hög tillgänglighet för en server.
properties.importSourceProperties	ImportSourceProperties	Källegenskaper för import från lagring.
properties.maintenancePolicy	MaintenancePolicy	Underhållsprincip för en server.
properties.maintenanceWindow	MaintenanceWindow	Underhållsperiod för en server. Känt problem: kan inte anges när servern skapas eller uppdateras med andra egenskaper under serveruppdateringen. måste uppdateras separat.
properties.network	Network	Nätverksrelaterade egenskaper för en server.
properties.privateEndpointConnections	PrivateEndpointConnection[]	PrivateEndpointConnections-relaterade egenskaper för en server.
properties.replicaCapacity	integer	Det maximala antalet repliker som en primär server kan ha.
properties.replicationRole	ReplicationRole	Replikeringsrollen.
properties.restorePointInTime	string	Skapandetid för återställningspunkt (ISO8601 format) som anger den tid som du ska återställa från.
properties.sourceServerResourceId	string	MySQL-källserverns ID.
properties.state	ServerState	Tillståndet för en server.
properties.storage	Storage	Lagringsrelaterade egenskaper för en server.
properties.version	ServerVersion	Serverversion.
sku	MySQLServerSku	Serverns SKU (prisnivå).
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Resurstaggar.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ServerListResult

En lista över servrar.

Name	Typ	Description
nextLink	string	Länken som används för att hämta nästa sida med åtgärder.
value	Server[]	Listan över servrar

ServerSkuTier

Nivån för den specifika SKU:n, t.ex. GeneralPurpose.

Name	Typ	Description
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

ServerState

Tillståndet för en server.

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

ServerVersion

Versionen av en server.

Name	Typ	Description
5.7	string
8.0.21	string

Storage

Egenskaper för lagringsprofil för en server

Name	Typ	Standardvärde	Description
autoGrow	EnableStatusEnum	Disabled	Aktivera Automatisk ökning av lagring eller inte.
autoIoScaling	EnableStatusEnum	Enabled	Aktivera automatisk I/O-skalning eller inte.
iops	integer		Lagrings-IOPS för en server.
logOnDisk	EnableStatusEnum	Disabled	Aktivera Inloggningsdisk eller inte.
storageRedundancy	StorageRedundancyEnum	LocalRedundancy	Den redundanta typen av serverlagring. Parametern används för att skapa servern.
storageSizeGB	integer		Maximal lagringsstorlek som tillåts för en server.
storageSku	string		SKU-namnet på serverlagringen.

StorageRedundancyEnum

Uppräkning för att ange om lagrings-sku-värdet är "ZoneRedundancy" eller "LocalRedundancy"

Name	Typ	Description
LocalRedundancy	string
ZoneRedundancy	string

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.