Sync Members - Create Or Update

Serviço:: SQL Database

Versão da API:: 2025-01-01

Cria ou atualiza um membro de sincronização.

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 URI

Nome	Em	Obrigatório	Tipo	Description
databaseName	path	True	string	O nome do banco de dados.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
syncGroupName	path	True	string	O nome do grupo de sincronização.
syncMemberName	path	True	string	O nome do membro de sincronização.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
properties.databaseName	string	Nome do banco de dados membro no membro de sincronização.
properties.databaseType	SyncMemberDbType	Tipo de banco de dados do membro de sincronização.
properties.password	string	Senha do banco de dados membro no membro de sincronização.
properties.serverName	string	Nome do servidor do banco de dados membro no membro de sincronização
properties.sqlServerDatabaseId	string (uuid)	ID do banco de dados do SQL Server do membro de sincronização.
properties.syncAgentId	string	ID do recurso ARM do agente de sincronização no membro de sincronização.
properties.syncDirection	SyncDirection	Direção de sincronização do membro de sincronização.
properties.syncMemberAzureDatabaseResourceId	string	ID de recurso ARM do banco de dados lógico dos membros de sincronização, para membros de sincronização no Azure.
properties.usePrivateLinkConnection	boolean	Se deve usar a conexão de link privado.
properties.userName	string	Nome de usuário do banco de dados membro no membro de sincronização.

Respostas

Nome	Tipo	Description
200 OK	SyncMember	Operação de atualização do recurso 'SyncMember' bem-sucedida
201 Created	SyncMember	Recurso 'SyncMember' criar operação bem-sucedida Cabeçalhos Location: string Retry-After: integer
202 Accepted		Operação de recurso aceita. Cabeçalhos Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Create a new sync member

Update a sync member

Create a new sync member

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
  }
}

Código de status:: 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"
  }
}

Código de status:: 202

Update a sync member

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
  }
}

Código de status:: 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"
  }
}

Código de status:: 202

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
SyncDirection	Direção de sincronização do membro de sincronização.
SyncMember	Um membro do Banco de Dados SQL do Azure Sync.
SyncMemberDbType	Tipo do banco de dados vinculado do agente de sincronização.
SyncMemberState	Estado de sincronização do membro de sincronização.
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

SyncDirection

Enumeração

Direção de sincronização do membro de sincronização.

Valor	Description
Bidirectional	Bidirecional
OneWayMemberToHub	UmModoMembroParaHub
OneWayHubToMember	OneWayHubToMember

SyncMember

Objeto

Um membro do Banco de Dados SQL do Azure Sync.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.databaseName	string	Nome do banco de dados membro no membro de sincronização.
properties.databaseType	SyncMemberDbType	Tipo de banco de dados do membro de sincronização.
properties.password	string	Senha do banco de dados membro no membro de sincronização.
properties.privateEndpointName	string	O nome do endpoint privado do membro de sincronização, se usar conexão de link privado estiver ativado, para membros de sincronização no Azure.
properties.serverName	string	Nome do servidor do banco de dados membro no membro de sincronização
properties.sqlServerDatabaseId	string (uuid)	ID do banco de dados do SQL Server do membro de sincronização.
properties.syncAgentId	string	ID do recurso ARM do agente de sincronização no membro de sincronização.
properties.syncDirection	SyncDirection	Direção de sincronização do membro de sincronização.
properties.syncMemberAzureDatabaseResourceId	string	ID de recurso ARM do banco de dados lógico dos membros de sincronização, para membros de sincronização no Azure.
properties.syncState	SyncMemberState	Estado de sincronização do membro de sincronização.
properties.usePrivateLinkConnection	boolean	Se deve usar a conexão de link privado.
properties.userName	string	Nome de usuário do banco de dados membro no membro de sincronização.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Compute/virtualMachines" ou "Microsoft. ContasArmazenamento/Armazenamento"

SyncMemberDbType

Enumeração

Tipo do banco de dados vinculado do agente de sincronização.

Valor	Description
AzureSqlDatabase	AzureSqlDatabase
SqlServerDatabase	SqlServerDatabase

SyncMemberState

Enumeração

Estado de sincronização do membro de sincronização.

Valor	Description
SyncInProgress	SyncInProgress
SyncSucceeded	SyncSucceeded
SyncFailed	SyncFailed
DisabledTombstoneCleanup	DesativadoTumbstoneCleanup
DisabledBackupRestore	DisabledBackupRestore
SyncSucceededWithWarnings	SyncSucceededWithWarnings
SyncCancelling	SyncCancelling
SyncCancelled	SyncCancelled
UnProvisioned	UnProvisioned
Provisioning	Provisionamento
Provisioned	Provisionado
ProvisionFailed	ProvisãoFalhada
DeProvisioning	Desaprovisionamento
DeProvisioned	DeProvisioned
DeProvisionFailed	DeProvisionFailed
Reprovisioning	Reprovisionamento
ReprovisionFailed	Reabastecimento Falhado
UnReprovisioned	Não Reabastecido

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.