Sync Members - Create Or Update

Usługa:: SQL Database

Wersja interfejsu API:: 2025-01-01

Tworzy lub aktualizuje element członkowski synchronizacji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
databaseName	path	True	string	Nazwa bazy danych.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
syncGroupName	path	True	string	Nazwa grupy synchronizacji.
syncMemberName	path	True	string	Nazwa elementu członkowskiego synchronizacji.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
properties.databaseName	string	Nazwa bazy danych składowej w składowej synchronizacji.
properties.databaseType	SyncMemberDbType	Typ bazy danych elementu członkowskiego synchronizacji.
properties.password	string	Hasło bazy danych składowej w elemencie członkowskim synchronizacji.
properties.serverName	string	Nazwa serwera bazy danych składowej w elemencie członkowskim synchronizacji
properties.sqlServerDatabaseId	string (uuid)	Identyfikator bazy danych SQL Server członka synchronizującego.
properties.syncAgentId	string	Identyfikator zasobu usługi ARM agenta synchronizacji w elemencie członkowskim synchronizacji.
properties.syncDirection	SyncDirection	Kierunek synchronizacji elementu członkowskiego synchronizacji.
properties.syncMemberAzureDatabaseResourceId	string	Identyfikator zasobów ARM logicznego bazy danych członków sync, dla członków sync w Azure.
properties.usePrivateLinkConnection	boolean	Czy używać połączenia łącza prywatnego.
properties.userName	string	Nazwa użytkownika bazy danych składowej w elemencie członkowskim synchronizacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SyncMember	Operacja aktualizacji zasobu 'SyncMember' zakończyła się sukcesem
201 Created	SyncMember	Operacja tworzenia zasobu 'SyncMember' zakończyła się sukcesem Nagłówki Location: string Retry-After: integer
202 Accepted		Zaakceptowano operację zasobu. Nagłówki Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Create a new sync member

Update a sync member

Create a new sync member

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Kod stanu:: 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"
  }
}

Kod stanu:: 202

Update a sync member

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Kod stanu:: 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"
  }
}

Kod stanu:: 202

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
SyncDirection	Kierunek synchronizacji elementu członkowskiego synchronizacji.
SyncMember	Członek synchronizacji Azure SQL Database.
SyncMemberDbType	Typ połączonej bazy danych agenta synchronizacji.
SyncMemberState	Stan synchronizacji elementu członkowskiego synchronizacji.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Błąd dodatkowe informacje.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Cel błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

SyncDirection

Wyliczenie

Kierunek synchronizacji elementu członkowskiego synchronizacji.

Wartość	Opis
Bidirectional	Dwukierunkowe
OneWayMemberToHub	OneWayMemberToHub
OneWayHubToMember	OneWayHubToMember

SyncMember

Objekt

Członek synchronizacji Azure SQL Database.

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties.databaseName	string	Nazwa bazy danych składowej w składowej synchronizacji.
properties.databaseType	SyncMemberDbType	Typ bazy danych elementu członkowskiego synchronizacji.
properties.password	string	Hasło bazy danych składowej w elemencie członkowskim synchronizacji.
properties.privateEndpointName	string	Prywatna nazwa endpoint członka sync, jeśli używasz połączenia prywatnego jest włączona, dla członków sync w Azure.
properties.serverName	string	Nazwa serwera bazy danych składowej w elemencie członkowskim synchronizacji
properties.sqlServerDatabaseId	string (uuid)	Identyfikator bazy danych SQL Server członka synchronizującego.
properties.syncAgentId	string	Identyfikator zasobu usługi ARM agenta synchronizacji w elemencie członkowskim synchronizacji.
properties.syncDirection	SyncDirection	Kierunek synchronizacji elementu członkowskiego synchronizacji.
properties.syncMemberAzureDatabaseResourceId	string	Identyfikator zasobów ARM logicznego bazy danych członków sync, dla członków sync w Azure.
properties.syncState	SyncMemberState	Stan synchronizacji elementu członkowskiego synchronizacji.
properties.usePrivateLinkConnection	boolean	Czy używać połączenia łącza prywatnego.
properties.userName	string	Nazwa użytkownika bazy danych składowej w elemencie członkowskim synchronizacji.
systemData	systemData	Metadane Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft. Compute/virtualMachines" lub "Microsoft. Storage/storageAccounts"

SyncMemberDbType

Wyliczenie

Typ połączonej bazy danych agenta synchronizacji.

Wartość	Opis
AzureSqlDatabase	AzureSqlDatabase
SqlServerDatabase	SqlServerDatabase

SyncMemberState

Wyliczenie

Stan synchronizacji elementu członkowskiego synchronizacji.

Wartość	Opis
SyncInProgress	SyncInProgress
SyncSucceeded	SyncSucceeded
SyncFailed	SyncFailed
DisabledTombstoneCleanup	NieaktywneSprzątanie Tombstone
DisabledBackupRestore	DisabledBackupRestore
SyncSucceededWithWarnings	SyncSucceededWithWarnings
SyncCancelling	SyncCancelling
SyncCancelled	SyncCancelled
UnProvisioned	NieProvisioned
Provisioning	Zapewnianie zasobów
Provisioned	Udostępnione
ProvisionFailed	ProvisionFailed
DeProvisioning	DeProvisioning
DeProvisioned	Wycofane z Provisioningu
DeProvisionFailed	DeProvisionFailed
Reprovisioning	Ponowne aprowizowanie
ReprovisionFailed	ReprovisionFailed
UnReprovisioned	Nieodtworzony

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Sync Members - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Create a new sync member

Przykładowe żądanie

Przykładowa odpowiedź

Update a sync member

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SyncDirection

SyncMember

SyncMemberDbType

SyncMemberState

systemData