Sync Groups - List Hub Schemas

サービス:

SQL Database

API バージョン:

2021-11-01

ハブ データベース スキーマのコレクションを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/hubSchemas?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	SyncFullSchemaPropertiesListResult	同期グループ ハブ データベース スキーマが正常に取得されました。
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 hub database schema.

要求のサンプル

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

Java

/**
 * Samples for SyncGroups ListHubSchemas.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncGroupGetHubSchema.json
     */
    /**
     * Sample code: Get a hub database schema.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAHubDatabaseSchema(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncGroups().listHubSchemas("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

{
  "value": [
    {
      "tables": [
        {
          "columns": [
            {
              "dataSize": "4",
              "dataType": "int",
              "hasError": false,
              "isPrimaryKey": false,
              "name": "intField",
              "quotedName": "[intField]"
            },
            {
              "dataSize": "100",
              "dataType": "nvarchar",
              "hasError": false,
              "isPrimaryKey": false,
              "name": "charField",
              "quotedName": "[charField]"
            }
          ],
          "errorId": "Schema_TableHasNoPrimaryKey",
          "hasError": true,
          "name": "dbo.myTable",
          "quotedName": "[dbo].[myTable]"
        }
      ],
      "lastUpdateTime": "2017-05-30T07:16:08.21Z"
    }
  ]
}

定義

名前	説明
SyncFullSchemaProperties	データベースの完全なスキーマのプロパティ。
SyncFullSchemaPropertiesListResult	同期スキーマのプロパティの一覧。
SyncFullSchemaTable	データベースの完全なスキーマ内のテーブルのプロパティ。
SyncFullSchemaTableColumn	データベースの完全なスキーマのテーブル内の列のプロパティ。

SyncFullSchemaProperties

データベースの完全なスキーマのプロパティ。

名前	型	説明
lastUpdateTime	string	データベース スキーマの最終更新時刻。
tables	SyncFullSchemaTable[]	データベースの完全なスキーマ内のテーブルの一覧。

SyncFullSchemaPropertiesListResult

同期スキーマのプロパティの一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	SyncFullSchemaProperties[]	結果の配列。

SyncFullSchemaTable

データベースの完全なスキーマ内のテーブルのプロパティ。

名前	型	説明
columns	SyncFullSchemaTableColumn[]	データベースの完全なスキーマのテーブル内の列の一覧。
errorId	string	テーブルのエラー ID。
hasError	boolean	テーブルにエラーがある場合。
name	string	テーブルの名前。
quotedName	string	テーブルの引用符で囲まれた名前。

SyncFullSchemaTableColumn

データベースの完全なスキーマのテーブル内の列のプロパティ。

名前	型	説明
dataSize	string	列のデータ サイズ。
dataType	string	列のデータ型です。
errorId	string	列のエラー ID。
hasError	boolean	テーブルにエラーがある場合。
isPrimaryKey	boolean	テーブルの主キーである場合。
name	string	列の名前です。
quotedName	string	列の引用符で囲まれた名前。