Sync Members - Create Or Update

Szolgáltatás:: SQL Database

API-verzió:: 2023-08-01

Szinkronizálási tagot hoz létre vagy frissít.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
databaseName	path	True	string	Annak az adatbázisnak a neve, amelyen a szinkronizálási csoport üzemel.
resourceGroupName	path	True	string	Az erőforrást tartalmazó erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
serverName	path	True	string	A kiszolgáló neve.
subscriptionId	path	True	string	Az Azure-előfizetést azonosító előfizetés-azonosító.
syncGroupName	path	True	string	Annak a szinkronizálási csoportnak a neve, amelyen a szinkronizálási tag üzemel.
syncMemberName	path	True	string	A szinkronizálási tag neve.
api-version	query	True	string	A kéréshez használni kívánt API-verzió.

Kérelem törzse

Name	Típus	Description
properties.databaseName	string	A tagadatbázis adatbázisneve a szinkronizálási tagban.
properties.databaseType	SyncMemberDbType	A szinkronizálási tag adatbázistípusa.
properties.password	string	A tagadatbázis jelszava a szinkronizálási tagban.
properties.serverName	string	A tagadatbázis kiszolgálóneve a szinkronizálási tagban
properties.sqlServerDatabaseId	string (uuid)	A szinkronizálási tag SQL Server-adatbázis-azonosítója.
properties.syncAgentId	string	A szinkronizálási ügynök ARM-erőforrás-azonosítója a szinkronizálási tagban.
properties.syncDirection	SyncDirection	A szinkronizálási tag szinkronizálási iránya.
properties.syncMemberAzureDatabaseResourceId	string	A szinkronizálási tag logikai adatbázisÁNAK ARM-erőforrás-azonosítója az Azure-beli szinkronizálási tagokhoz.
properties.usePrivateLinkConnection	boolean	Privát kapcsolat használata.
properties.userName	string	A tagadatbázis felhasználóneve a szinkronizálási tagban.

Válaszok

Name	Típus	Description
200 OK	SyncMember	A szinkronizálási tag frissítése sikeresen megtörtént.
201 Created	SyncMember	Sikeresen létrehozta a szinkronizálási tagot.
202 Accepted		A szinkronizálási tag létrehozása vagy frissítése folyamatban van. Fejlécek Location: string
Other Status Codes	ErrorResponse	Hibaválaszok: *** 400 InvalidSyncGroupCreateOrUpdateRequest – A szinkronizálási csoport létrehozásának vagy frissítésének kérelemtörzse üres. 400 InvalidSyncMemberCreateOrUpdateRequest – A szinkronizálási tagkérelem-törzs üres. 400 InvalidSyncAgentCreateOrUpdateRequest – A szinkronizálási ügynök kérésének törzse üres. 400 InvalidDatabaseResourceId – Érvénytelen adatbázis-erőforrás-azonosító. 400 InvalidSyncGroupName – A szinkronizálási csoport neve érvénytelen. Ez a mező tartalmazhat betűket, számokat, kötőjeleket és aláhúzásjeleket. 400 InvalidSyncMemberName – A szinkronizálási tag neve érvénytelen. Ez a mező tartalmazhat betűket, számokat, kötőjeleket és aláhúzásjeleket. 400 MissingSyncMemberName – Hiányzik a szinkronizálási tag neve 400 InvalidSyncGroupInterval – A szinkronizálási időköznek 5 másodpercnél nagyobbnak vagy egyenlőnek kell lennie. 400 MismatchingSubscriptionWithUrl – A megadott előfizetés nem egyezett meg az URL-címben szereplő előfizetéssel. 400 InvalidSyncAgentResourceId – Érvénytelen szinkronizálási ügynök erőforrás-azonosítója. 400 MismatchingResourceGroupNameWithUrl – A megadott erőforráscsoport neve nem egyezett az URL-címben megadott névvel. 400 MismatchingServerNameWithUrl – A megadott kiszolgálónév nem egyezett az URL-címben megadott névvel. 400 InvalidParameterValue – Érvénytelen értéket adott meg egy paraméter. 400 MissingServerName – A kiszolgáló neve hiányzik 400 MissingDatabaseName – Az adatbázis neve hiányzik 400 MissingSyncGroupName – Hiányzik a szinkronizálási csoport neve 400 MissingConflictResolutionPolicy – Az ütközésfeloldási szabályzat hiányzik 400 MissingSyncAgentName – A szinkronizálási ügynök neve hiányzik 400 SyncOperation_GenericFailure – Nem sikerült végrehajtani az adatszinkronizálási műveletet. 400 InvalidSyncGroup – A szinkronizálási csoport érvénytelen. 400 InvalidSyncMember – A szinkronizálási tag érvénytelen. 400 InvalidSyncAgent – A szinkronizálási ügynök érvénytelen. 400 CannotCreateSyncMemberDueToQuotaExceeded – A kvóta túllépése miatt nem hozható létre szinkronizálási tag. 400 SyncOperation_DuplicateSyncMemberDrop – A szinkronizálási tagot már elvetik. 400 SyncOperation_WrongSyncDatabase – A megadott szinkronizálási adatbázis nem egyezik a meglévő adatbázissal. 400 SyncOperation_DwInSyncGroup – Az adattárház kiadás nem használható adatszinkronizálásban. 400 SyncOperation_MasterDbInSyncGroup – Nem használható logikai főkiszolgáló az adatszinkronizálásban. 400 SyncOperation_UnsupportedDataTypeColumnInSchema – Nem lehet oszlopot hozzáadni a sémához, mert az oszlop adattípusa nem támogatott. 400 SyncOperation_InvalidCredential – Az adatbázis hitelesítő adatai érvénytelenek. 400 InvalidSyncMetadataDatabase – A metaadat-adatbázis szinkronizálása érvénytelen. 404 ResourceNotFound – A kért erőforrás nem található. 404 SubscriptionDoesNotHaveServer – A kért kiszolgáló nem található 404 DatabaseDoesNotExist – A felhasználó olyan adatbázisnevet adott meg, amely nem létezik ezen a kiszolgálópéldányon. 404 SyncOperation_HubServerNotFound – A központi logikai kiszolgáló nem létezik. 404 SyncOperation_InvalidHubDatabase – A központi adatbázis érvénytelen. 404 OperationIdNotFound – Az azonosítóval rendelkező művelet nem létezik. 409 SyncOperation_DuplicateSyncMemberName – Nem hozható létre szinkronizálási tag, mert az azonos nevű szinkronizálási tag már létezik. 409 CannotCancelOperation – A felügyeleti művelet olyan állapotban van, amely nem törölhető. 409 OperationCancelled – A felhasználó megszakította a műveletet. 409 OperationInterrupted – Az erőforráson lévő művelet nem hajtható végre, mert egy másik művelet megszakította ugyanazon az erőforráson. 429 SubscriptionTooManyCreateUpdateRequests – Az elérhető erőforrások által feldolgozható maximális kéréseken túli kérések. 429 SubscriptionTooManyRequests – Az elérhető erőforrások által feldolgozható kérelmek maximálisnál több kérése. 500 OperationTimedOut – A művelet túllépte az időkorlátot, és automatikusan visszagördült. Próbálkozzon újra a művelettel. 503 TooManyRequests – A rendelkezésre álló erőforrások által feldolgozható maximális kérelmeken túli kérések.

Példák

Create a new sync member

Update a sync member

Create a new sync member

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=2023-08-01

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/SyncMemberCreate.json
// this example is just showing the usage of "SyncMembers_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SyncGroupResource created on azure
// for more information of creating SyncGroupResource, please refer to the document of SyncGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
string syncGroupName = "syncgroupcrud-3187";
ResourceIdentifier syncGroupResourceId = SyncGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, syncGroupName);
SyncGroupResource syncGroup = client.GetSyncGroupResource(syncGroupResourceId);

// get the collection of this SyncMemberResource
SyncMemberCollection collection = syncGroup.GetSyncMembers();

// invoke the operation
string syncMemberName = "syncmembercrud-4879";
SyncMemberData data = new SyncMemberData
{
    DatabaseType = SyncMemberDbType.AzureSqlDatabase,
    SyncMemberAzureDatabaseResourceId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
    UsePrivateLinkConnection = true,
    ServerName = "syncgroupcrud-3379.database.windows.net",
    DatabaseName = "syncgroupcrud-7421",
    UserName = "myUser",
    SyncDirection = SyncDirection.Bidirectional,
};
ArmOperation<SyncMemberResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, syncMemberName, data);
SyncMemberResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SyncMemberData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:: 200

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

Állapotkód:: 201

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

Állapotkód:: 202

Update a sync member

Mintakérelem

HTTP
dotnet

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=2023-08-01

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/SyncMemberUpdate.json
// this example is just showing the usage of "SyncMembers_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SyncGroupResource created on azure
// for more information of creating SyncGroupResource, please refer to the document of SyncGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
string syncGroupName = "syncgroupcrud-3187";
ResourceIdentifier syncGroupResourceId = SyncGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, syncGroupName);
SyncGroupResource syncGroup = client.GetSyncGroupResource(syncGroupResourceId);

// get the collection of this SyncMemberResource
SyncMemberCollection collection = syncGroup.GetSyncMembers();

// invoke the operation
string syncMemberName = "syncmembercrud-4879";
SyncMemberData data = new SyncMemberData
{
    DatabaseType = SyncMemberDbType.AzureSqlDatabase,
    SyncMemberAzureDatabaseResourceId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
    UsePrivateLinkConnection = true,
    ServerName = "syncgroupcrud-3379.database.windows.net",
    DatabaseName = "syncgroupcrud-7421",
    UserName = "myUser",
    SyncDirection = SyncDirection.Bidirectional,
};
ArmOperation<SyncMemberResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, syncMemberName, data);
SyncMemberResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SyncMemberData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:: 200

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

Állapotkód:: 201

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

Állapotkód:: 202

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
SyncDirection	A szinkronizálási tag szinkronizálási iránya.
SyncMember	Egy Azure SQL Database-szinkronizálási tag.
SyncMemberDbType	A szinkronizálási tag adatbázistípusa.
SyncMemberState	A szinkronizálási tag szinkronizálási állapota.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

SyncDirection

Enumerálás

A szinkronizálási tag szinkronizálási iránya.

Érték	Description
Bidirectional
OneWayMemberToHub
OneWayHubToMember

SyncMember

Objektum

Egy Azure SQL Database-szinkronizálási tag.

Name	Típus	Description
id	string	Erőforrás-azonosító.
name	string	Erőforrás neve.
properties.databaseName	string	A tagadatbázis adatbázisneve a szinkronizálási tagban.
properties.databaseType	SyncMemberDbType	A szinkronizálási tag adatbázistípusa.
properties.password	string	A tagadatbázis jelszava a szinkronizálási tagban.
properties.privateEndpointName	string	Ha engedélyezve van a privát kapcsolat használata, a szinkronizálási tag privát végpontjának neve az Azure-ban.
properties.serverName	string	A tagadatbázis kiszolgálóneve a szinkronizálási tagban
properties.sqlServerDatabaseId	string (uuid)	A szinkronizálási tag SQL Server-adatbázis-azonosítója.
properties.syncAgentId	string	A szinkronizálási ügynök ARM-erőforrás-azonosítója a szinkronizálási tagban.
properties.syncDirection	SyncDirection	A szinkronizálási tag szinkronizálási iránya.
properties.syncMemberAzureDatabaseResourceId	string	A szinkronizálási tag logikai adatbázisÁNAK ARM-erőforrás-azonosítója az Azure-beli szinkronizálási tagokhoz.
properties.syncState	SyncMemberState	A szinkronizálási tag szinkronizálási állapota.
properties.usePrivateLinkConnection	boolean	Privát kapcsolat használata.
properties.userName	string	A tagadatbázis felhasználóneve a szinkronizálási tagban.
type	string	Erőforrás típusa.

SyncMemberDbType

Enumerálás

A szinkronizálási tag adatbázistípusa.

Érték	Description
AzureSqlDatabase
SqlServerDatabase

SyncMemberState

Enumerálás

A szinkronizálási tag szinkronizálási állapota.

Érték	Description
SyncInProgress
SyncSucceeded
SyncFailed
DisabledTombstoneCleanup
DisabledBackupRestore
SyncSucceededWithWarnings
SyncCancelling
SyncCancelled
UnProvisioned
Provisioning
Provisioned
ProvisionFailed
DeProvisioning
DeProvisioned
DeProvisionFailed
Reprovisioning
ReprovisionFailed
UnReprovisioned

Megosztás:

Sync Members - Create Or Update

URI-paraméterek

Kérelem törzse

Válaszok

Példák

Create a new sync member

Mintakérelem

Mintaválasz

Update a sync member

Mintakérelem

Mintaválasz

Definíciók

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SyncDirection

SyncMember

SyncMemberDbType

SyncMemberState