Sync Agents - Generate Key

Service:

SQL Database

API Version:

2021-11-01

Genera una clave de agente de sincronización.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
serverName	path	True	string	Nombre del servidor en el que se hospeda el agente de sincronización.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
syncAgentName	path	True	string	Nombre del agente de sincronización.
api-version	query	True	string	La versión de API que se usará para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	SyncAgentKeyProperties	Genere correctamente una clave del agente de sincronización.
Other Status Codes		Respuestas de error: *** 400 InvalidSyncGroupCreateOrUpdateRequest: el cuerpo de la solicitud del grupo de sincronización de creación o actualización está vacío. 400 InvalidSyncMemberCreateOrUpdateRequest: el cuerpo de la solicitud de miembro de sincronización de creación o actualización está vacío. 400 InvalidSyncAgentCreateOrUpdateRequest: el cuerpo de la solicitud del agente de sincronización de creación o actualización está vacío. 400 InvalidDatabaseResourceId: identificador de recurso de base de datos no válido. 400 No coincidentesSubscriptionWithUrl: la suscripción proporcionada no coincide con la suscripción en la dirección URL. 400 InvalidSyncAgentResourceId: identificador de recursos del agente de sincronización no válido. 400 No coincidentesResourceGroupNameWithUrl: el nombre del grupo de recursos proporcionado no coincide con el nombre de la dirección URL. 400 No coincidentesServerNameWithUrl: el nombre del servidor proporcionado no coincide con el nombre de la dirección URL. 400 InvalidParameterValue: se ha dado un valor no válido a un parámetro. 400 MissingServerName: falta el nombre del servidor 400 MissingDatabaseName: falta el nombre de la base de datos. 400 MissingSyncGroupName: falta el nombre del grupo de sincronización. 400 MissingConflictResolutionPolicy: falta la directiva de resolución de conflictos 400 MissingSyncAgentName: falta el nombre del agente de sincronización. 400 SyncOperation_GenericFailure: no se pudo realizar la operación de sincronización de datos. 400 SyncOperation_WrongSyncDatabase: la base de datos de sincronización especificada no coincide con la existente. 400 SyncOperation_DwInSyncGroup: no se puede usar la edición datawarehouse en la sincronización de datos. 400 SyncOperation_MasterDbInSyncGroup: no se puede usar el patrón lógico en la sincronización de datos. 400 CannotDeleteInUseSyncAgent: no se puede eliminar el agente de sincronización porque lo usa el miembro de sincronización. 400 InvalidSyncAgent: el agente de sincronización no es válido. 400 InvalidSyncMetadataDatabase: la base de datos de metadatos de sincronización no es válida. 404 ResourceNotFound: no se encontró el recurso solicitado. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado. 404 DatabaseDoesNotExist: el usuario ha especificado un nombre de base de datos que no existe en esta instancia del servidor. 409 SyncOperation_AgentAlreadyExists: el agente de sincronización con el mismo nombre ya existe. 409 SyncOperation_AgentIdAlreadyExists: el agente de sincronización con el mismo identificador ya existe.

Ejemplos

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

Definiciones

SyncAgentKeyProperties

Propiedades de una clave del agente de sincronización de base de datos de Azure SQL.

Nombre	Tipo	Description
syncAgentKey	string	Clave del agente de sincronización.