Azure SQL: Failover 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 8
FailoverGroups
- GETFailoverGroups_ListByServer
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/failoverGroupsLists the failover groups in a server. - GETFailoverGroups_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/failoverGroups/:failoverGroupNameGets a failover group. - PUTFailoverGroups_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/failoverGroups/:failoverGroupNameCreates or updates a failover group. - DELETEFailoverGroups_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/failoverGroups/:failoverGroupNameDeletes a failover group. - PATCHFailoverGroups_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/failoverGroups/:failoverGroupNameUpdates a failover group. - POSTFailoverGroups_Failover
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/failoverGroups/:failoverGroupName/failoverFails over from the current primary server to this server. - POSTFailoverGroups_ForceFailoverAllowDataLoss
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/failoverGroups/:failoverGroupName/forceFailoverAllowDataLossFails over from the current primary server to this server. This operation might result in data loss. - POSTFailoverGroups_TryPlannedBeforeForcedFailover
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/failoverGroups/:failoverGroupName/tryPlannedBeforeForcedFailoverFails over from the current primary server to this server. This operation tries planned before forced failover but might still result in data loss.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 8 operations on 5 pathsPOST 3GET 2PUT 1PATCH 1DELETE 1
- Main resources
- FailoverGroups 8
- Response formats
application/json- Description format
- Swagger 2.0, API version
2025-01-01 - Links
- OpenAPI document
How to test the Azure SQL: Failover Groups in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure SQL: Failover Groups collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “FailoverGroups_ListByServer” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/failoverGroups), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure SQL: Failover 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 8 endpoints.
Who publishes the Azure SQL: Failover 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: Failover Groups?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure SQL: Failover Groups?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure SQL: Failover Groups have?
8 operations on 5 paths (3 POST, 2 GET, 1 PUT, 1 PATCH, 1 DELETE). The largest groups are FailoverGroups.
Is forking the Azure SQL: Failover Groups free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.