Sync Groups - Create Or Update

Szolgáltatás:: SQL Database

API-verzió:: 2023-08-01

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}?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	A szinkronizálási csoport 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.conflictLoggingRetentionInDays	integer (int32)	Ütközésnaplózás megőrzési ideje.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	A szinkronizálási csoport ütközésfeloldási szabályzata.
properties.enableConflictLogging	boolean	Ha engedélyezve van az ütközésnaplózás.
properties.hubDatabasePassword	string	A szinkronizálási csoport központi adatbázisának hitelesítő adatainak jelszava.
properties.hubDatabaseUserName	string	A szinkronizálási csoport központi adatbázisának hitelesítő adatainak felhasználóneve.
properties.interval	integer (int32)	A szinkronizálási csoport szinkronizálási időköze.
properties.schema	SyncGroupSchema	A szinkronizálási csoport szinkronizálási sémája.
properties.syncDatabaseId	string	A szinkronizálási csoport szinkronizálási adatbázisának ARM-erőforrás-azonosítója.
properties.usePrivateLinkConnection	boolean	Ha a privát kapcsolat használata engedélyezve van.
sku	Sku	A termékváltozat neve és kapacitása.

Válaszok

Name	Típus	Description
200 OK	SyncGroup	Sikeresen frissítette a szinkronizálási csoportot.
201 Created	SyncGroup	Sikeresen létrehozta a szinkronizálási csoportot.
202 Accepted		A szinkronizálási csoport 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 FeatureDisabledOnSelectedEdition – A felhasználó olyan funkciót próbált használni, amely le van tiltva az aktuális adatbázis-kiadásban. 400 CannotCreateSyncGroupDueToQuotaExceeded – A kvóta túllépése miatt nem hozható létre szinkronizálási csoport. 400 SyncOperation_DuplicateSyncGroupDrop – A szinkronizálási csoport már el van dobva. 400 SyncOperation_WrongSyncDatabase – A megadott szinkronizálási adatbázis nem egyezik a meglévő adatbázissal. 400 SyncOperation_UpdateSyncGroupWhenDropping – A szinkronizálási csoport nem frissíthető, mert jelenleg elvetik. 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. 400 SyncOperation_InvalidSyncInterval – A szinkronizálási csoport nem hozható létre vagy frissíthető, mert a szinkronizálási időköz é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_DuplicateSyncGroupName – Nem hozható létre szinkronizálási csoport, mert az azonos nevű szinkronizálási csoport 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 sync group

Update a sync group

Create a sync group

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

{
  "properties": {
    "interval": -1,
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "usePrivateLinkConnection": true
  }
}

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/SyncGroupCreate.json
// this example is just showing the usage of "SyncGroups_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 SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// get the collection of this SyncGroupResource
SyncGroupCollection collection = sqlDatabase.GetSyncGroups();

// invoke the operation
string syncGroupName = "syncgroupcrud-3187";
SyncGroupData data = new SyncGroupData
{
    Interval = -1,
    ConflictResolutionPolicy = SyncConflictResolutionPolicy.HubWin,
    SyncDatabaseId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
    HubDatabaseUserName = "hubUser",
    UsePrivateLinkConnection = true,
};
ArmOperation<SyncGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, syncGroupName, data);
SyncGroupResource 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
SyncGroupData 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": {
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-8475"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups"
}

Állapotkód:: 201

{
  "properties": {
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-8475"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups"
}

Állapotkód:: 202

Update a sync group

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

{
  "properties": {
    "interval": -1,
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "usePrivateLinkConnection": true
  }
}

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/SyncGroupUpdate.json
// this example is just showing the usage of "SyncGroups_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 SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// get the collection of this SyncGroupResource
SyncGroupCollection collection = sqlDatabase.GetSyncGroups();

// invoke the operation
string syncGroupName = "syncgroupcrud-3187";
SyncGroupData data = new SyncGroupData
{
    Interval = -1,
    ConflictResolutionPolicy = SyncConflictResolutionPolicy.HubWin,
    SyncDatabaseId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
    HubDatabaseUserName = "hubUser",
    UsePrivateLinkConnection = true,
};
ArmOperation<SyncGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, syncGroupName, data);
SyncGroupResource 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
SyncGroupData 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": {
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups"
}

Állapotkód:: 201

{
  "properties": {
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups"
}

Á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
Sku	ARM-erőforrás termékváltozata.
SyncConflictResolutionPolicy	A szinkronizálási csoport ütközésfeloldási szabályzata.
SyncGroup	Egy Azure SQL Database-szinkronizálási csoport.
SyncGroupSchema	A szinkronizálási csoport sémájának tulajdonságai.
SyncGroupSchemaTable	A tábla tulajdonságai a szinkronizálási csoport sémájában.
SyncGroupSchemaTableColumn	A szinkronizálási csoport táblájának oszloptulajdonságai.
SyncGroupState	A szinkronizálási csoport 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.

Sku

Objektum

ARM-erőforrás termékváltozata.

Name	Típus	Description
capacity	integer (int32)	Az adott termékváltozat kapacitása.
family	string	Ha a szolgáltatás különböző hardvergenerációval rendelkezik ugyanahhoz az SKU-hoz, akkor ezt itt rögzítheti.
name	string	Az termékváltozat neve általában egy betű + Szám kód, pl. P3.
size	string	Az adott termékváltozat mérete
tier	string	Az adott termékváltozat szintje vagy kiadása, például Alapszintű, Prémium.

SyncConflictResolutionPolicy

Enumerálás

A szinkronizálási csoport ütközésfeloldási szabályzata.

Érték	Description
HubWin
MemberWin

SyncGroup

Objektum

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

Name	Típus	Description
id	string	Erőforrás-azonosító.
name	string	Erőforrás neve.
properties.conflictLoggingRetentionInDays	integer (int32)	Ütközésnaplózás megőrzési ideje.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	A szinkronizálási csoport ütközésfeloldási szabályzata.
properties.enableConflictLogging	boolean	Ha engedélyezve van az ütközésnaplózás.
properties.hubDatabasePassword	string	A szinkronizálási csoport központi adatbázisának hitelesítő adatainak jelszava.
properties.hubDatabaseUserName	string	A szinkronizálási csoport központi adatbázisának hitelesítő adatainak felhasználóneve.
properties.interval	integer (int32)	A szinkronizálási csoport szinkronizálási időköze.
properties.lastSyncTime	string (date-time)	A szinkronizálási csoport utolsó szinkronizálási ideje.
properties.privateEndpointName	string	Ha engedélyezve van a privát kapcsolat használata, a szinkronizálási csoport privát végpontjának neve.
properties.schema	SyncGroupSchema	A szinkronizálási csoport szinkronizálási sémája.
properties.syncDatabaseId	string	A szinkronizálási csoport szinkronizálási adatbázisának ARM-erőforrás-azonosítója.
properties.syncState	SyncGroupState	A szinkronizálási csoport szinkronizálási állapota.
properties.usePrivateLinkConnection	boolean	Ha a privát kapcsolat használata engedélyezve van.
sku	Sku	A termékváltozat neve és kapacitása.
type	string	Erőforrás típusa.

SyncGroupSchema

Objektum

A szinkronizálási csoport sémájának tulajdonságai.

Name	Típus	Description
masterSyncMemberName	string	Annak a fő szinkronizálási tagnak a neve, ahonnan a séma származik.
tables	SyncGroupSchemaTable[]	A szinkronizálási csoport sémájában lévő táblák listája.

SyncGroupSchemaTable

Objektum

A tábla tulajdonságai a szinkronizálási csoport sémájában.

Name	Típus	Description
columns	SyncGroupSchemaTableColumn[]	A szinkronizálási csoport sémájában lévő oszlopok listája.
quotedName	string	A szinkronizálási csoport sématáblájának idézett neve.

SyncGroupSchemaTableColumn

Objektum

A szinkronizálási csoport táblájának oszloptulajdonságai.

Name	Típus	Description
dataSize	string	Az oszlop adatmérete.
dataType	string	Az oszlop adattípusa.
quotedName	string	A szinkronizálási csoport táblaoszlopának idézett neve.

SyncGroupState

Enumerálás

A szinkronizálási csoport szinkronizálási állapota.

Érték	Description
NotReady
Error
Warning
Progressing
Good

Megosztás:

Sync Groups - Create Or Update

URI-paraméterek

Kérelem törzse

Válaszok

Példák

Create a sync group

Mintakérelem

Mintaválasz

Update a sync group

Mintakérelem

Mintaválasz

Definíciók

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState