Sync Groups - Create Or Update

Service:

SQL Database

API-versie:

2023-08-01

Hiermee maakt of werkt u een synchronisatiegroep bij.

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

URI-parameters

Name	In	Vereist	Type	Description
databaseName	path	True	string	De naam van de database waarop de synchronisatiegroep wordt gehost.
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName	path	True	string	De naam van de server.
subscriptionId	path	True	string	De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
syncGroupName	path	True	string	De naam van de synchronisatiegroep.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag.

Aanvraagbody

Name	Type	Description
properties.conflictLoggingRetentionInDays	integer (int32)	Bewaarperiode voor conflictlogboekregistratie.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Conflictoplossingsbeleid van de synchronisatiegroep.
properties.enableConflictLogging	boolean	Als conflictlogboekregistratie is ingeschakeld.
properties.hubDatabasePassword	string	Wachtwoord voor de databasereferentie van de synchronisatiegroephub.
properties.hubDatabaseUserName	string	Gebruikersnaam voor de databasereferentie van de synchronisatiegroephub.
properties.interval	integer (int32)	Synchronisatie-interval van de synchronisatiegroep.
properties.schema	SyncGroupSchema	Synchronisatieschema van de synchronisatiegroep.
properties.syncDatabaseId	string	ARM-resource-id van de synchronisatiedatabase in de synchronisatiegroep.
properties.usePrivateLinkConnection	boolean	Als u een Private Link-verbinding gebruikt, is ingeschakeld.
sku	Sku	De naam en capaciteit van de SKU.

Antwoorden

Name	Type	Description
200 OK	SyncGroup	De synchronisatiegroep is bijgewerkt.
201 Created	SyncGroup	De synchronisatiegroep is gemaakt.
202 Accepted		Het maken of bijwerken van de synchronisatiegroep wordt uitgevoerd. Kopteksten Location: string
Other Status Codes	ErrorResponse	Foutreacties: *** 400 InvalidSyncGroupCreateOrUpdateRequest : de aanvraagbody voor het maken of bijwerken van de synchronisatiegroep is leeg. 400 InvalidSyncMemberCreateOrUpdateRequest: de aanvraagbody voor het maken of bijwerken van een synchronisatielid is leeg. 400 InvalidSyncAgentCreateOrUpdateRequest : de aanvraagbody voor de aanvraag voor de aanvraag voor de synchronisatieagent maken of bijwerken is leeg. 400 InvalidDatabaseResourceId - Ongeldige databaseresource-id. 400 InvalidSyncGroupName : de naam van de synchronisatiegroep is ongeldig. Dit veld kan letters, cijfers, streepjes en onderstrepingstekens bevatten. 400 InvalidSyncMemberName : de naam van het synchronisatielid is ongeldig. Dit veld kan letters, cijfers, streepjes en onderstrepingstekens bevatten. 400 MissingSyncMemberName - De naam van het synchronisatielid ontbreekt 400 InvalidSyncGroupInterval- Synchronisatie-interval moet groter zijn dan of gelijk zijn aan 5 seconden. 400 Niet-overeenkomendeSubscriptionWithUrl : het opgegeven abonnement komt niet overeen met het abonnement in de URL. 400 InvalidSyncAgentResourceId - Ongeldige resource-id van de synchronisatieagent. 400 Komt niet overeen metResourceGroupNameWithUrl: de opgegeven resourcegroepnaam komt niet overeen met de naam in de URL. 400 Niet-overeenkomendeServerNameWithUrl : de opgegeven servernaam komt niet overeen met de naam in de URL. 400 InvalidParameterValue - Er is een ongeldige waarde aan een parameter gegeven. 400 MissingServerName - De servernaam ontbreekt 400 MissingDatabaseName - De databasenaam ontbreekt 400 MissingSyncGroupName - De naam van de synchronisatiegroep ontbreekt 400 MissingConflictResolutionPolicy - Het conflictoplossingsbeleid ontbreekt 400 MissingSyncAgentName : de naam van de synchronisatieagent ontbreekt 400 SyncOperation_GenericFailure : kan de gegevenssynchronisatiebewerking niet uitvoeren. 400 InvalidSyncGroup - Synchronisatiegroep is ongeldig. 400 FeatureDisabledOnSelectedEdition - Gebruiker heeft geprobeerd een functie te gebruiken die is uitgeschakeld voor de huidige database-editie. 400 CannotCreateSyncGroupDueToQuotaExceeded - Kan geen synchronisatiegroep maken omdat het quotum is overschreden. 400 SyncOperation_DuplicateSyncGroupDrop: de synchronisatiegroep wordt al verwijderd. 400 SyncOperation_WrongSyncDatabase : de opgegeven synchronisatiedatabase komt niet overeen met de bestaande database. 400 SyncOperation_UpdateSyncGroupWhenDropping: kan de synchronisatiegroep niet bijwerken omdat deze momenteel wordt verwijderd. 400 SyncOperation_DwInSyncGroup - Kan datawarehouse-editie niet gebruiken in gegevenssynchronisatie. 400 SyncOperation_MasterDbInSyncGroup - Kan logische master niet gebruiken in gegevenssynchronisatie. 400 SyncOperation_UnsupportedDataTypeColumnInSchema : kan geen kolom toevoegen aan het schema omdat het gegevenstype van de kolom niet wordt ondersteund. 400 SyncOperation_InvalidCredential : de referentie van de database is ongeldig. 400 InvalidSyncMetadataDatabase - Database met synchronisatiemetagegevens is ongeldig. 400 SyncOperation_InvalidSyncInterval - Kan synchronisatiegroep niet maken of bijwerken omdat het synchronisatie-interval ongeldig is. 404 ResourceNotFound : de aangevraagde resource is niet gevonden. 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden 404 DatabaseDoesNotExist - Gebruiker heeft een databasenaam opgegeven die niet bestaat op dit serverexemplaren. 404 SyncOperation_HubServerNotFound - Logische hubserver bestaat niet. 404 SyncOperation_InvalidHubDatabase - Hub-database is ongeldig. 404 OperationIdNotFound - De bewerking met id bestaat niet. 409 SyncOperation_DuplicateSyncGroupName : kan geen synchronisatiegroep maken omdat de synchronisatiegroep met dezelfde naam al bestaat. 409 CannotCancelOperation - De beheerbewerking heeft een status die niet kan worden geannuleerd. 409 OperationCancelled - De bewerking is geannuleerd door de gebruiker. 409 Bewerking onderbroken: de bewerking op de resource kan niet worden voltooid omdat deze is onderbroken door een andere bewerking op dezelfde resource. 429 SubscriptionTooManyCreateUpdateRequests - Aanvragen buiten het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources. 429 SubscriptionTooManyRequests : aanvragen buiten het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources. 500 OperationTimedOut: er is een time-out opgetreden voor de bewerking en wordt automatisch teruggedraaid. Voer de bewerking opnieuw uit. 503 TooManyRequests : aanvragen die buiten het maximum aantal aanvragen kunnen worden verwerkt door beschikbare resources.

Voorbeelden

Create a sync group

Update a sync group

Create a sync group

Voorbeeldaanvraag

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

dotnet

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

Voorbeeldrespons

Statuscode:

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

Statuscode:

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

Statuscode:

202

Update a sync group

Voorbeeldaanvraag

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

dotnet

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

Voorbeeldrespons

Statuscode:

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

Statuscode:

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

Statuscode:

202

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
Sku	Een ARM-resource-SKU.
SyncConflictResolutionPolicy	Conflictoplossingsbeleid van de synchronisatiegroep.
SyncGroup	Een Azure SQL Database-synchronisatiegroep.
SyncGroupSchema	Eigenschappen van synchronisatiegroepschema.
SyncGroupSchemaTable	Eigenschappen van tabel in synchronisatiegroepschema.
SyncGroupSchemaTableColumn	Eigenschappen van kolom in de synchronisatiegroepstabel.
SyncGroupState	Synchronisatiestatus van de synchronisatiegroep.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

Sku

Object

Een ARM-resource-SKU.

Name	Type	Description
capacity	integer (int32)	Capaciteit van de specifieke SKU.
family	string	Als de service verschillende generaties hardware heeft, voor dezelfde SKU, kan die hier worden vastgelegd.
name	string	De naam van de SKU, meestal een letter + cijfercode, bijvoorbeeld P3.
size	string	Grootte van de specifieke SKU
tier	string	De laag of editie van de specifieke SKU, bijvoorbeeld Basic, Premium.

SyncConflictResolutionPolicy

Inventarisatie

Conflictoplossingsbeleid van de synchronisatiegroep.

Waarde	Description
HubWin
MemberWin

SyncGroup

Object

Een Azure SQL Database-synchronisatiegroep.

Name	Type	Description
id	string	Resource-id.
name	string	Resourcenaam.
properties.conflictLoggingRetentionInDays	integer (int32)	Bewaarperiode voor conflictlogboekregistratie.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Conflictoplossingsbeleid van de synchronisatiegroep.
properties.enableConflictLogging	boolean	Als conflictlogboekregistratie is ingeschakeld.
properties.hubDatabasePassword	string	Wachtwoord voor de databasereferentie van de synchronisatiegroephub.
properties.hubDatabaseUserName	string	Gebruikersnaam voor de databasereferentie van de synchronisatiegroephub.
properties.interval	integer (int32)	Synchronisatie-interval van de synchronisatiegroep.
properties.lastSyncTime	string (date-time)	Laatste synchronisatietijd van de synchronisatiegroep.
properties.privateEndpointName	string	De naam van het privé-eindpunt van de synchronisatiegroep als private link-verbinding is ingeschakeld.
properties.schema	SyncGroupSchema	Synchronisatieschema van de synchronisatiegroep.
properties.syncDatabaseId	string	ARM-resource-id van de synchronisatiedatabase in de synchronisatiegroep.
properties.syncState	SyncGroupState	Synchronisatiestatus van de synchronisatiegroep.
properties.usePrivateLinkConnection	boolean	Als u een Private Link-verbinding gebruikt, is ingeschakeld.
sku	Sku	De naam en capaciteit van de SKU.
type	string	Resourcetype.

SyncGroupSchema

Object

Eigenschappen van synchronisatiegroepschema.

Name	Type	Description
masterSyncMemberName	string	Naam van hoofdsynchronisatielid waaruit het schema afkomstig is.
tables	SyncGroupSchemaTable[]	Lijst met tabellen in synchronisatiegroepschema.

SyncGroupSchemaTable

Object

Eigenschappen van tabel in synchronisatiegroepschema.

Name	Type	Description
columns	SyncGroupSchemaTableColumn[]	Lijst met kolommen in synchronisatiegroepschema.
quotedName	string	De naam van de schematabel van de synchronisatiegroep.

SyncGroupSchemaTableColumn

Object

Eigenschappen van kolom in de synchronisatiegroepstabel.

Name	Type	Description
dataSize	string	Gegevensgrootte van de kolom.
dataType	string	Gegevenstype van de kolom.
quotedName	string	De naam van de kolom met de synchronisatiegroeptabel.

SyncGroupState

Inventarisatie

Synchronisatiestatus van de synchronisatiegroep.

Waarde	Description
NotReady
Error
Warning
Progressing
Good