Sync Members - Create Or Update

Servicio:: SQL Database

Versión de la API:: 2025-01-01

Crea o actualiza un miembro de sincronización.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}?api-version=2025-01-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
databaseName	path	True	string	El nombre de la base de datos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
syncGroupName	path	True	string	Nombre del grupo de sincronización.
syncMemberName	path	True	string	Nombre del miembro de sincronización.
api-version	query	True	string minLength: 1	Versión de API que se usará para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.databaseName	string	Nombre de base de datos de la base de datos miembro en el miembro de sincronización.
properties.databaseType	SyncMemberDbType	Tipo de base de datos del miembro de sincronización.
properties.password	string	Contraseña de la base de datos miembro en el miembro de sincronización.
properties.serverName	string	Nombre del servidor de la base de datos miembro en el miembro de sincronización
properties.sqlServerDatabaseId	string (uuid)	ID de la base de datos de SQL Server del miembro de sincronización.
properties.syncAgentId	string	Identificador de recurso de ARM del agente de sincronización en el miembro de sincronización.
properties.syncDirection	SyncDirection	Dirección de sincronización del miembro de sincronización.
properties.syncMemberAzureDatabaseResourceId	string	ID de recurso ARM de la base de datos lógica miembro de sincronización, para miembros de sincronización en Azure.
properties.usePrivateLinkConnection	boolean	Indica si se va a usar la conexión de vínculo privado.
properties.userName	string	Nombre de usuario de la base de datos miembro en el miembro de sincronización.

Respuestas

Nombre	Tipo	Description
200 OK	SyncMember	Operación de actualización del recurso 'SyncMember' exitosa
201 Created	SyncMember	Recurso 'SyncMember' crear operación exitosa Encabezados Location: string Retry-After: integer
202 Accepted		Operación de recursos aceptada. Encabezados Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Create a new sync member

Update a sync member

Create a new sync member

Solicitud de ejemplo

HTTP

PUT 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/syncMembers/syncmembercrud-4879?api-version=2025-01-01

{
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}

Respuesta de muestra

status code:: 200

{
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}

status code:: 201

{
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}

status code:: 202

Update a sync member

Solicitud de ejemplo

HTTP

PUT 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/syncMembers/syncmembercrud-4879?api-version=2025-01-01

{
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}

Respuesta de muestra

status code:: 200

{
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}

status code:: 201

{
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}

status code:: 202

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
SyncDirection	Dirección de sincronización del miembro de sincronización.
SyncMember	Un miembro de sincronización de Azure SQL Database.
SyncMemberDbType	Tipo de la base de datos vinculada del agente de sincronización.
SyncMemberState	Estado de sincronización del miembro de sincronización.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

SyncDirection

Enumeración

Dirección de sincronización del miembro de sincronización.

Valor	Description
Bidirectional	Bidireccional
OneWayMemberToHub	OnewayMemberToHub
OneWayHubToMember	OneWayHubToMember

SyncMember

Objeto

Un miembro de sincronización de Azure SQL Database.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties.databaseName	string	Nombre de base de datos de la base de datos miembro en el miembro de sincronización.
properties.databaseType	SyncMemberDbType	Tipo de base de datos del miembro de sincronización.
properties.password	string	Contraseña de la base de datos miembro en el miembro de sincronización.
properties.privateEndpointName	string	El nombre del endpoint privado del miembro de sincronización si usa conexión de enlace privado está habilitado, para los miembros de sincronización en Azure.
properties.serverName	string	Nombre del servidor de la base de datos miembro en el miembro de sincronización
properties.sqlServerDatabaseId	string (uuid)	ID de la base de datos de SQL Server del miembro de sincronización.
properties.syncAgentId	string	Identificador de recurso de ARM del agente de sincronización en el miembro de sincronización.
properties.syncDirection	SyncDirection	Dirección de sincronización del miembro de sincronización.
properties.syncMemberAzureDatabaseResourceId	string	ID de recurso ARM de la base de datos lógica miembro de sincronización, para miembros de sincronización en Azure.
properties.syncState	SyncMemberState	Estado de sincronización del miembro de sincronización.
properties.usePrivateLinkConnection	boolean	Indica si se va a usar la conexión de vínculo privado.
properties.userName	string	Nombre de usuario de la base de datos miembro en el miembro de sincronización.
systemData	systemData	Azure Resource Manager metadatos que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft. Compute/virtualMachines" o "Microsoft. CuentasAlmacenamiento/Almacenamiento"

SyncMemberDbType

Enumeración

Tipo de la base de datos vinculada del agente de sincronización.

Valor	Description
AzureSqlDatabase	AzureSqlDatabase
SqlServerDatabase	SqlServerDatabase

SyncMemberState

Enumeración

Estado de sincronización del miembro de sincronización.

Valor	Description
SyncInProgress	SyncInProgress
SyncSucceeded	SyncSucceeded
SyncFailed	SyncFailed
DisabledTombstoneCleanup	Limpieza de TombstonedInhabilitado
DisabledBackupRestore	DisabledBackupRestore
SyncSucceededWithWarnings	SyncSucceededWithWarnings
SyncCancelling	SyncCancelling
SyncCancelled	SyncCancelled
UnProvisioned	UnProvisioned
Provisioning	Aprovisionamiento
Provisioned	provisionado
ProvisionFailed	ProvisiónFallida
DeProvisioning	Desaprovisionamiento
DeProvisioned	DeProvisioned
DeProvisionFailed	DeProvisionFailed
Reprovisioning	Reaprovisionamiento
ReprovisionFailed	ReaprovisionamientoFallido
UnReprovisioned	Sin reabastecer

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	La marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.