Sync Groups - List Hub Schemas

Service:

SQL Database

API バージョン:

2025-01-01

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

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

URI パラメーター

Name	/	必須	型	説明
databaseName	path	True	string	データベースの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前の大文字と小文字は区別されません。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
syncGroupName	path	True	string	同期グループの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

Name	型	説明
200 OK	SyncFullSchemaPropertiesListResult	Azureの運用は無事に完了しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

Name	説明
user_impersonation	ユーザー アカウントを偽装する

例

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=2025-01-01

Java

/**
 * Samples for SyncGroups ListHubSchemas.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/SyncGroupGetHubSchema.json
     */
    /**
     * Sample code: Get a hub database schema.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void getAHubDatabaseSchema(com.azure.resourcemanager.sql.SqlServerManager manager) {
        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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python sync_group_get_hub_schema.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.sync_groups.list_hub_schemas(
        resource_group_name="syncgroupcrud-65440",
        server_name="syncgroupcrud-8475",
        database_name="syncgroupcrud-4328",
        sync_group_name="syncgroupcrud-3187",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-01/SyncGroupGetHubSchema.json
if __name__ == "__main__":
    main()

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

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets a collection of hub database schemas.
 *
 * @summary gets a collection of hub database schemas.
 * x-ms-original-file: 2025-01-01/SyncGroupGetHubSchema.json
 */
async function getAHubDatabaseSchema() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.syncGroups.listHubSchemas(
    "syncgroupcrud-65440",
    "syncgroupcrud-8475",
    "syncgroupcrud-4328",
    "syncgroupcrud-3187",
  )) {
    resArray.push(item);
  }

  console.log(resArray);
}

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

dotnet

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/SQL/stable/2025-01-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": [
    {
      "lastUpdateTime": "2017-05-30T07:16:08.21Z",
      "tables": [
        {
          "name": "dbo.myTable",
          "columns": [
            {
              "name": "intField",
              "dataSize": "4",
              "dataType": "int",
              "hasError": false,
              "isPrimaryKey": false,
              "quotedName": "[intField]"
            },
            {
              "name": "charField",
              "dataSize": "100",
              "dataType": "nvarchar",
              "hasError": false,
              "isPrimaryKey": false,
              "quotedName": "[charField]"
            }
          ],
          "errorId": "Schema_TableHasNoPrimaryKey",
          "hasError": true,
          "quotedName": "[dbo].[myTable]"
        }
      ]
    }
  ]
}

定義

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

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

SyncFullSchemaProperties

Object

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

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

SyncFullSchemaPropertiesListResult

Object

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

Name	型	説明
nextLink	string (uri)	項目の次のページへのリンク
value	SyncFullSchemaProperties[]	このページのSyncFullSchemaProperties項目

SyncFullSchemaTable

Object

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

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

SyncFullSchemaTableColumn

Object

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

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