Share via

Sync Groups - List Sync Database Ids

Service:
SQL Database
API Version:
2025-01-01

Gets a collection of sync database ids.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/syncDatabaseIds?api-version=2025-01-01

URI Parameters

Name In Required Type Description
locationName
 path True

string

The name of the region where the resource is located.
subscriptionId
 path True

string

The subscription ID that identifies an Azure subscription.
api-version
 query True

string

The API version to use for the request.

Responses

Name Type Description
200 OK

SyncDatabaseIdListResult

Successfully retrieved collection of sync database ids.
Other Status Codes

ErrorResponse

*** Error Responses: ***

  • 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.

  • 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.

  • 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.

  • 400 InvalidDatabaseResourceId - Invalid database resource identifier.

  • 400 InvalidSyncGroupName - The Sync Group name is invalid. This field can contain letters, numbers, dashes and underscores.

  • 400 InvalidSyncMemberName - The Sync Member name is invalid. This field can contain letters, numbers, dashes and underscores.

  • 400 MissingSyncMemberName - The Sync Member name is missing

  • 400 InvalidSyncGroupInterval - Sync Interval should be greater than or equal to 5 seconds.

  • 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.

  • 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.

  • 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.

  • 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.

  • 400 InvalidParameterValue - An invalid value was given to a parameter.

  • 400 MissingServerName - The Server name is missing

  • 400 MissingDatabaseName - The Database name is missing

  • 400 MissingSyncGroupName - The Sync Group name is missing

  • 400 MissingConflictResolutionPolicy - The Conflict Resolution Policy is missing

  • 400 MissingSyncAgentName - The Sync Agent name is missing

  • 400 DataSyncMissingIdentityType - The identity type must be specified.

  • 400 DataSyncMissingUserAssignedIdentities - The identity type is set to 'UserAssigned', but no user-assigned identities are listed.

  • 400 DataSyncMissingAuthenticationInfo - At least one authentication method must be provided.

  • 400 DataSyncInvalidIdentityType - An unrecognized or unsupported identity type was specified in the sync configuration.

  • 400 DataSyncMultipleIdentities - Only one user-assigned managed identity is supported for a sync configuration.

  • 400 SyncOperation_GenericFailure - Failed to perform data sync operation.

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.

Examples

Get a sync database ID

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/westus/syncDatabaseIds?api-version=2025-01-01

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
    }
  ]
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
SyncDatabaseIdListResult

A list of sync database ID properties.
SyncDatabaseIdProperties

Properties of the sync database id.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

SyncDatabaseIdListResult

Object

A list of sync database ID properties.

Name Type Description
nextLink

string

Link to retrieve next page of results.
value

SyncDatabaseIdProperties[]

Array of results.

SyncDatabaseIdProperties

Object

Properties of the sync database id.

Name Type Description
id

string

ARM resource id of sync database.