Sync Members - Get

服務:: SQL Database

API 版本:: 2025-01-01

取得同步成員。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}?api-version=2025-01-01

URI 參數

名稱	位於	必要	類型	Description
databaseName	path	True	string	同步群組裝載所在的資料庫名稱。
resourceGroupName	path	True	string	包含資源的資源群組名稱。您可以從 Azure Resource Manager API 或入口網站取得此值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	識別 Azure 訂用帳戶的訂用帳戶標識碼。
syncGroupName	path	True	string	同步成員裝載所在的同步群組名稱。
syncMemberName	path	True	string	同步成員的名稱。
api-version	query	True	string	要用於要求的 API 版本。

回應

名稱	類型	Description
200 OK	SyncMember	已成功擷取指定的同步成員。
Other Status Codes	ErrorResponse	錯誤回應： *** 400 InvalidSyncGroupCreateOrUpdateRequest - 建立或更新同步群組要求本文是空的。 400 InvalidSyncMemberCreateOrUpdateRequest - 建立或更新同步成員要求本文是空的。 400 InvalidSyncAgentCreateOrUpdateRequest - 建立或更新同步代理程式要求本文是空的。 400 InvalidDatabaseResourceId - 資料庫資源標識符無效。 400 InvalidSyncGroupName - 同步組名無效。此欄位可以包含字母、數位、虛線和底線。 400 InvalidSyncMemberName - 同步成員名稱無效。此欄位可以包含字母、數位、虛線和底線。 400 MissingSyncMemberName - 遺漏同步成員名稱 400 InvalidSyncGroupInterval - 同步間隔應大於或等於 5 秒。 400 MismatchingSubscriptionWithUrl - 提供的訂用帳戶不符合 Url 中的訂用帳戶。 400 InvalidSyncAgentResourceId - 無效的同步代理程序資源標識符。 400 不符ResourceGroupNameWithUrl - 提供的資源組名不符合 Url 中的名稱。 400 不相符ServerNameWithUrl - 提供的伺服器名稱不符合 Url 中的名稱。 400 InvalidParameterValue - 為參數指定了無效的值。 400 MissingServerName - 遺漏伺服器名稱 400 MissingDatabaseName - 資料庫名稱遺失 400 MissingSyncGroupName - 遺失同步組名 400 MissingConflictResolutionPolicy - 遺漏衝突解決原則 400 MissingSyncAgentName - 遺漏同步代理程序名稱 400 DataSyncMissingIdentityType - 必須指定標識類型。 400 DataSyncMissingUserAssignedIdentities - 標識類型設置為“UserAssigned”，但未列出使用者分配的標識。 400 DataSyncMissingAuthenticationInfo - 必須至少提供一種身份驗證方法。 400 DataSyncInvalidIdentityType - 在同步配置中指定了無法識別或不受支持的標識類型。 400 DataSyncMultipleIdentities - 同步配置僅支援一個使用者分配的託管標識。 400 SyncOperation_GenericFailure - 無法執行資料同步作業。 400 InvalidSyncGroup - 同步群組無效。 400 InvalidSyncMember - 同步成員無效。 400 InvalidSyncAgent - 同步代理程序無效。 400 CannotCreateSyncMemberDueToQuotaExceeded - 因為超過配額而無法建立同步成員。 400 SyncOperation_DuplicateSyncMemberDrop - 同步成員已卸除。 400 SyncOperation_WrongSyncDatabase - 指定的同步資料庫不符合現有的資料庫。 400 SyncOperation_DwInSyncGroup - 無法在數據同步中使用 datawarehouse 版本。 400 SyncOperation_MasterDbInSyncGroup - 無法在資料同步處理中使用邏輯主機。 400 SyncOperation_UnsupportedDataTypeColumnInSchema - 無法將數據行新增至架構，因為不支援數據行的數據類型。 400 SyncOperation_InvalidCredential - 資料庫的認證無效。 400 InvalidSyncMetadataDatabase - 同步元數據資料庫無效。 404 ResourceNotFound - 找不到要求的資源。 404 SubscriptionNotFound - 找不到要求的訂用帳戶。 404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器 404 DatabaseDoesNotExist - 使用者已指定此伺服器實例上不存在的資料庫名稱。 404 SyncOperation_HubServerNotFound - 中樞邏輯伺服器不存在。 404 SyncOperation_InvalidHubDatabase - 中樞資料庫無效。 409 SyncOperation_DuplicateSyncMemberName - 無法建立同步成員，因為具有相同名稱的同步成員已經存在。 429 SubscriptionTooManyRequests - 超出可用資源可處理之最大要求的要求。 503 TooManyRequests - 超出可用資源可處理之最大要求的要求。

名稱

類型

Description

200 OK

SyncMember

已成功擷取指定的同步成員。

Other Status Codes

ErrorResponse

錯誤回應： ***

400 InvalidSyncGroupCreateOrUpdateRequest - 建立或更新同步群組要求本文是空的。
400 InvalidSyncMemberCreateOrUpdateRequest - 建立或更新同步成員要求本文是空的。
400 InvalidSyncAgentCreateOrUpdateRequest - 建立或更新同步代理程式要求本文是空的。
400 InvalidDatabaseResourceId - 資料庫資源標識符無效。
400 InvalidSyncGroupName - 同步組名無效。此欄位可以包含字母、數位、虛線和底線。
400 InvalidSyncMemberName - 同步成員名稱無效。此欄位可以包含字母、數位、虛線和底線。
400 MissingSyncMemberName - 遺漏同步成員名稱
400 InvalidSyncGroupInterval - 同步間隔應大於或等於 5 秒。
400 MismatchingSubscriptionWithUrl - 提供的訂用帳戶不符合 Url 中的訂用帳戶。
400 InvalidSyncAgentResourceId - 無效的同步代理程序資源標識符。
400 不符ResourceGroupNameWithUrl - 提供的資源組名不符合 Url 中的名稱。
400 不相符ServerNameWithUrl - 提供的伺服器名稱不符合 Url 中的名稱。
400 InvalidParameterValue - 為參數指定了無效的值。
400 MissingServerName - 遺漏伺服器名稱
400 MissingDatabaseName - 資料庫名稱遺失
400 MissingSyncGroupName - 遺失同步組名
400 MissingConflictResolutionPolicy - 遺漏衝突解決原則
400 MissingSyncAgentName - 遺漏同步代理程序名稱
400 DataSyncMissingIdentityType - 必須指定標識類型。
400 DataSyncMissingUserAssignedIdentities - 標識類型設置為“UserAssigned”，但未列出使用者分配的標識。
400 DataSyncMissingAuthenticationInfo - 必須至少提供一種身份驗證方法。
400 DataSyncInvalidIdentityType - 在同步配置中指定了無法識別或不受支持的標識類型。
400 DataSyncMultipleIdentities - 同步配置僅支援一個使用者分配的託管標識。
400 SyncOperation_GenericFailure - 無法執行資料同步作業。
400 InvalidSyncGroup - 同步群組無效。
400 InvalidSyncMember - 同步成員無效。
400 InvalidSyncAgent - 同步代理程序無效。
400 CannotCreateSyncMemberDueToQuotaExceeded - 因為超過配額而無法建立同步成員。
400 SyncOperation_DuplicateSyncMemberDrop - 同步成員已卸除。
400 SyncOperation_WrongSyncDatabase - 指定的同步資料庫不符合現有的資料庫。
400 SyncOperation_DwInSyncGroup - 無法在數據同步中使用 datawarehouse 版本。
400 SyncOperation_MasterDbInSyncGroup - 無法在資料同步處理中使用邏輯主機。
400 SyncOperation_UnsupportedDataTypeColumnInSchema - 無法將數據行新增至架構，因為不支援數據行的數據類型。
400 SyncOperation_InvalidCredential - 資料庫的認證無效。
400 InvalidSyncMetadataDatabase - 同步元數據資料庫無效。
404 ResourceNotFound - 找不到要求的資源。
404 SubscriptionNotFound - 找不到要求的訂用帳戶。
404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器
404 DatabaseDoesNotExist - 使用者已指定此伺服器實例上不存在的資料庫名稱。
404 SyncOperation_HubServerNotFound - 中樞邏輯伺服器不存在。
404 SyncOperation_InvalidHubDatabase - 中樞資料庫無效。
409 SyncOperation_DuplicateSyncMemberName - 無法建立同步成員，因為具有相同名稱的同步成員已經存在。
429 SubscriptionTooManyRequests - 超出可用資源可處理之最大要求的要求。
503 TooManyRequests - 超出可用資源可處理之最大要求的要求。

範例

Get a sync member

範例要求

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879?api-version=2025-01-01

範例回覆

狀態碼:: 200

{
  "properties": {
    "databaseType": "AzureSqlDatabase",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "databaseName": "syncgroupcrud-7421",
    "userName": "myUser",
    "syncDirection": "Bidirectional",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤附加資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	錯誤回應
SyncDirection	同步成員的同步方向。
SyncMember	Azure SQL Database 同步成員。
SyncMemberDbType	同步成員的資料庫類型。
SyncMemberState	同步成員的同步狀態。

ErrorAdditionalInfo

Object

資源管理錯誤附加資訊。

名稱	類型	Description
info	object	附加資訊。
type	string	其他資訊類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤附加資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

SyncDirection

列舉型別

同步成員的同步方向。

值	Description
Bidirectional
OneWayMemberToHub
OneWayHubToMember

SyncMember

Object

Azure SQL Database 同步成員。

名稱	類型	Description
id	string	資源標識碼。
name	string	資源名稱。
properties.databaseName	string	同步成員中成員資料庫的資料庫名稱。
properties.databaseType	SyncMemberDbType	同步成員的資料庫類型。
properties.password	string	同步成員中成員資料庫的密碼。
properties.privateEndpointName	string	如果已啟用私人連結連線，則同步成員的私人端點名稱，適用於 Azure 中的同步成員。
properties.serverName	string	同步成員中成員資料庫的伺服器名稱
properties.sqlServerDatabaseId	string (uuid)	同步成員的 SQL Server 資料庫標識碼。
properties.syncAgentId	string	同步成員中同步代理程式的 ARM 資源識別碼。
properties.syncDirection	SyncDirection	同步成員的同步方向。
properties.syncMemberAzureDatabaseResourceId	string	同步成員邏輯資料庫的 ARM 資源識別碼，適用於 Azure 中的同步成員。
properties.syncState	SyncMemberState	同步成員的同步狀態。
properties.usePrivateLinkConnection	boolean	是否要使用私人連結連線。
properties.userName	string	同步成員中成員資料庫的用戶名稱。
type	string	資源類型。

SyncMemberDbType

列舉型別

同步成員的資料庫類型。

值	Description
AzureSqlDatabase
SqlServerDatabase

SyncMemberState

列舉型別

同步成員的同步狀態。

值	Description
SyncInProgress
SyncSucceeded
SyncFailed
DisabledTombstoneCleanup
DisabledBackupRestore
SyncSucceededWithWarnings
SyncCancelling
SyncCancelled
UnProvisioned
Provisioning
Provisioned
ProvisionFailed
DeProvisioning
DeProvisioned
DeProvisionFailed
Reprovisioning
ReprovisionFailed
UnReprovisioned

共用方式為

Sync Members - Get

URI 參數

回應

範例

Get a sync member

範例要求

範例回覆

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SyncDirection

SyncMember

SyncMemberDbType

SyncMemberState