Sync Groups - List Hub Schemas

サービス:: SQL Database

API バージョン:: 2023-08-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/hubSchemas?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	SyncFullSchemaPropertiesListResult	同期グループハブデータベーススキーマを正常に取得しました。
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 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 DatabaseDoesNotExist - ユーザーがこのサーバーインスタンスに存在しないデータベース名を指定しました。 404 SyncOperation_HubServerNotFound - ハブ論理サーバーが存在しません。 404 SyncOperation_InvalidHubDatabase - ハブデータベースが無効です。 409 SyncOperation_DuplicateSyncGroupName - 同じ名前の同期グループが既に存在するため、同期グループを作成できません。

名前

型

説明

200 OK

SyncFullSchemaPropertiesListResult

同期グループハブデータベーススキーマを正常に取得しました。

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 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 DatabaseDoesNotExist - ユーザーがこのサーバーインスタンスに存在しないデータベース名を指定しました。
404 SyncOperation_HubServerNotFound - ハブ論理サーバーが存在しません。
404 SyncOperation_InvalidHubDatabase - ハブデータベースが無効です。
409 SyncOperation_DuplicateSyncGroupName - 同じ名前の同期グループが既に存在するため、同期グループを作成できません。

例

Get a hub database schema.

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/SyncGroupGetHubSchema.json
// this example is just showing the usage of "SyncGroups_ListHubSchemas" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SyncGroupResource created on azure
// for more information of creating SyncGroupResource, please refer to the document of SyncGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
string syncGroupName = "syncgroupcrud-3187";
ResourceIdentifier syncGroupResourceId = SyncGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, syncGroupName);
SyncGroupResource syncGroup = client.GetSyncGroupResource(syncGroupResourceId);

// invoke the operation and iterate over the result
await foreach (SyncFullSchemaProperties item in syncGroup.GetHubSchemasAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
SyncFullSchemaProperties	データベースの完全なスキーマのプロパティ。
SyncFullSchemaPropertiesListResult	同期スキーマのプロパティの一覧。
SyncFullSchemaTable	データベースの完全なスキーマ内のテーブルのプロパティ。
SyncFullSchemaTableColumn	データベースの完全なスキーマのテーブル内の列のプロパティ。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

SyncFullSchemaProperties

Object

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

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

SyncFullSchemaPropertiesListResult

Object

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

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

SyncFullSchemaTable

Object

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

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

SyncFullSchemaTableColumn

Object

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

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

次の方法で共有

Sync Groups - List Hub Schemas

URI パラメーター

応答

例

Get a hub database schema.

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SyncFullSchemaProperties

SyncFullSchemaPropertiesListResult

SyncFullSchemaTable

SyncFullSchemaTableColumn