Sync Agents - Generate Key

Service:

SQL Database

API Version:

2021-11-01

Génère une clé d’agent de synchronisation.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Nom du serveur sur lequel l’agent de synchronisation est hébergé.
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
syncAgentName	path	True	string	Nom de l’agent de synchronisation.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Réponses

Nom	Type	Description
200 OK	SyncAgentKeyProperties	Générer une clé d’agent de synchronisation.
Other Status Codes		Réponses d’erreur : *** 400 InvalidSyncGroupCreateOrUpdateRequest : le corps de la demande de groupe de synchronisation de création ou de mise à jour est vide. 400 InvalidSyncMemberCreateOrUpdateRequest : le corps de la demande de membre de synchronisation de création ou de mise à jour est vide. 400 InvalidSyncAgentCreateOrUpdateRequest : le corps de la demande de l’agent de synchronisation de création ou de mise à jour est vide. 400 InvalidDatabaseResourceId : identificateur de ressource de base de données non valide. 400 IncompatibilitéSubscriptionWithUrl : l’abonnement fourni ne correspond pas à l’abonnement dans l’URL. 400 InvalidSyncAgentResourceId : identificateur de ressource de l’agent de synchronisation non valide. 400 MismatchingResourceGroupNameWithUrl : le nom du groupe de ressources fourni ne correspond pas au nom de l’URL. 400 IncompatibilitéserverNameWithUrl : le nom du serveur fourni ne correspond pas au nom dans l’URL. 400 InvalidParameterValue : une valeur non valide a été donnée à un paramètre. 400 MissingServerName : le nom du serveur est manquant 400 MissingDatabaseName - Le nom de la base de données est manquant 400 MissingSyncGroupName - Le nom du groupe de synchronisation est manquant 400 MissingConflictResolutionPolicy - La stratégie de résolution des conflits est manquante 400 MissingSyncAgentName - Le nom de l’agent de synchronisation est manquant 400 SyncOperation_GenericFailure : échec de l’opération de synchronisation des données. 400 SyncOperation_WrongSyncDatabase : la base de données de synchronisation spécifiée ne correspond pas à celle existante. 400 SyncOperation_DwInSyncGroup : impossible d’utiliser l’édition datawarehouse dans la synchronisation des données. 400 SyncOperation_MasterDbInSyncGroup : impossible d’utiliser la master logique dans la synchronisation des données. 400 CannotDeleteInUseSyncAgent - Impossible de supprimer l’agent de synchronisation, car il est utilisé par le membre de synchronisation. 400 InvalidSyncAgent - L’agent de synchronisation n’est pas valide. 400 InvalidSyncMetadataDatabase : la base de données de métadonnées de synchronisation n’est pas valide. 404 ResourceNotFound : la ressource demandée est introuvable. 404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable 404 DatabaseDoesNotExist : l’utilisateur a spécifié un nom de base de données qui n’existe pas sur ce serveur instance. 409 SyncOperation_AgentAlreadyExists : l’agent de synchronisation portant le même nom existe déjà. 409 SyncOperation_AgentIdAlreadyExists : l’agent de synchronisation avec le même ID existe déjà.

Exemples

Generate a sync agent key

Sample Request

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

import com.azure.core.util.Context;

/** 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", 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

Sample Response

Status code:

200

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

Définitions

SyncAgentKeyProperties

Propriétés d’une clé d’agent de synchronisation de base de données Azure SQL.

Nom	Type	Description
syncAgentKey	string	Clé de l’agent de synchronisation.