Replicas - List By Server

Layanan:

MySQL

Versi API:

2024-06-01-preview

Cantumkan semua replika untuk server tertentu.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
serverName	path	True	string	Nama server. Pola regex: ^[a-z0-9][-a-z0-9]*(?<!-)$
subscriptionId	path	True	string uuid	ID langganan target. Nilainya harus UUID.
api-version	query	True	string	Versi API yang akan digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	ServerListResult	OKE
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

List replicas for a server

Permintaan sampel

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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
Backup	Properti Profil Penyimpanan server
createdByType	Jenis identitas yang membuat sumber daya.
CreateMode	Mode untuk membuat server MySQL baru.
DataEncryption	Enkripsi tanggal untuk cmk.
DataEncryptionType	Jenis kunci, AzureKeyVault untuk mengaktifkan cmk, SystemManaged untuk menonaktifkan cmk.
EnableStatusEnum	Enum untuk menunjukkan apakah nilai 'Diaktifkan' atau 'Dinonaktifkan'
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
HighAvailability	Properti ketersediaan tinggi server
HighAvailabilityMode	Mode ketersediaan tinggi untuk server.
HighAvailabilityState	Status ketersediaan tinggi server.
ImportSourceProperties	Mengimpor properti terkait sumber.
ImportSourceStorageType	Jenis penyimpanan sumber impor.
MaintenancePolicy	Kebijakan pemeliharaan server.
MaintenanceWindow	Jendela pemeliharaan server.
ManagedServiceIdentityType	Jenis identitas layanan terkelola.
MySQLServerSku	Properti terkait informasi penagihan server.
Network	Properti terkait jaringan server
PatchStrategy	Enum untuk menunjukkan strategi patch server
PrivateEndpoint	Sumber daya titik akhir privat.
PrivateEndpointConnection	Sumber daya koneksi titik akhir privat.
PrivateEndpointConnectionProvisioningState	Status provisi saat ini.
PrivateEndpointServiceConnectionStatus	Status koneksi titik akhir privat.
PrivateLinkServiceConnectionState	Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.
ReplicationRole	Peran replikasi.
Server	Mewakili server.
ServerListResult	Daftar server.
ServerSkuTier	Tingkat SKU tertentu, misalnya GeneralPurpose.
ServerState	Status server.
ServerVersion	Versi server.
Storage	Properti Profil Penyimpanan server
StorageRedundancyEnum	Enum untuk menunjukkan apakah nilai sku penyimpanan adalah 'ZoneRedundancy' atau 'LocalRedundancy'
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Backup

Properti Profil Penyimpanan server

Nama	Jenis	Nilai default	Deskripsi
backupIntervalHours	integer		Jam interval cadangan untuk server.
backupRetentionDays	integer		Hari retensi cadangan untuk server.
earliestRestoreDate	string		Waktu pembuatan titik pemulihan paling awal (format ISO8601)
geoRedundantBackup	EnableStatusEnum	Disabled	Apakah pencadangan geo redundan diaktifkan atau tidak.

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Mode untuk membuat server MySQL baru.

Nama	Jenis	Deskripsi
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string

DataEncryption

Enkripsi tanggal untuk cmk.

Nama	Jenis	Deskripsi
geoBackupKeyURI	string	Uri kunci cadangan geografis karena brankas kunci tidak dapat melintasi wilayah, membutuhkan cmk di wilayah yang sama dengan cadangan geografis
geoBackupUserAssignedIdentityId	string	Id sumber daya identitas pengguna cadangan geografis karena identitas tidak dapat lintas wilayah, memerlukan identitas di wilayah yang sama dengan cadangan geografis
primaryKeyURI	string	Uri kunci primer
primaryUserAssignedIdentityId	string	Id sumber daya identitas pengguna utama
type	DataEncryptionType	Jenis kunci, AzureKeyVault untuk mengaktifkan cmk, SystemManaged untuk menonaktifkan cmk.

DataEncryptionType

Jenis kunci, AzureKeyVault untuk mengaktifkan cmk, SystemManaged untuk menonaktifkan cmk.

Nama	Jenis	Deskripsi
AzureKeyVault	string
SystemManaged	string

EnableStatusEnum

Enum untuk menunjukkan apakah nilai 'Diaktifkan' atau 'Dinonaktifkan'

Nama	Jenis	Deskripsi
Disabled	string
Enabled	string

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

HighAvailability

Properti ketersediaan tinggi server

Nama	Jenis	Deskripsi
mode	HighAvailabilityMode	Mode ketersediaan tinggi untuk server.
standbyAvailabilityZone	string	Zona ketersediaan server siaga.
state	HighAvailabilityState	Status ketersediaan tinggi server.

HighAvailabilityMode

Mode ketersediaan tinggi untuk server.

Nama	Jenis	Deskripsi
Disabled	string
SameZone	string
ZoneRedundant	string

HighAvailabilityState

Status ketersediaan tinggi server.

Nama	Jenis	Deskripsi
CreatingStandby	string
FailingOver	string
Healthy	string
NotEnabled	string
RemovingStandby	string

ImportSourceProperties

Mengimpor properti terkait sumber.

Nama	Jenis	Deskripsi
dataDirPath	string	Jalur relatif direktori data dalam penyimpanan.
sasToken	string	Token Sas untuk mengakses penyimpanan sumber. Izin baca dan daftar diperlukan untuk token sas.
storageType	ImportSourceStorageType	Jenis penyimpanan sumber impor.
storageUrl	string	Uri penyimpanan sumber impor.

ImportSourceStorageType

Jenis penyimpanan sumber impor.

Nama	Jenis	Deskripsi
AzureBlob	string

MaintenancePolicy

Kebijakan pemeliharaan server.

Nama	Jenis	Deskripsi
patchStrategy	PatchStrategy	Strategi patch server ini

MaintenanceWindow

Jendela pemeliharaan server.

Nama	Jenis	Deskripsi
customWindow	string	menunjukkan apakah jendela kustom diaktifkan atau dinonaktifkan
dayOfWeek	integer	hari dalam seminggu untuk jendela pemeliharaan
startHour	integer	jam mulai untuk jendela pemeliharaan
startMinute	integer	menit awal untuk jendela pemeliharaan

ManagedServiceIdentityType

Jenis identitas layanan terkelola.

Nama	Jenis	Deskripsi
UserAssigned	string

MySQLServerSku

Properti terkait informasi penagihan server.

Nama	Jenis	Deskripsi
name	string	Nama sku, misalnya Standard_D32s_v3.
tier	ServerSkuTier	Tingkat SKU tertentu, misalnya GeneralPurpose.

Network

Properti terkait jaringan server

Nama	Jenis	Deskripsi
delegatedSubnetResourceId	string	Id sumber daya subnet yang didelegasikan digunakan untuk menyiapkan vnet untuk server.
privateDnsZoneResourceId	string	Id sumber daya zona DNS privat.
publicNetworkAccess	EnableStatusEnum	Apakah akses jaringan publik diperbolehkan atau tidak untuk server ini. Nilai adalah 'Dinonaktifkan' ketika server memiliki integrasi VNet.

PatchStrategy

Enum untuk menunjukkan strategi patch server

Nama	Jenis	Deskripsi
Regular	string
VirtualCanary	string

PrivateEndpoint

Sumber daya titik akhir privat.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi ARM untuk titik akhir privat.

PrivateEndpointConnection

Sumber daya koneksi titik akhir privat.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nama sumber daya
properties.groupIds	string[]	Id grup untuk sumber daya titik akhir privat.
properties.privateEndpoint	PrivateEndpoint	Sumber daya titik akhir privat.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Status provisi sumber daya koneksi titik akhir privat.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Status provisi saat ini.

Nama	Jenis	Deskripsi
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

Status koneksi titik akhir privat.

Nama	Jenis	Deskripsi
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.

Nama	Jenis	Deskripsi
actionsRequired	string	Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.
description	string	Alasan persetujuan/penolakan koneksi.
status	PrivateEndpointServiceConnectionStatus	Menunjukkan apakah koneksi telah Disetujui/Ditolak/Dihapus oleh pemilik layanan.

ReplicationRole

Peran replikasi.

Nama	Jenis	Deskripsi
None	string
Replica	string
Source	string

Server

Mewakili server.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity.principalId	string	ObjectId dari KeyVault
identity.tenantId	string	TenantId dari KeyVault
identity.type	ManagedServiceIdentityType	Jenis identitas layanan terkelola.
identity.userAssignedIdentities	object	Metadata identitas yang ditetapkan pengguna.
location	string	Lokasi geografis tempat sumber daya berada
name	string	Nama sumber daya
properties.administratorLogin	string	Nama masuk administrator server. Hanya dapat ditentukan ketika server sedang dibuat (dan diperlukan untuk pembuatan).
properties.administratorLoginPassword	string	Kata sandi login administrator (diperlukan untuk pembuatan server).
properties.availabilityZone	string	informasi zona ketersediaan server.
properties.backup	Backup	Mencadangkan properti terkait server.
properties.createMode	CreateMode	Mode untuk membuat server MySQL baru.
properties.dataEncryption	DataEncryption	Enkripsi Data untuk CMK.
properties.databasePort	integer	Port database server. Hanya dapat ditentukan ketika server sedang dibuat.
properties.fullyQualifiedDomainName	string	Nama domain server yang sepenuhnya memenuhi syarat.
properties.highAvailability	HighAvailability	Properti terkait ketersediaan tinggi server.
properties.importSourceProperties	ImportSourceProperties	Properti sumber untuk impor dari penyimpanan.
properties.maintenancePolicy	MaintenancePolicy	Kebijakan pemeliharaan server.
properties.maintenanceWindow	MaintenanceWindow	Jendela pemeliharaan server. Masalah yang diketahui: tidak dapat diatur selama pembuatan server atau diperbarui dengan properti lain selama pembaruan server; harus diperbarui secara terpisah.
properties.network	Network	Properti terkait jaringan server.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Properti terkait PrivateEndpointConnections dari server.
properties.replicaCapacity	integer	Jumlah maksimum replika yang dapat dimiliki server utama.
properties.replicationRole	ReplicationRole	Peran replikasi.
properties.restorePointInTime	string	Waktu pembuatan titik pemulihan (format ISO8601), menentukan waktu untuk memulihkan.
properties.sourceServerResourceId	string	Id server MySQL sumber.
properties.state	ServerState	Status server.
properties.storage	Storage	Properti terkait penyimpanan server.
properties.version	ServerVersion	Versi server.
sku	MySQLServerSku	SKU (tingkat harga) server.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

ServerListResult

Daftar server.

Nama	Jenis	Deskripsi
nextLink	string	Tautan yang digunakan untuk mendapatkan halaman operasi berikutnya.
value	Server[]	Daftar server

ServerSkuTier

Tingkat SKU tertentu, misalnya GeneralPurpose.

Nama	Jenis	Deskripsi
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

ServerState

Status server.

Nama	Jenis	Deskripsi
Disabled	string
Dropping	string
Ready	string
Starting	string
Stopped	string
Stopping	string
Updating	string

ServerVersion

Versi server.

Nama	Jenis	Deskripsi
5.7	string
8.0.21	string

Storage

Properti Profil Penyimpanan server

Nama	Jenis	Nilai default	Deskripsi
autoGrow	EnableStatusEnum	Disabled	Aktifkan Penyimpanan Tumbuh Otomatis atau tidak.
autoIoScaling	EnableStatusEnum	Enabled	Aktifkan Auto Scaling IO atau tidak.
iops	integer		IOPS penyimpanan untuk server.
logOnDisk	EnableStatusEnum	Disabled	Aktifkan Disk Masuk atau tidak.
storageRedundancy	StorageRedundancyEnum	LocalRedundancy	Jenis penyimpanan server yang berlebihan. Parameter digunakan untuk pembuatan server.
storageSizeGB	integer		Ukuran penyimpanan maks yang diizinkan untuk server.
storageSku	string		Nama sku penyimpanan server.

StorageRedundancyEnum

Enum untuk menunjukkan apakah nilai sku penyimpanan adalah 'ZoneRedundancy' atau 'LocalRedundancy'

Nama	Jenis	Deskripsi
LocalRedundancy	string
ZoneRedundancy	string

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.