Sync Groups - Get

Referenz

Dienst:: SQL Database

API-Version:: 2021-11-01

Ruft eine Synchronisierungsgruppe ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}?api-version=2021-11-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. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
syncGroupName	path	True	string	Der Name der Synchronisierungsgruppe.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	SyncGroup	Die angegebene Synchronisierungsgruppe wurde erfolgreich abgerufen.
Other Status Codes		Fehlerantworten: *** 400 InvalidSyncGroupCreateOrUpdateRequest: Der Text der Anforderung zur Erstellung oder Aktualisierung der Synchronisierungsgruppe ist leer. 400 InvalidSyncMemberCreateOrUpdateRequest: Der Anforderungstext zum Erstellen oder Aktualisieren von Synchronisierungsmitglied ist leer. 400 InvalidSyncAgentCreateOrUpdateRequest: Der Anforderungstext zum Erstellen oder Aktualisieren des Synchronisierungs-Agents ist leer. 400 InvalidDatabaseResourceId: Ungültiger Datenbankressourcenbezeichner. 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: Einem Parameter wurde ein ungültiger Wert 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: Die Synchronisierungsgruppe ist ungültig. 400 FeatureDisabledOnSelectedEdition: Der Benutzer hat versucht, ein Feature zu verwenden, das in der aktuellen Datenbankedition deaktiviert ist. 400 CannotCreateSyncGroupDueToQuotaExceeded: Synchronisierungsgruppe kann aufgrund des überschrittenen Kontingents nicht erstellt werden. 400 SyncOperation_DuplicateSyncGroupDrop: Die Synchronisierungsgruppe wird bereits gelöscht. 400 SyncOperation_WrongSyncDatabase: Die angegebene Synchronisierungsdatenbank entspricht nicht der vorhandenen Datenbank. 400 SyncOperation_UpdateSyncGroupWhenDropping: Die Synchronisierungsgruppe kann nicht aktualisiert werden, da sie derzeit gelöscht wird. 400 SyncOperation_DwInSyncGroup: Datawarehouse Edition kann nicht in der Datensynchronisierung verwendet werden. 400 SyncOperation_MasterDbInSyncGroup: Bei der Datensynchronisierung kann keine logische master verwendet werden. 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 auf diesem Server instance nicht vorhanden ist. 404 SyncOperation_HubServerNotFound : Der logische Hubserver ist nicht vorhanden. 404 SyncOperation_InvalidHubDatabase: Die Hubdatenbank ist ungültig. 409 SyncOperation_DuplicateSyncGroupName: Synchronisierungsgruppe kann nicht erstellt werden, da die Synchronisierungsgruppe mit demselben Namen bereits vorhanden ist.

Name

Typ

Beschreibung

200 OK

SyncGroup

Die angegebene Synchronisierungsgruppe wurde erfolgreich abgerufen.

Other Status Codes

Fehlerantworten: ***

400 InvalidSyncGroupCreateOrUpdateRequest: Der Text der Anforderung zur Erstellung oder Aktualisierung der Synchronisierungsgruppe ist leer.
400 InvalidSyncMemberCreateOrUpdateRequest: Der Anforderungstext zum Erstellen oder Aktualisieren von Synchronisierungsmitglied ist leer.
400 InvalidSyncAgentCreateOrUpdateRequest: Der Anforderungstext zum Erstellen oder Aktualisieren des Synchronisierungs-Agents ist leer.
400 InvalidDatabaseResourceId: Ungültiger Datenbankressourcenbezeichner.
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: Einem Parameter wurde ein ungültiger Wert 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: Die Synchronisierungsgruppe ist ungültig.
400 FeatureDisabledOnSelectedEdition: Der Benutzer hat versucht, ein Feature zu verwenden, das in der aktuellen Datenbankedition deaktiviert ist.
400 CannotCreateSyncGroupDueToQuotaExceeded: Synchronisierungsgruppe kann aufgrund des überschrittenen Kontingents nicht erstellt werden.
400 SyncOperation_DuplicateSyncGroupDrop: Die Synchronisierungsgruppe wird bereits gelöscht.
400 SyncOperation_WrongSyncDatabase: Die angegebene Synchronisierungsdatenbank entspricht nicht der vorhandenen Datenbank.
400 SyncOperation_UpdateSyncGroupWhenDropping: Die Synchronisierungsgruppe kann nicht aktualisiert werden, da sie derzeit gelöscht wird.
400 SyncOperation_DwInSyncGroup: Datawarehouse Edition kann nicht in der Datensynchronisierung verwendet werden.
400 SyncOperation_MasterDbInSyncGroup: Bei der Datensynchronisierung kann keine logische master verwendet werden.
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 auf diesem Server instance nicht vorhanden ist.
404 SyncOperation_HubServerNotFound : Der logische Hubserver ist nicht vorhanden.
404 SyncOperation_InvalidHubDatabase: Die Hubdatenbank ist ungültig.
409 SyncOperation_DuplicateSyncGroupName: Synchronisierungsgruppe kann nicht erstellt werden, da die Synchronisierungsgruppe mit demselben Namen bereits vorhanden ist.

Beispiele

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=2021-11-01


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

Beispiel für eine Antwort

Statuscode:: 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"
}

Definitionen

Name	Beschreibung
Sku	Eine ARM-Ressourcen-SKU.
SyncConflictResolutionPolicy	Konfliktlösungsrichtlinie der Synchronisierungsgruppe.
SyncGroup	Eine Azure SQL Datenbanksynchronisierungsgruppe.
SyncGroupSchema	Eigenschaften des Synchronisierungsgruppenschemas.
SyncGroupSchemaTable	Eigenschaften der Tabelle im Synchronisierungsgruppenschema.
SyncGroupSchemaTableColumn	Eigenschaften der Spalte in der Synchronisierungsgruppentabelle.
SyncGroupState	Synchronisierungsstatus der Synchronisierungsgruppe.

Sku

Eine ARM-Ressourcen-SKU.

Name	Typ	Beschreibung
capacity	integer	Kapazität der jeweiligen SKU.
family	string	Wenn der Dienst über unterschiedliche Hardwaregenerationen für dieselbe SKU verfügt, kann dies hier erfasst werden.
name	string	Der Name der SKU, in der Regel ein Buchstabe + Zahlencode, z. B. P3.
size	string	Größe der jeweiligen SKU
tier	string	Der Tarif oder die Edition der jeweiligen SKU, z. B. Basic, Premium.

SyncConflictResolutionPolicy

Konfliktlösungsrichtlinie der Synchronisierungsgruppe.

Name	Typ	Beschreibung
HubWin	string
MemberWin	string

SyncGroup

Eine Azure SQL Datenbanksynchronisierungsgruppe.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Name der Ressource.
properties.conflictLoggingRetentionInDays	integer	Aufbewahrungszeitraum für die Konfliktprotokollierung.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Konfliktlösungsrichtlinie der Synchronisierungsgruppe.
properties.enableConflictLogging	boolean	Wenn die Konfliktprotokollierung aktiviert ist.
properties.hubDatabasePassword	string	Kennwort für die Anmeldeinformationen der Synchronisierungsgruppe hub-Datenbank.
properties.hubDatabaseUserName	string	Benutzername für die Datenbankanmeldeinformationen des Synchronisierungsgruppenhubs.
properties.interval	integer	Synchronisierungsintervall der Synchronisierungsgruppe.
properties.lastSyncTime	string	Letzte Synchronisierungszeit der Synchronisierungsgruppe.
properties.privateEndpointName	string	Name des privaten Endpunkts der Synchronisierungsgruppe, wenn die Verwendung der Verbindung mit privatem Link aktiviert ist.
properties.schema	SyncGroupSchema	Synchronisierungsschema der Synchronisierungsgruppe.
properties.syncDatabaseId	string	ARM-Ressourcen-ID der Synchronisierungsdatenbank in der Synchronisierungsgruppe.
properties.syncState	SyncGroupState	Synchronisierungsstatus der Synchronisierungsgruppe.
properties.usePrivateLinkConnection	boolean	Wenn die Private Link-Verbindung verwenden aktiviert ist.
sku	Sku	Der Name und die Kapazität der SKU.
type	string	Der Ressourcentyp.

SyncGroupSchema

Eigenschaften des Synchronisierungsgruppenschemas.

Name	Typ	Beschreibung
masterSyncMemberName	string	Name master Synchronisierungselements, aus dem das Schema stammt.
tables	SyncGroupSchemaTable[]	Liste der Tabellen im Synchronisierungsgruppenschema.

SyncGroupSchemaTable

Eigenschaften der Tabelle im Synchronisierungsgruppenschema.

Name	Typ	Beschreibung
columns	SyncGroupSchemaTableColumn[]	Liste der Spalten im Synchronisierungsgruppenschema.
quotedName	string	Anführungszeichenname der Schematabelle der Synchronisierungsgruppe.

SyncGroupSchemaTableColumn

Eigenschaften der Spalte in der Synchronisierungsgruppentabelle.

Name	Typ	Beschreibung
dataSize	string	Die Datengröße der Spalte.
dataType	string	Datentyp der Spalte.
quotedName	string	Anführungszeichenname der Tabellenspalte der Synchronisierungsgruppe.

SyncGroupState

Synchronisierungsstatus der Synchronisierungsgruppe.

Name	Typ	Beschreibung
Error	string
Good	string
NotReady	string
Progressing	string
Warning	string

Freigeben über

Sync Groups - Get

URI-Parameter

Antworten

Beispiele

Get a sync group

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState

Zusätzliche Ressourcen