Microsoft Azure

Azure Database for PostgreSQL

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

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 PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.

Endpoints 21

Servers

  • GETServers_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverNameGets information about a server.
  • PUTServers_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverNameCreates a new server.
  • DELETEServers_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/:serverNameDeletes a server.
  • PATCHServers_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/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.DBforPostgreSQL/flexibleServersList all the servers in a given resource group.
  • GETServers_List/subscriptions/:subscriptionId/providers/Microsoft.DBforPostgreSQL/flexibleServersList all the servers in a given subscription.

ServerRestart

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

ServerStart

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

ServerStop

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

FirewallRules

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

Configurations

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

CheckNameAvailability

  • POSTCheckNameAvailability_Execute/subscriptions/:subscriptionId/providers/Microsoft.DBforPostgreSQL/checkNameAvailabilityCheck the availability of name for resource

LocationBasedCapabilities

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

VirtualNetworkSubnetUsage

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

Operations

  • GETOperations_List/providers/Microsoft.DBforPostgreSQL/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
21 operations on 14 pathsGET 9POST 5PUT 3PATCH 2DELETE 2
Main resources
Servers 6Configurations 4FirewallRules 4CheckNameAvailability 1LocationBasedCapabilities 1Operations 1ServerRestart 1ServerStart 1ServerStop 1VirtualNetworkSubnetUsage 1
Response formats
application/json
Description format
Swagger 2.0, API version 2021-06-01

How to test the Azure Database for PostgreSQL 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 PostgreSQL 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.DBforPostgreSQL/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 PostgreSQL?

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

Who publishes the Azure Database for PostgreSQL?

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 PostgreSQL?

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

How do I authenticate with the Azure Database for PostgreSQL?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Database for PostgreSQL have?

21 operations on 14 paths (9 GET, 5 POST, 3 PUT, 2 PATCH, 2 DELETE). The largest groups are Servers, Configurations, FirewallRules, CheckNameAvailability.

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