Sync Groups - Get

リファレンス

サービス:: SQL Database

API バージョン:: 2021-11-01

同期グループを取得します。

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

URI パラメーター

名前	/	必須	型	説明
databaseName	path	True	string	同期グループがホストされているデータベースの名前。
resourceGroupName	path	True	string	リソースが含まれているリソースグループの名前。この値は、Azure リソースマネージャー API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
syncGroupName	path	True	string	同期グループの名前。
api-version	query	True	string	要求で使用する API のバージョン。

応答

名前	型	説明
200 OK	SyncGroup	指定した同期グループが正常に取得されました。
Other Status Codes		エラー応答: *** 400 InvalidSyncGroupCreateOrUpdateRequest - 同期グループの作成または更新要求本文が空です。 400 InvalidSyncMemberCreateOrUpdateRequest - 同期メンバーの作成または更新要求本文が空です。 400 InvalidSyncAgentCreateOrUpdateRequest - 同期エージェントの作成または更新要求本文が空です。 400 InvalidDatabaseResourceId - データベースリソース識別子が無効です。 400 MismatchingSubscriptionWithUrl - 指定されたサブスクリプションが URL 内のサブスクリプションと一致しませんでした。 400 InvalidSyncAgentResourceId - 同期エージェントのリソース識別子が無効です。 400 MismatchingResourceGroupNameWithUrl - 指定されたリソースグループ名が URL の名前と一致しませんでした。 400 MismatchingServerNameWithUrl - 指定されたサーバー名が URL の名前と一致しませんでした。 400 InvalidParameterValue - パラメーターに無効な値が指定されました。 400 MissingServerName - サーバー名がありません 400 MissingDatabaseName - データベース名がありません 400 MissingSyncGroupName - 同期グループ名がありません 400 MissingConflictResolutionPolicy - 競合解決ポリシーがありません 400 MissingSyncAgentName - 同期エージェント名がありません 400 SyncOperation_GenericFailure - データ同期操作を実行できませんでした。 400 InvalidSyncGroup - 同期グループが無効です。 400 FeatureDisabledOnSelectedEdition - ユーザーが現在のデータベースエディションで無効になっている機能を使用しようとしました。 400 CannotCreateSyncGroupDueToQuotaExceeded - クォータを超えたため、同期グループを作成できません。 400 SyncOperation_DuplicateSyncGroupDrop - 同期グループは既に削除されています。 400 SyncOperation_WrongSyncDatabase - 指定された同期データベースが既存のデータベースと一致しません。 400 SyncOperation_UpdateSyncGroupWhenDropping - 同期グループは現在削除されているため、更新できません。 400 SyncOperation_DwInSyncGroup - データ同期で datawarehouse エディションを使用できません。 400 SyncOperation_MasterDbInSyncGroup - データ同期で論理マスターを使用できません。 400 SyncOperation_InvalidCredential - データベースの資格情報が無効です。 400 InvalidSyncMetadataDatabase - 同期メタデータデータベースが無効です。 400 SyncOperation_InvalidSyncInterval - 同期間隔が無効であるため、同期グループを作成または更新できません。 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 DatabaseDoesNotExist - ユーザーがこのサーバーインスタンスに存在しないデータベース名を指定しました。 404 SyncOperation_HubServerNotFound - ハブ論理サーバーが存在しません。 404 SyncOperation_InvalidHubDatabase - ハブデータベースが無効です。 409 SyncOperation_DuplicateSyncGroupName - 同じ名前の同期グループが既に存在するため、同期グループを作成できません。

名前

型

説明

200 OK

SyncGroup

指定した同期グループが正常に取得されました。

Other Status Codes

エラー応答: ***

400 InvalidSyncGroupCreateOrUpdateRequest - 同期グループの作成または更新要求本文が空です。
400 InvalidSyncMemberCreateOrUpdateRequest - 同期メンバーの作成または更新要求本文が空です。
400 InvalidSyncAgentCreateOrUpdateRequest - 同期エージェントの作成または更新要求本文が空です。
400 InvalidDatabaseResourceId - データベースリソース識別子が無効です。
400 MismatchingSubscriptionWithUrl - 指定されたサブスクリプションが URL 内のサブスクリプションと一致しませんでした。
400 InvalidSyncAgentResourceId - 同期エージェントのリソース識別子が無効です。
400 MismatchingResourceGroupNameWithUrl - 指定されたリソースグループ名が URL の名前と一致しませんでした。
400 MismatchingServerNameWithUrl - 指定されたサーバー名が URL の名前と一致しませんでした。
400 InvalidParameterValue - パラメーターに無効な値が指定されました。
400 MissingServerName - サーバー名がありません
400 MissingDatabaseName - データベース名がありません
400 MissingSyncGroupName - 同期グループ名がありません
400 MissingConflictResolutionPolicy - 競合解決ポリシーがありません
400 MissingSyncAgentName - 同期エージェント名がありません
400 SyncOperation_GenericFailure - データ同期操作を実行できませんでした。
400 InvalidSyncGroup - 同期グループが無効です。
400 FeatureDisabledOnSelectedEdition - ユーザーが現在のデータベースエディションで無効になっている機能を使用しようとしました。
400 CannotCreateSyncGroupDueToQuotaExceeded - クォータを超えたため、同期グループを作成できません。
400 SyncOperation_DuplicateSyncGroupDrop - 同期グループは既に削除されています。
400 SyncOperation_WrongSyncDatabase - 指定された同期データベースが既存のデータベースと一致しません。
400 SyncOperation_UpdateSyncGroupWhenDropping - 同期グループは現在削除されているため、更新できません。
400 SyncOperation_DwInSyncGroup - データ同期で datawarehouse エディションを使用できません。
400 SyncOperation_MasterDbInSyncGroup - データ同期で論理マスターを使用できません。
400 SyncOperation_InvalidCredential - データベースの資格情報が無効です。
400 InvalidSyncMetadataDatabase - 同期メタデータデータベースが無効です。
400 SyncOperation_InvalidSyncInterval - 同期間隔が無効であるため、同期グループを作成または更新できません。
404 ResourceNotFound - 要求されたリソースが見つかりませんでした。
404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 DatabaseDoesNotExist - ユーザーがこのサーバーインスタンスに存在しないデータベース名を指定しました。
404 SyncOperation_HubServerNotFound - ハブ論理サーバーが存在しません。
404 SyncOperation_InvalidHubDatabase - ハブデータベースが無効です。
409 SyncOperation_DuplicateSyncGroupName - 同じ名前の同期グループが既に存在するため、同期グループを作成できません。

例

Get a sync group

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?api-version=2021-11-01


/**
 * Samples for SyncGroups Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncGroupGet.json
     */
    /**
     * Sample code: Get a sync group.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getASyncGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncGroups().getWithResponse("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", "syncgroupcrud-3187", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "properties": {
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups"
}

定義

名前	説明
Sku	ARM リソース SKU。
SyncConflictResolutionPolicy	同期グループの競合解決ポリシー。
SyncGroup	Azure SQL データベース同期グループ。
SyncGroupSchema	同期グループスキーマのプロパティ。
SyncGroupSchemaTable	同期グループスキーマ内のテーブルのプロパティ。
SyncGroupSchemaTableColumn	同期グループテーブルの列のプロパティ。
SyncGroupState	同期グループの同期状態。

Sku

ARM リソース SKU。

名前	型	説明
capacity	integer	特定の SKU の容量。
family	string	サービスのハードウェアの世代が異なる場合は、同じ SKU に対して、ここでキャプチャできます。
name	string	SKU の名前 (通常は文字 + 番号コード、例: P3)。
size	string	特定の SKU のサイズ
tier	string	特定の SKU のレベルまたはエディション (Basic、Premium など)。

SyncConflictResolutionPolicy

同期グループの競合解決ポリシー。

名前	型	説明
HubWin	string
MemberWin	string

SyncGroup

Azure SQL データベース同期グループ。

名前	型	説明
id	string	リソースの ID
name	string	リソース名。
properties.conflictLoggingRetentionInDays	integer	競合ログの保持期間。
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	同期グループの競合解決ポリシー。
properties.enableConflictLogging	boolean	競合ログが有効になっている場合。
properties.hubDatabasePassword	string	同期グループハブデータベースの資格情報のパスワード。
properties.hubDatabaseUserName	string	同期グループハブデータベース資格情報のユーザー名。
properties.interval	integer	同期グループの同期間隔。
properties.lastSyncTime	string	同期グループの最終同期時刻。
properties.privateEndpointName	string	プライベートリンク接続を使用する場合は、同期グループのプライベートエンドポイント名が有効になります。
properties.schema	SyncGroupSchema	同期グループの同期スキーマ。
properties.syncDatabaseId	string	同期グループ内の同期データベースの ARM リソース ID。
properties.syncState	SyncGroupState	同期グループの同期状態。
properties.usePrivateLinkConnection	boolean	プライベートリンク接続の使用が有効になっている場合。
sku	Sku	SKU の名前と容量。
type	string	リソースの種類。

SyncGroupSchema

同期グループスキーマのプロパティ。

名前	型	説明
masterSyncMemberName	string	スキーマの元のマスター同期メンバーの名前。
tables	SyncGroupSchemaTable[]	同期グループスキーマ内のテーブルの一覧。

SyncGroupSchemaTable

同期グループスキーマ内のテーブルのプロパティ。

名前	型	説明
columns	SyncGroupSchemaTableColumn[]	同期グループスキーマ内の列の一覧。
quotedName	string	同期グループスキーマテーブルの引用符で囲まれた名前。

SyncGroupSchemaTableColumn

同期グループテーブルの列のプロパティ。

名前	型	説明
dataSize	string	列のデータサイズ。
dataType	string	列のデータ型です。
quotedName	string	同期グループテーブル列の引用符で囲まれた名前。

SyncGroupState

同期グループの同期状態。

名前	型	説明
Error	string
Good	string
NotReady	string
Progressing	string
Warning	string

次の方法で共有

Sync Groups - Get

URI パラメーター

応答

例

Get a sync group

要求のサンプル

応答のサンプル

定義

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState

その他のリソース