Replicas - List By Server

Service:

MySQL

API Version:

2023-06-30

特定のサーバーのすべてのレプリカを一覧表示します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソース グループの名前。 名前の大文字と小文字は区別されます。
serverName	path	True	string	サーバーの名前。 Regex pattern: ^[a-z0-9][-a-z0-9]*(?<!-)$
subscriptionId	path	True	string uuid	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	ServerListResult	OK
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

List replicas for a server

Sample Request

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/replicas?api-version=2023-06-30

Sample Response

Status code:

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

定義

名前	説明
Backup	サーバーのストレージ プロファイル プロパティ
createdByType	リソースを作成した ID の種類。
CreateMode	新しい MySQL サーバーを作成するモード。
DataEncryption	cmk の日付暗号化。
DataEncryptionType	キーの種類 (Enable cmk の場合は AzureKeyVault、無効 cmk の場合は SystemManaged)。
EnableStatusEnum	値が 'Enabled' か 'Disabled' かを示す列挙型
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
HighAvailability	サーバーのネットワーク関連のプロパティ
HighAvailabilityMode	サーバーの高可用性モード。
HighAvailabilityState	サーバーの高可用性の状態。
ImportSourceProperties	ソース関連のプロパティをインポートします。
ImportSourceStorageType	インポート ソースのストレージの種類。
MaintenanceWindow	サーバーのメンテナンス期間。
ManagedServiceIdentityType	マネージド サービス ID の種類。
MySQLServerSku	サーバーの課金情報関連のプロパティ。
Network	サーバーのネットワーク関連のプロパティ
PrivateEndpoint	プライベート エンドポイント リソース。
PrivateEndpointConnection	プライベート エンドポイント接続リソース。
PrivateEndpointConnectionProvisioningState	現在のプロビジョニング状態。
PrivateEndpointServiceConnectionStatus	プライベート エンドポイント接続の状態。
PrivateLinkServiceConnectionState	サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
ReplicationRole	レプリケーション ロール。
Server	サーバーを表します。
ServerListResult	サーバーの一覧。
ServerSkuTier	特定の SKU のレベル (GeneralPurpose など)。
ServerState	サーバーの状態。
ServerVersion	サーバーのバージョン。
Storage	サーバーのストレージ プロファイル プロパティ
systemData	リソースの作成と最後の変更に関連するメタデータ。

Backup

サーバーのストレージ プロファイル プロパティ

名前	型	既定値	説明
backupRetentionDays	integer		サーバーのバックアップ保有日数。
earliestRestoreDate	string		最も古い復元ポイントの作成時間 (ISO8601形式)
geoRedundantBackup	EnableStatusEnum	Disabled	geo 冗長バックアップが有効になっているかどうか。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

新しい MySQL サーバーを作成するモード。

名前	型	説明
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string

DataEncryption

cmk の日付暗号化。

名前	型	説明
geoBackupKeyURI	string	キー コンテナーがリージョンをまたがることができない geo バックアップ キー URI、geo バックアップと同じリージョンに cmk が必要
geoBackupUserAssignedIdentityId	string	リージョン間で ID を使用できない geo バックアップ ユーザー ID リソース ID、geo バックアップと同じリージョンに ID が必要
primaryKeyURI	string	主キー URI
primaryUserAssignedIdentityId	string	プライマリ ユーザー ID リソース ID
type	DataEncryptionType	キーの種類 (Enable cmk の場合は AzureKeyVault、無効 cmk の場合は SystemManaged)。

DataEncryptionType

キーの種類 (Enable cmk の場合は AzureKeyVault、無効 cmk の場合は SystemManaged)。

名前	型	説明
AzureKeyVault	string
SystemManaged	string

EnableStatusEnum

値が 'Enabled' か 'Disabled' かを示す列挙型

名前	型	説明
Disabled	string
Enabled	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

HighAvailability

サーバーのネットワーク関連のプロパティ

名前	型	説明
mode	HighAvailabilityMode	サーバーの高可用性モード。
standbyAvailabilityZone	string	スタンバイ サーバーの可用性ゾーン。
state	HighAvailabilityState	サーバーの高可用性の状態。

HighAvailabilityMode

サーバーの高可用性モード。

名前	型	説明
Disabled	string
SameZone	string
ZoneRedundant	string

HighAvailabilityState

サーバーの高可用性の状態。

名前	型	説明
CreatingStandby	string
FailingOver	string
Healthy	string
NotEnabled	string
RemovingStandby	string

ImportSourceProperties

ソース関連のプロパティをインポートします。

名前	型	説明
dataDirPath	string	ストレージ内のデータ ディレクトリの相対パス。
sasToken	string	ソース ストレージにアクセスするための Sas トークン。 sas トークンには読み取りと一覧表示のアクセス許可が必要です。
storageType	ImportSourceStorageType	インポート ソースのストレージの種類。
storageUrl	string	インポート ソース ストレージの URI。

ImportSourceStorageType

インポート ソースのストレージの種類。

名前	型	説明
AzureBlob	string

MaintenanceWindow

サーバーのメンテナンス期間。

名前	型	説明
customWindow	string	は、カスタム ウィンドウが有効か無効かを示します
dayOfWeek	integer	メンテナンス期間の曜日
startHour	integer	メンテナンス期間の開始時刻
startMinute	integer	メンテナンス期間の開始時間 (分)

ManagedServiceIdentityType

マネージド サービス ID の種類。

名前	型	説明
UserAssigned	string

MySQLServerSku

サーバーの課金情報関連のプロパティ。

名前	型	説明
name	string	sku の名前 (例: Standard_D32s_v3)。
tier	ServerSkuTier	特定の SKU のレベル (GeneralPurpose など)。

Network

サーバーのネットワーク関連のプロパティ

名前	型	説明
delegatedSubnetResourceId	string	サーバーの vnet のセットアップに使用される委任されたサブネット リソース ID。
privateDnsZoneResourceId	string	ゾーン リソース ID をプライベート DNSします。
publicNetworkAccess	EnableStatusEnum	このサーバーに対してパブリック ネットワーク アクセスが許可されているかどうか。 サーバーに VNet 統合がある場合、値は "無効" です。

PrivateEndpoint

プライベート エンドポイント リソース。

名前	型	説明
id	string	プライベート エンドポイントの ARM 識別子。

PrivateEndpointConnection

プライベート エンドポイント接続リソース。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.groupIds	string[]	プライベート エンドポイント リソースのグループ ID。
properties.privateEndpoint	PrivateEndpoint	プライベート エンドポイント リソース。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	プライベート エンドポイント接続リソースのプロビジョニング状態。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

現在のプロビジョニング状態。

名前	型	説明
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

プライベート エンドポイント接続の状態。

名前	型	説明
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。

名前	型	説明
actionsRequired	string	サービス プロバイダーの変更にコンシューマーに対する更新が必要かどうかを示すメッセージ。
description	string	接続の承認/拒否の理由。
status	PrivateEndpointServiceConnectionStatus	サービスの所有者によって接続が承認/拒否/削除されたかどうかを示します。

ReplicationRole

レプリケーション ロール。

名前	型	説明
None	string
Replica	string
Source	string

Server

サーバーを表します。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity.principalId	string	KeyVault からの ObjectId
identity.tenantId	string	KeyVault からの TenantId
identity.type	ManagedServiceIdentityType	マネージド サービス ID の種類。
identity.userAssignedIdentities	object	ユーザー割り当て ID のメタデータ。
location	string	リソースが保存されている地理的な場所
name	string	リソースの名前
properties.administratorLogin	string	サーバーの管理者のログイン名。 サーバーが作成されている場合にのみ指定できます (作成に必要です)。
properties.administratorLoginPassword	string	管理者ログインのパスワード (サーバーの作成に必要)。
properties.availabilityZone	string	サーバーの可用性ゾーン情報。
properties.backup	Backup	サーバーのバックアップ関連プロパティ。
properties.createMode	CreateMode	新しい MySQL サーバーを作成するモード。
properties.dataEncryption	DataEncryption	CMK のデータ暗号化。
properties.fullyQualifiedDomainName	string	サーバーの完全修飾ドメイン名。
properties.highAvailability	HighAvailability	サーバーの高可用性関連のプロパティ。
properties.importSourceProperties	ImportSourceProperties	ストレージからのインポートのソース プロパティ。
properties.maintenanceWindow	MaintenanceWindow	サーバーのメンテナンス期間。
properties.network	Network	サーバーのネットワーク関連のプロパティ。
properties.privateEndpointConnections	PrivateEndpointConnection[]	サーバーの PrivateEndpointConnections 関連プロパティ。
properties.replicaCapacity	integer	プライマリ サーバーで使用できるレプリカの最大数。
properties.replicationRole	ReplicationRole	レプリケーション ロール。
properties.restorePointInTime	string	復元ポイントの作成時刻 (ISO8601形式)、復元元の時刻を指定します。
properties.sourceServerResourceId	string	ソース MySQL サーバー ID。
properties.state	ServerState	サーバーの状態。
properties.storage	Storage	サーバーのストレージ関連のプロパティ。
properties.version	ServerVersion	サーバーのバージョン。
sku	MySQLServerSku	サーバーの SKU (価格レベル)。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソース タグ。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ServerListResult

サーバーの一覧。

名前	型	説明
nextLink	string	操作の次のページを取得するために使用されるリンク。
value	Server[]	サーバーの一覧

ServerSkuTier

特定の SKU のレベル (GeneralPurpose など)。

名前	型	説明
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

ServerState

サーバーの状態。

名前	型	説明
Disabled	string
Dropping	string
Ready	string
Starting	string
Stopped	string
Stopping	string
Updating	string

ServerVersion

サーバーのバージョン。

名前	型	説明
5.7	string
8.0.21	string

Storage

サーバーのストレージ プロファイル プロパティ

名前	型	既定値	説明
autoGrow	EnableStatusEnum	Disabled	ストレージの自動拡張を有効にするかどうか。
autoIoScaling	EnableStatusEnum	Disabled	IO 自動スケーリングを有効にするかどうか。
iops	integer		サーバーのストレージ IOPS。
logOnDisk	EnableStatusEnum	Disabled	[ログオン ディスク] を有効にするかどうか。
storageSizeGB	integer		サーバーで許可される最大ストレージ サイズ。
storageSku	string		サーバー ストレージの SKU 名。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。