Sync Groups - List By Database

Referens

Tjänst:: SQL Database

API-version:: 2021-11-01

Listor synkroniseringsgrupper under en hubbdatabas.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups?api-version=2021-11-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
databaseName	path	True	string	Namnet på databasen där synkroniseringsgruppen finns.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string	Det prenumerations-ID som identifierar en Azure-prenumeration.
api-version	query	True	string	DEN API-version som ska användas för begäran.

Svar

Name	Typ	Description
200 OK	SyncGroupListResult	Listan över synkroniseringsgrupper har hämtats.
Other Status Codes		Felsvar: *** 400 InvalidSyncGroupCreateOrUpdateRequest – Begärandetexten för att skapa eller uppdatera synkroniseringsgruppen är tom. 400 InvalidSyncMemberCreateOrUpdateRequest – Begärandetexten för att skapa eller uppdatera synkroniseringsmedlemmen är tom. 400 InvalidSyncAgentCreateOrUpdateRequest – Begärandetexten för att skapa eller uppdatera synkroniseringsagenten är tom. 400 InvalidDatabaseResourceId – Ogiltig databasresursidentifierare. 400 MismatchingSubscriptionWithUrl – den angivna prenumerationen matchade inte prenumerationen i URL:en. 400 InvalidSyncAgentResourceId – Ogiltig synkroniseringsagentens resursidentifierare. 400 MismatchingResourceGroupNameWithUrl – Det angivna resursgruppsnamnet matchade inte namnet i URL:en. 400 MismatchingServerNameWithUrl – det angivna servernamnet matchade inte namnet i URL:en. 400 InvalidParameterValue – ett ogiltigt värde angavs för en parameter. 400 MissingServerName – Servernamnet saknas 400 MissingDatabaseName – Databasnamnet saknas 400 MissingSyncGroupName – Synkroniseringsgruppens namn saknas 400 MissingConflictResolutionPolicy – Konfliktlösningsprincipen saknas 400 MissingSyncAgentName – Synkroniseringsagentens namn saknas 400 SyncOperation_GenericFailure – Det gick inte att utföra datasynkroniseringsåtgärden. 400 InvalidSyncGroup – synkroniseringsgruppen är ogiltig. 400 FeatureDisabledOnSelectedEdition – Användaren försökte använda en funktion som är inaktiverad i den aktuella databasutgåvan. 400 CannotCreateSyncGroupDueToQuotaExceeded – Det går inte att skapa synkroniseringsgruppen på grund av att kvoten har överskridits. 400 SyncOperation_DuplicateSyncGroupDrop – Synkroniseringsgruppen tas redan bort. 400 SyncOperation_WrongSyncDatabase – Den angivna synkroniseringsdatabasen matchar inte den befintliga. 400 SyncOperation_UpdateSyncGroupWhenDropping – Det går inte att uppdatera synkroniseringsgruppen eftersom den håller på att tas bort. 400 SyncOperation_DwInSyncGroup – Det går inte att använda datawarehouse edition i datasynkronisering. 400 SyncOperation_MasterDbInSyncGroup – Det går inte att använda logisk huvudserver i datasynkronisering. 400 SyncOperation_InvalidCredential – Databasens autentiseringsuppgifter är ogiltiga. 400 InvalidSyncMetadataDatabase – Databasen för synkroniseringsmetadata är ogiltig. 400 SyncOperation_InvalidSyncInterval – Det går inte att skapa eller uppdatera synkroniseringsgruppen eftersom synkroniseringsintervallet är ogiltigt. 404 ResourceNotFound – Den begärda resursen hittades inte. 404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte 404 DatabaseDoesNotExist – Användaren har angett ett databasnamn som inte finns på den här serverinstansen. 404 SyncOperation_HubServerNotFound – Den logiska hubbservern finns inte. 404 SyncOperation_InvalidHubDatabase – Hubbdatabasen är ogiltig. 409 SyncOperation_DuplicateSyncGroupName – Det går inte att skapa synkroniseringsgruppen eftersom synkroniseringsgruppen med samma namn redan finns.

Name

Typ

Description

200 OK

SyncGroupListResult

Listan över synkroniseringsgrupper har hämtats.

Other Status Codes

Felsvar: ***

400 InvalidSyncGroupCreateOrUpdateRequest – Begärandetexten för att skapa eller uppdatera synkroniseringsgruppen är tom.
400 InvalidSyncMemberCreateOrUpdateRequest – Begärandetexten för att skapa eller uppdatera synkroniseringsmedlemmen är tom.
400 InvalidSyncAgentCreateOrUpdateRequest – Begärandetexten för att skapa eller uppdatera synkroniseringsagenten är tom.
400 InvalidDatabaseResourceId – Ogiltig databasresursidentifierare.
400 MismatchingSubscriptionWithUrl – den angivna prenumerationen matchade inte prenumerationen i URL:en.
400 InvalidSyncAgentResourceId – Ogiltig synkroniseringsagentens resursidentifierare.
400 MismatchingResourceGroupNameWithUrl – Det angivna resursgruppsnamnet matchade inte namnet i URL:en.
400 MismatchingServerNameWithUrl – det angivna servernamnet matchade inte namnet i URL:en.
400 InvalidParameterValue – ett ogiltigt värde angavs för en parameter.
400 MissingServerName – Servernamnet saknas
400 MissingDatabaseName – Databasnamnet saknas
400 MissingSyncGroupName – Synkroniseringsgruppens namn saknas
400 MissingConflictResolutionPolicy – Konfliktlösningsprincipen saknas
400 MissingSyncAgentName – Synkroniseringsagentens namn saknas
400 SyncOperation_GenericFailure – Det gick inte att utföra datasynkroniseringsåtgärden.
400 InvalidSyncGroup – synkroniseringsgruppen är ogiltig.
400 FeatureDisabledOnSelectedEdition – Användaren försökte använda en funktion som är inaktiverad i den aktuella databasutgåvan.
400 CannotCreateSyncGroupDueToQuotaExceeded – Det går inte att skapa synkroniseringsgruppen på grund av att kvoten har överskridits.
400 SyncOperation_DuplicateSyncGroupDrop – Synkroniseringsgruppen tas redan bort.
400 SyncOperation_WrongSyncDatabase – Den angivna synkroniseringsdatabasen matchar inte den befintliga.
400 SyncOperation_UpdateSyncGroupWhenDropping – Det går inte att uppdatera synkroniseringsgruppen eftersom den håller på att tas bort.
400 SyncOperation_DwInSyncGroup – Det går inte att använda datawarehouse edition i datasynkronisering.
400 SyncOperation_MasterDbInSyncGroup – Det går inte att använda logisk huvudserver i datasynkronisering.
400 SyncOperation_InvalidCredential – Databasens autentiseringsuppgifter är ogiltiga.
400 InvalidSyncMetadataDatabase – Databasen för synkroniseringsmetadata är ogiltig.
400 SyncOperation_InvalidSyncInterval – Det går inte att skapa eller uppdatera synkroniseringsgruppen eftersom synkroniseringsintervallet är ogiltigt.
404 ResourceNotFound – Den begärda resursen hittades inte.
404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte
404 DatabaseDoesNotExist – Användaren har angett ett databasnamn som inte finns på den här serverinstansen.
404 SyncOperation_HubServerNotFound – Den logiska hubbservern finns inte.
404 SyncOperation_InvalidHubDatabase – Hubbdatabasen är ogiltig.
409 SyncOperation_DuplicateSyncGroupName – Det går inte att skapa synkroniseringsgruppen eftersom synkroniseringsgruppen med samma namn redan finns.

Exempel

List sync groups under a given database

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups?api-version=2021-11-01


/**
 * Samples for SyncGroups ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncGroupListByDatabase.json
     */
    /**
     * Sample code: List sync groups under a given database.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listSyncGroupsUnderAGivenDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncGroups().listByDatabase("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", com.azure.core.util.Context.NONE);
    }
}

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

Exempelsvar

Statuskod:: 200

{
  "value": [
    {
      "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"
    },
    {
      "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-5374"
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-5374",
      "name": "syncgroupcrud-5374",
      "type": "Microsoft.Sql/servers/databases/syncGroups"
    }
  ]
}

Definitioner

Name	Description
Sku	En ARM-resurs-SKU.
SyncConflictResolutionPolicy	Princip för konfliktlösning för synkroniseringsgruppen.
SyncGroup	En Azure SQL Database-synkroniseringsgrupp.
SyncGroupListResult	En lista över synkroniseringsgrupper.
SyncGroupSchema	Egenskaper för synkroniseringsgruppschema.
SyncGroupSchemaTable	Egenskaper för tabellen i synkroniseringsgruppsschemat.
SyncGroupSchemaTableColumn	Egenskaper för kolumnen i synkroniseringsgruppstabellen.
SyncGroupState	Synkroniseringsgruppens synkroniseringstillstånd.

Sku

En ARM-resurs-SKU.

Name	Typ	Description
capacity	integer	Kapacitet för den specifika SKU:n.
family	string	Om tjänsten har olika generationer av maskinvara, för samma SKU, kan den samlas in här.
name	string	Namnet på SKU:n, vanligtvis en bokstav + nummerkod, t.ex. P3.
size	string	Storleken på den specifika SKU:n
tier	string	Nivån eller utgåvan av den specifika SKU:n, t.ex. Basic, Premium.

SyncConflictResolutionPolicy

Princip för konfliktlösning för synkroniseringsgruppen.

Name	Typ	Description
HubWin	string
MemberWin	string

SyncGroup

En Azure SQL Database-synkroniseringsgrupp.

Name	Typ	Description
id	string	Resurs-ID.
name	string	Resursnamn.
properties.conflictLoggingRetentionInDays	integer	Kvarhållningsperiod för loggning av konflikter.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Princip för konfliktlösning för synkroniseringsgruppen.
properties.enableConflictLogging	boolean	Om loggning av konflikter är aktiverat.
properties.hubDatabasePassword	string	Lösenord för databasautentiseringsuppgifterna för synkroniseringsgruppens hubb.
properties.hubDatabaseUserName	string	Användarnamn för databasautentiseringsuppgifterna för synkroniseringsgruppens hubb.
properties.interval	integer	Synkroniseringsintervall för synkroniseringsgruppen.
properties.lastSyncTime	string	Synkroniseringsgruppens senaste synkroniseringstid.
properties.privateEndpointName	string	Namnet på synkroniseringsgruppens privata slutpunkt om privat länkanslutning är aktiverad.
properties.schema	SyncGroupSchema	Synkroniseringsschema för synkroniseringsgruppen.
properties.syncDatabaseId	string	ARM-resurs-ID för synkroniseringsdatabasen i synkroniseringsgruppen.
properties.syncState	SyncGroupState	Synkroniseringsgruppens synkroniseringstillstånd.
properties.usePrivateLinkConnection	boolean	Om använd private link-anslutning är aktiverad.
sku	Sku	SKU:ns namn och kapacitet.
type	string	Resurstyp.

SyncGroupListResult

En lista över synkroniseringsgrupper.

Name	Typ	Description
nextLink	string	Länk för att hämta nästa sida med resultat.
value	SyncGroup[]	Matris med resultat.

SyncGroupSchema

Egenskaper för synkroniseringsgruppschema.

Name	Typ	Description
masterSyncMemberName	string	Namnet på den mastersynkroniseringsmedlem som schemat kommer från.
tables	SyncGroupSchemaTable[]	Lista över tabeller i synkroniseringsgruppschemat.

SyncGroupSchemaTable

Egenskaper för tabellen i synkroniseringsgruppsschemat.

Name	Typ	Description
columns	SyncGroupSchemaTableColumn[]	Lista över kolumner i synkroniseringsgruppsschemat.
quotedName	string	Citatnamn för schematabellen för synkroniseringsgrupper.

SyncGroupSchemaTableColumn

Egenskaper för kolumnen i synkroniseringsgruppstabellen.

Name	Typ	Description
dataSize	string	Kolumnens datastorlek.
dataType	string	Datatyp för kolumnen.
quotedName	string	Quoted name of sync group table column.quoted name of sync group table column.

SyncGroupState

Synkroniseringsgruppens synkroniseringstillstånd.

Name	Typ	Description
Error	string
Good	string
NotReady	string
Progressing	string
Warning	string

Dela via

Sync Groups - List By Database

URI-parametrar

Svar

Exempel

List sync groups under a given database

Exempelbegäran

Exempelsvar

Definitioner

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupListResult

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState

Ytterligare resurser