Sync Agents - Generate Key

Dienst:

SQL Database

API-Version:

2021-11-01

Generiert einen Synchronisierungs-Agent-Schlüssel.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}/generateKey?api-version=2021-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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	Der Name des Servers, auf dem der Synchronisierungs-Agent gehostet wird.
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
syncAgentName	path	True	string	Der Name des Synchronisierungs-Agents.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	SyncAgentKeyProperties	Generieren Sie erfolgreich einen Synchronisierungs-Agent-Schlüssel.
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 SyncOperation_WrongSyncDatabase: Die angegebene Synchronisierungsdatenbank entspricht nicht der vorhandenen Datenbank. 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 CannotDeleteInUseSyncAgent: Synchronisierungs-Agent kann nicht gelöscht werden, da er vom Synchronisierungsmitglied verwendet wird. 400 InvalidSyncAgent: Der Synchronisierungs-Agent ist ungültig. 400 InvalidSyncMetadataDatabase: Die Synchronisierungsmetadatendatenbank ist ungültig. 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. 409 SyncOperation_AgentAlreadyExists: Der Synchronisierungs-Agent mit demselben Namen ist bereits vorhanden. 409 SyncOperation_AgentIdAlreadyExists: Der Synchronisierungs-Agent mit derselben ID ist bereits vorhanden.

Beispiele

Generate a sync agent key

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncagentcrud-65440/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187/generateKey?api-version=2021-11-01

Java

/**
 * Samples for SyncAgents GenerateKey.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncAgentGenerateKey.json
     */
    /**
     * Sample code: Generate a sync agent key.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void generateASyncAgentKey(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncAgents().generateKeyWithResponse("syncagentcrud-65440",
            "syncagentcrud-8475", "syncagentcrud-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

{
  "syncAgentKey": "865f9998-6dae-4214-bbb1-4796b7c76ca0:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX=:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX="
}

Definitionen

SyncAgentKeyProperties

Eigenschaften eines Azure SQL-Datenbanksynchronisierungs-Agent-Schlüssels.

Name	Typ	Beschreibung
syncAgentKey	string	Schlüssel des Synchronisierungs-Agents.