Microsoft Azure

Azure SQL: Sync Groups

The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API…

Data & analytics#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities.

Endpoints 11

SyncGroups

  • GETSyncGroups_ListSyncDatabaseIds/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/syncDatabaseIdsGets a collection of sync database ids.
  • GETSyncGroups_ListByDatabase/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/databases/:databaseName/syncGroupsLists sync groups under a hub database.
  • GETSyncGroups_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/databases/:databaseName/syncGroups/:syncGroupNameGets a sync group.
  • PUTSyncGroups_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/databases/:databaseName/syncGroups/:syncGroupNameCreates or updates a sync group.
  • DELETESyncGroups_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/databases/:databaseName/syncGroups/:syncGroupNameDeletes a sync group.
  • PATCHSyncGroups_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/databases/:databaseName/syncGroups/:syncGroupNameUpdates a sync group.
  • POSTSyncGroups_CancelSync/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/databases/:databaseName/syncGroups/:syncGroupName/cancelSyncCancels a sync group synchronization.
  • GETSyncGroups_ListHubSchemas/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/databases/:databaseName/syncGroups/:syncGroupName/hubSchemasGets a collection of hub database schemas.
  • GETSyncGroups_ListLogs/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/databases/:databaseName/syncGroups/:syncGroupName/logs?startTime=string&endTime=string&type=All&continuationToken=stringGets a collection of sync group logs.
  • POSTSyncGroups_RefreshHubSchema/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/databases/:databaseName/syncGroups/:syncGroupName/refreshHubSchemaRefreshes a hub database schema.
  • POSTSyncGroups_TriggerSync/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/databases/:databaseName/syncGroups/:syncGroupName/triggerSyncTriggers a sync group synchronization.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
11 operations on 8 pathsGET 5POST 3PUT 1PATCH 1DELETE 1
Main resources
SyncGroups 11
Response formats
application/json
Description format
Swagger 2.0, API version 2025-01-01

How to test the Azure SQL: Sync Groups in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure SQL: Sync Groups collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “SyncGroups_ListSyncDatabaseIds” (GET /subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/syncDatabaseIds), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure SQL: Sync Groups?

The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API… It is listed under Data & analytics and has 11 endpoints.

Who publishes the Azure SQL: Sync Groups?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure SQL: Sync Groups?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure SQL: Sync Groups?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure SQL: Sync Groups have?

11 operations on 8 paths (5 GET, 3 POST, 1 PUT, 1 PATCH, 1 DELETE). The largest groups are SyncGroups.

Is forking the Azure SQL: Sync Groups free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.