@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api SqlManagementClient
@base https://management.azure.com
@version 2015-05-01-preview
@auth OAuth2
@common_fields {subscriptionId: any # The subscription ID that identifies an Azure subscription., api-version: any # The API version to use for the request.}
@endpoints 11
@toc subscriptions(11)

@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/syncDatabaseIds
@desc Gets a collection of sync database ids.
@required {locationName: any # The name of the region where the resource is located.}
@returns(200) Successfully retrieved collection of sync database ids.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/refreshHubSchema
@desc Refreshes a hub database schema.
@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., serverName: any # The name of the server., databaseName: any # The name of the database on which the sync group is hosted., syncGroupName: any # The name of the sync group.}
@returns(200) Successfully refreshed a sync hub schema.
@returns(202) The sync hub schema refresh operation is on going.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/hubSchemas
@desc Gets a collection of hub database schemas.
@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., serverName: any # The name of the server., databaseName: any # The name of the database on which the sync group is hosted., syncGroupName: any # The name of the sync group.}
@returns(200) Successfully get a sync group hub database schema.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/logs
@desc Gets a collection of sync group logs.
@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., serverName: any # The name of the server., databaseName: any # The name of the database on which the sync group is hosted., syncGroupName: any # The name of the sync group., startTime: any # Get logs generated after this time., endTime: any # Get logs generated before this time., type: any # The types of logs to retrieve.}
@optional {continuationToken: any # The continuation token for this operation.}
@returns(200) Successfully retrieved sync group logs.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/cancelSync
@desc Cancels a sync group synchronization.
@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., serverName: any # The name of the server., databaseName: any # The name of the database on which the sync group is hosted., syncGroupName: any # The name of the sync group.}
@returns(200) Successfully cancel a sync group synchronization.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/triggerSync
@desc Triggers a sync group synchronization.
@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., serverName: any # The name of the server., databaseName: any # The name of the database on which the sync group is hosted., syncGroupName: any # The name of the sync group.}
@returns(200) Successfully triggered a sync group synchronization.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}
@desc Gets a sync group.
@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., serverName: any # The name of the server., databaseName: any # The name of the database on which the sync group is hosted., syncGroupName: any # The name of the sync group.}
@returns(200) Successfully retrieved the specified sync group.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}
@desc Creates or updates a sync group.
@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., serverName: any # The name of the server., databaseName: any # The name of the database on which the sync group is hosted., syncGroupName: any # The name of the sync group., parameters: map # The requested sync group resource state.}
@returns(200) Successfully updated the sync group.
@returns(201) Successfully created the sync group.
@returns(202) Creating or updating the sync group is in progress.

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}
@desc Deletes a sync group.
@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., serverName: any # The name of the server., databaseName: any # The name of the database on which the sync group is hosted., syncGroupName: any # The name of the sync group.}
@returns(200) Successfully deleted the sync group.
@returns(202) Deleting the sync group is in progress.
@returns(204) The specified sync group does not exist.

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}
@desc Updates a sync group.
@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., serverName: any # The name of the server., databaseName: any # The name of the database on which the sync group is hosted., syncGroupName: any # The name of the sync group., parameters: map # The requested sync group resource state.}
@returns(200) Successfully updated the sync group.
@returns(202) Updating the sync group is in progress.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups
@desc Lists sync groups under a hub database.
@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., serverName: any # The name of the server., databaseName: any # The name of the database on which the sync group is hosted.}
@returns(200) Successfully retrieved the list of sync groups.

@end
