Sync Groups - List Hub Schemas

Dienst:

SQL Database

API-Version:

2023-08-01

Ruft eine Auflistung von Hubdatenbankschemas ab.

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
databaseName	path	True	string	Der Name der Datenbank, in der die Synchronisierungsgruppe gehostet wird.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
serverName	path	True	string	Der Name des Servers.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
syncGroupName	path	True	string	Der Name der Synchronisierungsgruppe.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	SyncFullSchemaPropertiesListResult	Erfolgreiches Abrufen eines Synchronisierungsgruppenhubdatenbankschemas.
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 InvalidSyncGroupCreateOrUpdateRequest – Der Anforderungstext der Synchronisierungsgruppe erstellen oder aktualisieren ist leer. 400 InvalidSyncMemberCreateOrUpdateRequest – Der Anforderungstext für das Erstellen oder Aktualisieren des Synchronisierungsmitglieds ist leer. 400 InvalidSyncAgentCreateOrUpdateRequest – Der Anforderungstext des Create- oder Update-Synchronisierungs-Agent ist leer. 400 InvalidDatabaseResourceId – Ungültiger Datenbankressourcenbezeichner. 400 InvalidSyncGroupName – Der Name der Synchronisierungsgruppe ist ungültig. Dieses Feld kann Buchstaben, Zahlen, Striche und Unterstriche enthalten. 400 InvalidSyncMemberName – Der Name des Synchronisierungsmitglieds ist ungültig. Dieses Feld kann Buchstaben, Zahlen, Striche und Unterstriche enthalten. 400 MissingSyncMemberName – Der Name des Synchronisierungsmitglieds fehlt. 400 InvalidSyncGroupInterval – Synchronisierungsintervall sollte größer oder gleich 5 Sekunden sein. 400 MismatchingSubscriptionWithUrl – Das bereitgestellte Abonnement stimmte nicht mit dem Abonnement in der URL überein. 400 InvalidSyncAgentResourceId – Ungültiger Synchronisierungs-Agent-Ressourcenbezeichner. 400 MismatchingResourceGroupNameWithUrl – Der angegebene Ressourcengruppenname stimmte nicht mit dem Namen in der URL überein. 400 MismatchingServerNameWithUrl – Der angegebene Servername stimmte nicht mit dem Namen in der URL überein. 400 InvalidParameterValue – Ein ungültiger Wert wurde einem Parameter zugewiesen. 400 MissingServerName – Der Servername fehlt. 400 MissingDatabaseName – Der Datenbankname fehlt. 400 MissingSyncGroupName – Der Name der Synchronisierungsgruppe fehlt. 400 MissingConflictResolutionPolicy – Die Konfliktlösungsrichtlinie fehlt. 400 MissingSyncAgentName – Der Name des Synchronisierungs-Agents fehlt. 400 SyncOperation_GenericFailure – Fehler beim Ausführen des Datensynchronisierungsvorgangs. 400 InvalidSyncGroup – Synchronisierungsgruppe ist ungültig. 400 FeatureDisabledOnSelectedEdition – Der Benutzer hat versucht, ein Feature zu verwenden, das in der aktuellen Datenbankedition deaktiviert ist. 400 CannotCreateSyncGroupDueToQuotaExceededed – Synchronisierungsgruppe kann aufgrund des überschrittenen Kontingents nicht erstellt werden. 400 SyncOperation_DuplicateSyncGroupDrop – Die Synchronisierungsgruppe wird bereits gelöscht. 400 SyncOperation_WrongSyncDatabase – Die angegebene Synchronisierungsdatenbank stimmt nicht mit dem vorhandenen überein. 400 SyncOperation_UpdateSyncGroupWhenDropping – Die Synchronisierungsgruppe kann nicht aktualisiert werden, da sie zurzeit gelöscht wird. 400 SyncOperation_DwInSyncGroup – Datawarehouse Edition kann nicht in der Datensynchronisierung verwendet werden. 400 SyncOperation_MasterDbInSyncGroup – Logisches Master-Shape kann nicht in der Datensynchronisierung verwendet werden. 400 SyncOperation_UnsupportedDataTypeColumnInSchema – Spalte kann nicht zum Schema hinzugefügt werden, da der Datentyp der Spalte nicht unterstützt wird. 400 SyncOperation_InvalidCredential – Die Anmeldeinformationen der Datenbank sind ungültig. 400 InvalidSyncMetadataDatabase – Die Synchronisierungsmetadatendatenbank ist ungültig. 400 SyncOperation_InvalidSyncInterval – Synchronisierungsgruppe kann nicht erstellt oder aktualisiert werden, da das Synchronisierungsintervall ungültig ist. 404 ResourceNotFound – Die angeforderte Ressource wurde nicht gefunden. 404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden. 404 DatabaseDoesNotExist – Der Benutzer hat einen Datenbanknamen angegeben, der in dieser Serverinstanz nicht vorhanden ist. 404 SyncOperation_HubServerNotFound – Logischer Hubserver ist nicht vorhanden. 404 SyncOperation_InvalidHubDatabase – Hubdatenbank ist ungültig. 409 SyncOperation_DuplicateSyncGroupName – Synchronisierungsgruppe kann nicht erstellt werden, da die Synchronisierungsgruppe mit demselben Namen bereits vorhanden ist.

Beispiele

Get a hub database schema.

Beispielanforderung

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

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/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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
SyncFullSchemaProperties	Eigenschaften des vollständigen Datenbankschemas.
SyncFullSchemaPropertiesListResult	Eine Liste der Synchronisierungsschemaeigenschaften.
SyncFullSchemaTable	Eigenschaften der Tabelle im vollständigen Schema der Datenbank.
SyncFullSchemaTableColumn	Eigenschaften der Spalte in der Tabelle des vollständigen Datenbankschemas.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

SyncFullSchemaProperties

Objekt

Eigenschaften des vollständigen Datenbankschemas.

Name	Typ	Beschreibung
lastUpdateTime	string (date-time)	Zeitpunkt der letzten Aktualisierung des Datenbankschemas.
tables	SyncFullSchemaTable[]	Liste der Tabellen im vollständigen Schema der Datenbank.

SyncFullSchemaPropertiesListResult

Objekt

Eine Liste der Synchronisierungsschemaeigenschaften.

Name	Typ	Beschreibung
nextLink	string	Link zum Abrufen der nächsten Seite mit Ergebnissen.
value	SyncFullSchemaProperties[]	Array von Ergebnissen.

SyncFullSchemaTable

Objekt

Eigenschaften der Tabelle im vollständigen Schema der Datenbank.

Name	Typ	Beschreibung
columns	SyncFullSchemaTableColumn[]	Liste der Spalten in der Tabelle des vollständigen Datenbankschemas.
errorId	string	Fehler-ID der Tabelle.
hasError	boolean	Wenn in der Tabelle ein Fehler auftritt.
name	string	Name der Tabelle.
quotedName	string	Zitierter Name der Tabelle.

SyncFullSchemaTableColumn

Objekt

Eigenschaften der Spalte in der Tabelle des vollständigen Datenbankschemas.

Name	Typ	Beschreibung
dataSize	string	Datengröße der Spalte.
dataType	string	Datentyp der Spalte.
errorId	string	Fehler-ID der Spalte.
hasError	boolean	Wenn in der Tabelle ein Fehler auftritt.
isPrimaryKey	boolean	Wenn es sich um den Primärschlüssel der Tabelle handelt.
name	string	Name der Spalte.
quotedName	string	Zitierter Name der Spalte.