Microsoft Azure

Azure Postgresqlhsc

Azure Cosmos DB for PostgreSQL database service resource provider REST APIs

Developer tools#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

Azure Cosmos DB for PostgreSQL database service resource provider REST APIs

Endpoints 35

Clusters

  • GETClusters_List/subscriptions/:subscriptionId/providers/Microsoft.DBforPostgreSQL/serverGroupsv2Lists all clusters in a subscription.
  • GETClusters_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2Lists all clusters in a resource group.
  • GETClusters_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterNameGets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.
  • PUTClusters_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterNameCreates a new cluster with servers.
  • DELETEClusters_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterNameDeletes a cluster together with servers in it.
  • PATCHClusters_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterNameUpdates an existing cluster. The request body can contain one or several properties from the cluster definition.
  • POSTClusters_CheckNameAvailability/subscriptions/:subscriptionId/providers/Microsoft.DBforPostgreSQL/checkNameAvailabilityChecks availability of a cluster name. Cluster names should be globally unique; at least 3 characters and at most 40 characters long; they must only contain…

Servers

  • GETServers_ListByCluster/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/serversLists servers of a cluster.
  • GETServers_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/servers/:serverNameGets information about a server in cluster.

Configurations

  • GETConfigurations_ListByServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/servers/:serverName/configurationsList all the configurations of a server in cluster.
  • GETConfigurations_ListByCluster/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/configurationsList all the configurations of a cluster.
  • GETConfigurations_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/configurations/:configurationNameGets information of a configuration for coordinator and nodes.
  • GETConfigurations_GetCoordinator/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/coordinatorConfigurations/:configurationNameGets information of a configuration for coordinator.
  • PUTConfigurations_UpdateOnCoordinator/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/coordinatorConfigurations/:configurationNameUpdates configuration of coordinator in a cluster
  • GETConfigurations_GetNode/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/nodeConfigurations/:configurationNameGets information of a configuration for worker nodes.
  • PUTConfigurations_UpdateOnNode/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/nodeConfigurations/:configurationNameUpdates configuration of worker nodes in a cluster

FirewallRules

  • GETFirewallRules_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/firewallRules/:firewallRuleNameGets information about a cluster firewall rule.
  • PUTFirewallRules_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/firewallRules/:firewallRuleNameCreates a new cluster firewall rule or updates an existing cluster firewall rule.
  • DELETEFirewallRules_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/firewallRules/:firewallRuleNameDeletes a cluster firewall rule.
  • GETFirewallRules_ListByCluster/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/firewallRulesLists all the firewall rules on cluster.

Roles

  • GETRoles_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/roles/:roleNameGets information about a cluster role.
  • PUTRoles_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/roles/:roleNameCreates a new role or updates an existing role.
  • DELETERoles_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/roles/:roleNameDeletes a cluster role.
  • GETRoles_ListByCluster/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/rolesList all the roles in a given cluster.

ClusterOperations

  • POSTClusters_Restart/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/restartRestarts all nodes in the cluster.
  • POSTClusters_Start/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/startStarts stopped compute on all cluster nodes.
  • POSTClusters_Stop/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/stopStops compute on all cluster nodes.
  • POSTClusters_PromoteReadReplica/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/promotePromotes read replica cluster to an independent read-write cluster.

Operations

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

PrivateEndpointConnections

  • GETPrivateEndpointConnections_ListByCluster/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/privateEndpointConnectionsGets list of private endpoint connections on a cluster.
  • GETPrivateEndpointConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/privateEndpointConnections/:privateEndpointConnectionNameGets private endpoint connection.
  • PUTPrivateEndpointConnections_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/privateEndpointConnections/:privateEndpointConnectionNameApproves or Rejects a private endpoint connection with a given name.
  • DELETEPrivateEndpointConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/privateEndpointConnections/:privateEndpointConnectionNameDeletes a private endpoint connection with a given name.

PrivateLinkResources

  • GETPrivateLinkResources_ListByCluster/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/privateLinkResourcesGets the private link resources for cluster.
  • GETPrivateLinkResources_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/:clusterName/privateLinkResources/:privateLinkResourceNameGets a private link resource for cluster.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
35 operations on 24 pathsGET 19PUT 6POST 5DELETE 4PATCH 1
Main resources
Clusters 7Configurations 7ClusterOperations 4FirewallRules 4PrivateEndpointConnections 4Roles 4PrivateLinkResources 2Servers 2Operations 1
Response formats
application/json
Description format
Swagger 2.0, API version 2022-11-08

How to test the Azure Postgresqlhsc 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 Postgresqlhsc 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 “Clusters_List” (GET /subscriptions/:subscriptionId/providers/Microsoft.DBforPostgreSQL/serverGroupsv2), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Postgresqlhsc?

Azure Cosmos DB for PostgreSQL database service resource provider REST APIs It is listed under Developer tools and has 35 endpoints.

Who publishes the Azure Postgresqlhsc?

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

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

How do I authenticate with the Azure Postgresqlhsc?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Postgresqlhsc have?

35 operations on 24 paths (19 GET, 6 PUT, 5 POST, 4 DELETE, 1 PATCH). The largest groups are Clusters, Configurations, ClusterOperations, FirewallRules.

Is forking the Azure Postgresqlhsc 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.