次の方法で共有

Sync Groups - Get

  • リファレンス
サービス:
SQL Database
API バージョン:
2023-08-01

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

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

URI パラメーター

名前 / 必須 型 説明
databaseName
 path True

string

同期グループがホストされているデータベースの名前。
resourceGroupName
 path True

string

リソースを含むリソース グループの名前。 この値は、Azure Resource Manager 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

ErrorResponse

エラー応答: ***

  • 400 InvalidSyncGroupCreateOrUpdateRequest - 同期グループの作成または更新要求本文が空です。

  • 400 InvalidSyncMemberCreateOrUpdateRequest - 同期メンバーの作成または更新要求本文が空です。

  • 400 InvalidSyncAgentCreateOrUpdateRequest - 同期エージェントの作成または更新要求本文が空です。

  • 400 InvalidDatabaseResourceId - データベース リソース識別子が無効です。

  • 400 InvalidSyncGroupName - 同期グループ名が無効です。 このフィールドには、文字、数字、ダッシュ、アンダースコアを含めることができます。

  • 400 InvalidSyncMemberName - 同期メンバー名が無効です。 このフィールドには、文字、数字、ダッシュ、アンダースコアを含めることができます。

  • 400 MissingSyncMemberName - 同期メンバー名がありません

  • 400 InvalidSyncGroupInterval - 同期間隔は 5 秒以上にする必要があります。

  • 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_UnsupportedDataTypeColumnInSchema - 列のデータ型がサポートされていないため、スキーマに列を追加できません。

  • 400 SyncOperation_InvalidCredential - データベースの資格情報が無効です。

  • 400 InvalidSyncMetadataDatabase - 同期メタデータ データベースが無効です。

  • 400 SyncOperation_InvalidSyncInterval - 同期間隔が無効であるため、同期グループを作成または更新できません。

  • 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

  • 404 SubscriptionNotFound - 要求されたサブスクリプションが見つかりませんでした。

  • 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした

  • 404 DatabaseDoesNotExist - ユーザーがこのサーバー インスタンスに存在しないデータベース名を指定しました。

  • 404 SyncOperation_HubServerNotFound - ハブ論理サーバーが存在しません。

  • 404 SyncOperation_InvalidHubDatabase - ハブ データベースが無効です。

  • 409 SyncOperation_DuplicateSyncGroupName - 同じ名前の同期グループが既に存在するため、同期グループを作成できません。

  • 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

  • 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

例

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=2023-08-01

応答のサンプル

状態コード:
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"
}

定義

名前 説明
ErrorAdditionalInfo

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

エラーの詳細。
ErrorResponse

エラー応答
Sku

ARM リソース SKU。
SyncConflictResolutionPolicy

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

Azure SQL Database 同期グループ。
SyncGroupSchema

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

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

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

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

ErrorAdditionalInfo

Object

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

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

Sku

Object

ARM リソース SKU。

名前 型 説明
capacity

integer (int32)

特定の SKU の容量。
family

string

同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。
name

string

SKU の名前 。通常は、文字 + 番号コード (P3 など)。
size

string

特定の SKU のサイズ
tier

string

特定の SKU のレベルまたはエディション (Basic、Premium など)。

SyncConflictResolutionPolicy

列挙

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

値 説明
HubWin
MemberWin

SyncGroup

Object

Azure SQL Database 同期グループ。

名前 型 説明
id

string

リソース ID。
name

string

リソース名。
properties.conflictLoggingRetentionInDays

integer (int32)

競合ログの保持期間。
properties.conflictResolutionPolicy

SyncConflictResolutionPolicy

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

boolean

競合ログが有効になっている場合。
properties.hubDatabasePassword

string

同期グループ ハブ データベース資格情報のパスワード。
properties.hubDatabaseUserName

string

同期グループ ハブ データベース資格情報のユーザー名。
properties.interval

integer (int32)

同期グループの同期間隔。
properties.lastSyncTime

string (date-time)

同期グループの最終同期時刻。
properties.privateEndpointName

string

プライベート リンク接続の使用が有効になっている場合の同期グループのプライベート エンドポイント名。
properties.schema

SyncGroupSchema

同期グループの同期スキーマ。
properties.syncDatabaseId

string

同期グループ内の同期データベースの ARM リソース ID。
properties.syncState

SyncGroupState

同期グループの同期状態。
properties.usePrivateLinkConnection

boolean

プライベート リンク接続の使用が有効になっている場合。
sku

Sku

SKU の名前と容量。
type

string

リソースの種類。

SyncGroupSchema

Object

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

名前 型 説明
masterSyncMemberName

string

スキーマの由来となるマスター同期メンバーの名前。
tables

SyncGroupSchemaTable[]

同期グループ スキーマ内のテーブルの一覧。

SyncGroupSchemaTable

Object

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

名前 型 説明
columns

SyncGroupSchemaTableColumn[]

同期グループ スキーマ内の列の一覧。
quotedName

string

同期グループ スキーマ テーブルの引用符で囲まれた名前。

SyncGroupSchemaTableColumn

Object

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

名前 型 説明
dataSize

string

列のデータ サイズ。
dataType

string

列のデータ型。
quotedName

string

同期グループ テーブル列の引用符で囲まれた名前。

SyncGroupState

列挙

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

値 説明
Error
Good
NotReady
Progressing
Warning