Sync Groups - Create Or Update

Služba:: SQL Database

Verze rozhraní API:: 2023-08-01

Vytvoří nebo aktualizuje skupinu synchronizace.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
databaseName	path	True	string	Název databáze, na které je skupina synchronizace hostovaná.
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
syncGroupName	path	True	string	Název skupiny synchronizace.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.

Text požadavku

Name	Typ	Description
properties.conflictLoggingRetentionInDays	integer (int32)	Doba uchovávání konfliktních protokolování.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Zásady řešeníkonfliktůch
properties.enableConflictLogging	boolean	Pokud je povolené protokolování konfliktů.
properties.hubDatabasePassword	string	Heslo pro přihlašovací údaje databáze centra synchronizace
properties.hubDatabaseUserName	string	Uživatelské jméno přihlašovacích údajů databáze centra synchronizace
properties.interval	integer (int32)	Interval synchronizace skupiny synchronizace
properties.schema	SyncGroupSchema	Schéma synchronizace skupiny synchronizace
properties.syncDatabaseId	string	ID prostředku ARM synchronizační databáze ve skupině synchronizace
properties.usePrivateLinkConnection	boolean	Pokud je povolené připojení private linku.
sku	Sku	Název a kapacita skladové položky.

Odpovědi

Name	Typ	Description
200 OK	SyncGroup	Skupina synchronizace byla úspěšně aktualizována.
201 Created	SyncGroup	Skupina synchronizace byla úspěšně vytvořena.
202 Accepted		Probíhá vytváření nebo aktualizace skupiny synchronizace. Hlavičky Location: string
Other Status Codes	ErrorResponse	Chybové odpovědi: *** 400 InvalidSyncGroupCreateOrUpdateRequest – Text žádosti o vytvoření nebo aktualizaci skupiny synchronizace je prázdný. 400 InvalidSyncMemberCreateOrUpdateRequest – Text žádosti o vytvoření nebo aktualizaci člena synchronizace je prázdný. 400 InvalidSyncAgentCreateOrUpdateRequest – Text požadavku agenta pro vytvoření nebo aktualizaci synchronizace je prázdný. 400 InvalidDatabaseResourceId – Neplatný identifikátor prostředku databáze. 400 InvalidSyncGroupName – Název skupiny synchronizace je neplatný. Toto pole může obsahovat písmena, číslice, pomlčky a podtržítka. 400 InvalidSyncMemberName – název člena synchronizace je neplatný. Toto pole může obsahovat písmena, číslice, pomlčky a podtržítka. 400 MissingSyncMemberName – Chybí název člena synchronizace. 400 InvalidSyncGroupInterval – Interval synchronizace by měl být větší nebo roven 5 sekund. 400 NeshodaSubscriptionWithUrl – Zadané předplatné neodpovídá předplatnému v adrese URL. 400 InvalidSyncAgentResourceId – Neplatný identifikátor prostředku agenta synchronizace. 400 NeshodaResourceGroupNameWithUrl – zadaný název skupiny prostředků neodpovídá názvu v adrese URL. 400 NeshodaServerNameWithUrl – zadaný název serveru neodpovídá názvu v adrese URL. 400 InvalidParameterValue – Parametr dostal neplatnou hodnotu. 400 MissingServerName – Název serveru chybí. 400 MissingDatabaseName – Chybí název databáze. 400 MissingSyncGroupName – Chybí název skupiny synchronizace. 400 MissingConflictResolutionPolicy – Chybí zásady řešení konfliktů. 400 MissingSyncAgentName – Chybí název agenta synchronizace. 400 SyncOperation_GenericFailure – Nepodařilo se provést operaci synchronizace dat. 400 InvalidSyncGroup – Skupina synchronizace je neplatná. 400 FeatureDisabledOnSelectedEdition – Uživatel se pokusil použít funkci, která je v aktuální edici databáze zakázaná. 400 CannotCreateSyncGroupDueToQuotaExceeded – Nelze vytvořit skupinu synchronizace kvůli překročení kvóty. 400 SyncOperation_DuplicateSyncGroupDrop – skupina synchronizace se už zahodí. 400 SyncOperation_WrongSyncDatabase – Zadaná synchronizační databáze neodpovídá existující databázi. 400 SyncOperation_UpdateSyncGroupWhenDropping – Skupinu synchronizace nelze aktualizovat, protože se právě zahazuje. 400 SyncOperation_DwInSyncGroup – Nejde použít edici datawarehouse při synchronizaci dat. 400 SyncOperation_MasterDbInSyncGroup – V synchronizaci dat nelze použít logický hlavní server. 400 SyncOperation_UnsupportedDataTypeColumnInSchema – Nelze přidat sloupec do schématu, protože datový typ sloupce není podporován. 400 SyncOperation_InvalidCredential – Přihlašovací údaje databáze jsou neplatné. 400 InvalidSyncMetadataDatabase – Databáze metadat synchronizace je neplatná. 400 SyncOperation_InvalidSyncInterval – Skupinu synchronizace nelze vytvořit nebo aktualizovat, protože interval synchronizace je neplatný. 404 ResourceNotFound – Požadovaný prostředek nebyl nalezen. 404 SubscriptionDoesNotHaveServer – Požadovaný server nebyl nalezen. 404 DatabaseDoesNotExist – Uživatel zadal název databáze, který v této instanci serveru neexistuje. 404 SyncOperation_HubServerNotFound – Logický server centra neexistuje. 404 SyncOperation_InvalidHubDatabase – Databáze centra je neplatná. 404 OperationIdNotFound – operace s ID neexistuje. 409 SyncOperation_DuplicateSyncGroupName – Skupinu synchronizace nelze vytvořit, protože skupina synchronizace se stejným názvem již existuje. 409 CannotCancelOperation – Operace správy je ve stavu, který nelze zrušit. 409 OperationCancelled - Operace byla zrušena uživatelem. 409 OperationInterrupted – operaci s prostředkem nebylo možné dokončit, protože byla přerušena jinou operací na stejném prostředku. 429 SubscriptionTooManyCreateUpdateRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 500 OperationTimedOut – Vypršel časový limit operace a automaticky se vrátil zpět. Zkuste operaci zopakovat. 503 TooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.

Příklady

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

Ukázková odpověď

Stavový kó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"
}

Stavový kó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"
}

Stavový kód:: 202

Update a sync group

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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"
}

Stavový kó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"
}

Stavový kód:: 202

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
Sku	Skladová položka prostředku ARM.
SyncConflictResolutionPolicy	Zásady řešeníkonfliktůch
SyncGroup	Skupina synchronizace Azure SQL Database.
SyncGroupSchema	Vlastnosti schématu skupiny synchronizace
SyncGroupSchemaTable	Vlastnosti tabulky ve schématu skupiny synchronizace
SyncGroupSchemaTableColumn	Vlastnosti sloupce v tabulce skupiny synchronizace
SyncGroupState	Stav synchronizace skupiny synchronizace

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

Sku

Objekt

Skladová položka prostředku ARM.

Name	Typ	Description
capacity	integer (int32)	Kapacita konkrétní skladové položky.
family	string	Pokud má služba různé generace hardwaru, pro stejnou skladovou položku, můžete ji zde zachytit.
name	string	Název skladové položky, obvykle písmeno + číslo, např. P3.
size	string	Velikost konkrétní skladové položky
tier	string	Úroveň nebo edice konkrétní skladové položky, např. Basic, Premium.

SyncConflictResolutionPolicy

Výčet

Zásady řešeníkonfliktůch

Hodnota	Description
HubWin
MemberWin

SyncGroup

Objekt

Skupina synchronizace Azure SQL Database.

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku
properties.conflictLoggingRetentionInDays	integer (int32)	Doba uchovávání konfliktních protokolování.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Zásady řešeníkonfliktůch
properties.enableConflictLogging	boolean	Pokud je povolené protokolování konfliktů.
properties.hubDatabasePassword	string	Heslo pro přihlašovací údaje databáze centra synchronizace
properties.hubDatabaseUserName	string	Uživatelské jméno přihlašovacích údajů databáze centra synchronizace
properties.interval	integer (int32)	Interval synchronizace skupiny synchronizace
properties.lastSyncTime	string (date-time)	Čas poslední synchronizace skupiny synchronizace
properties.privateEndpointName	string	Název privátního koncového bodu skupiny synchronizace, pokud je povolené připojení privátního propojení.
properties.schema	SyncGroupSchema	Schéma synchronizace skupiny synchronizace
properties.syncDatabaseId	string	ID prostředku ARM synchronizační databáze ve skupině synchronizace
properties.syncState	SyncGroupState	Stav synchronizace skupiny synchronizace
properties.usePrivateLinkConnection	boolean	Pokud je povolené připojení private linku.
sku	Sku	Název a kapacita skladové položky.
type	string	Typ prostředku.

SyncGroupSchema

Objekt

Vlastnosti schématu skupiny synchronizace

Name	Typ	Description
masterSyncMemberName	string	Název člena hlavní synchronizace, ze kterého se schéma nachází.
tables	SyncGroupSchemaTable[]	Seznam tabulek ve schématu skupiny synchronizace

SyncGroupSchemaTable

Objekt

Vlastnosti tabulky ve schématu skupiny synchronizace

Name	Typ	Description
columns	SyncGroupSchemaTableColumn[]	Seznam sloupců ve schématu skupiny synchronizace
quotedName	string	Název tabulky schématu skupiny synchronizace

SyncGroupSchemaTableColumn

Objekt

Vlastnosti sloupce v tabulce skupiny synchronizace

Name	Typ	Description
dataSize	string	Velikost dat ve sloupci
dataType	string	Datový typ sloupce
quotedName	string	Název sloupce tabulky synchronizační skupiny

SyncGroupState

Výčet

Stav synchronizace skupiny synchronizace

Hodnota	Description
NotReady
Error
Warning
Progressing
Good

Sdílet prostřednictvím

Sync Groups - Create Or Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

Create a sync group

Ukázkový požadavek

Ukázková odpověď

Update a sync group

Ukázkový požadavek

Ukázková odpověď

Definice

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState