Sync Agents - Create Or Update

Crée ou met à jour un agent de synchronisation.

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

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serverName
path True

string

Le nom du serveur

subscriptionId
path True

string (uuid)

ID de l’abonnement cible. La valeur doit être un UUID.

syncAgentName
path True

string

Nom de l’agent de synchronisation.

api-version
query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom Type Description
properties.syncDatabaseId

string

ID de ressource ARM de la base de données de synchronisation dans l’agent de synchronisation.

Réponses

Nom Type Description
200 OK

SyncAgent

Opération de mise à jour de la ressource 'SyncAgent' réussie

201 Created

SyncAgent

Ressource 'SyncAgent' création d’opération réussie

En-têtes

  • Location: string
  • Retry-After: integer
202 Accepted

Exploitation des ressources acceptée.

En-têtes

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

Create a new sync agent
Update a sync agent

Create a new sync agent

Exemple de requête

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

{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync"
  }
}

Exemple de réponse

{
  "name": "syncagent",
  "type": "Microsoft.Sql/servers/syncAgents",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187",
  "properties": {
    "expiryTime": "9999-12-31T23:59:59.9999999Z",
    "isUpToDate": true,
    "state": "NeverConnected",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync",
    "version": "4.2.0.0"
  }
}
{
  "name": "syncagent",
  "type": "Microsoft.Sql/servers/syncAgents",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187",
  "properties": {
    "expiryTime": "9999-12-31T23:59:59.9999999Z",
    "isUpToDate": true,
    "state": "NeverConnected",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync",
    "version": "4.2.0.0"
  }
}

Update a sync agent

Exemple de requête

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

{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync"
  }
}

Exemple de réponse

{
  "name": "syncagent",
  "type": "Microsoft.Sql/servers/syncAgents",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187",
  "properties": {
    "expiryTime": "9999-12-31T23:59:59.9999999Z",
    "isUpToDate": true,
    "state": "NeverConnected",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync",
    "version": "4.2.0.0"
  }
}
{
  "name": "syncagent",
  "type": "Microsoft.Sql/servers/syncAgents",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187",
  "properties": {
    "expiryTime": "9999-12-31T23:59:59.9999999Z",
    "isUpToDate": true,
    "state": "NeverConnected",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync",
    "version": "4.2.0.0"
  }
}
Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/westus/operation/00000000-1111-2222-3333-444444444444?api-version=2022-11-01-preview

Définitions

Nom Description
createdByType

Type d’identité qui a créé la ressource.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

SyncAgent

Un agent de synchronisation Azure SQL Database.

SyncAgentState

État de l’agent de synchronisation.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Type d’identité qui a créé la ressource.

Valeur Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.

type

string

Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d’erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

SyncAgent

Un agent de synchronisation Azure SQL Database.

Nom Type Description
id

string (arm-id)

ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »

name

string

Nom de la ressource

properties.expiryTime

string (date-time)

Heure d’expiration de la version de l’agent de synchronisation.

properties.isUpToDate

boolean

Si la version de l’agent de synchronisation est à jour.

properties.lastAliveTime

string (date-time)

Heure de la dernière vie de l’agent de synchronisation.

properties.name

string

Nom de l’agent de synchronisation.

properties.state

SyncAgentState

État de l’agent de synchronisation.

properties.syncDatabaseId

string

ID de ressource ARM de la base de données de synchronisation dans l’agent de synchronisation.

properties.version

string

Version de l’agent de synchronisation.

systemData

systemData

Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.

type

string

Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

SyncAgentState

État de l’agent de synchronisation.

Valeur Description
Online

En ligne

Offline

Hors ligne

NeverConnected

NeverConnected

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string (date-time)

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string (date-time)

Horodatage de la dernière modification de ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.