Microsoft Azure

Azure Database for MySQL

The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall…

Data & analytics#openapi

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 Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules and configurations.

Endpoints 31

Servers

  • GETServers_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverNameGets information about a server.
  • PUTServers_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverNameCreates a new server or updates an existing server. The update action will overwrite the existing server.
  • DELETEServers_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverNameDeletes a server.
  • PATCHServers_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverNameUpdates an existing server. The request body can contain one to many of the properties present in the normal server definition.
  • GETServers_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServersList all the servers in a given resource group.
  • GETServers_List/subscriptions/:subscriptionId/providers/Microsoft.DBforMySQL/flexibleServersList all the servers in a given subscription.
  • GETReplicas_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/replicasList all the replicas for a given server.

ServerFailover

  • POSTServers_Failover/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/failoverManual failover a server.

ServerRestart

  • POSTServers_Restart/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/restartRestarts a server.

ServerStart

  • POSTServers_Start/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/startStarts a server.

ServerStop

  • POSTServers_Stop/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/stopStops a server.

Backups

  • GETBackups_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/backups/:backupNameList all the backups for a given server.
  • GETBackups_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/backupsList all the backups for a given server.

FirewallRules

  • GETFirewallRules_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/firewallRules/:firewallRuleNameGets information about a server firewall rule.
  • PUTFirewallRules_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/firewallRules/:firewallRuleNameCreates a new firewall rule or updates an existing firewall rule.
  • DELETEFirewallRules_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/firewallRules/:firewallRuleNameDeletes a firewall rule.
  • GETFirewallRules_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/firewallRulesList all the firewall rules in a given server.

Databases

  • GETDatabases_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/databases/:databaseNameGets information about a database.
  • PUTDatabases_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/databases/:databaseNameCreates a new database or updates an existing database.
  • DELETEDatabases_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/databases/:databaseNameDeletes a database.
  • GETDatabases_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/databasesList all the databases in a given server.

Configurations

  • GETConfigurations_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/configurations/:configurationNameGets information about a configuration of server.
  • PATCHConfigurations_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/configurations/:configurationNameUpdates a configuration of a server.
  • POSTConfigurations_BatchUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/updateConfigurationsUpdate a list of configurations in a given server.
  • GETConfigurations_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName/configurationsList all the configurations in a given server.

LocationBasedCapabilities

  • GETLocationBasedCapabilities_List/subscriptions/:subscriptionId/providers/Microsoft.DBforMySQL/locations/:locationName/capabilitiesGet capabilities at specified location in a given subscription.

CheckVirtualNetworkSubnetUsage

  • POSTCheckVirtualNetworkSubnetUsage_Execute/subscriptions/:subscriptionId/providers/Microsoft.DBforMySQL/locations/:locationName/checkVirtualNetworkSubnetUsageGet virtual network subnet usage for a given vNet resource id.

CheckNameAvailability

  • POSTCheckNameAvailability_Execute/subscriptions/:subscriptionId/providers/Microsoft.DBforMySQL/locations/:locationName/checkNameAvailabilityCheck the availability of name for server
  • POSTCheckNameAvailabilityWithoutLocation_Execute/subscriptions/:subscriptionId/providers/Microsoft.DBforMySQL/checkNameAvailabilityCheck the availability of name for server

GetPrivateDnsZoneSuffix

  • POSTGetPrivateDnsZoneSuffix_Execute/providers/Microsoft.DBforMySQL/getPrivateDnsZoneSuffixGet private DNS zone suffix in the cloud.

Operations

  • GETOperations_List/providers/Microsoft.DBforMySQL/operationsLists all of the available REST API operations.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
31 operations on 23 pathsGET 14POST 9PUT 3DELETE 3PATCH 2
Main resources
Servers 7Configurations 4Databases 4FirewallRules 4Backups 2CheckNameAvailability 2CheckVirtualNetworkSubnetUsage 1GetPrivateDnsZoneSuffix 1LocationBasedCapabilities 1Operations 1
Response formats
application/json
Description format
Swagger 2.0, API version 2021-05-01

How to test the Azure Database for MySQL 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 Database for MySQL 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 “Servers_Get” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforMySQL/flexibleServers/:serverName), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Database for MySQL?

The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall… It is listed under Data & analytics and has 31 endpoints.

Who publishes the Azure Database for MySQL?

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 Database for MySQL?

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

How do I authenticate with the Azure Database for MySQL?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Database for MySQL have?

31 operations on 23 paths (14 GET, 9 POST, 3 PUT, 3 DELETE, 2 PATCH). The largest groups are Servers, Configurations, Databases, FirewallRules.

Is forking the Azure Database for MySQL 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.