Microsoft Azure Cosmos DB for PostgreSQL is a globally distributed, multi-model database service that allows users to store and manage data at a massive scale across geographic regions. It provides high availability and low latency for read and write operations, ensuring consistent performance for applications that require real-time data access.
swagger: '2.0'
info:
title: Microsoft Azure Azure Cosmos DB for PostgreSQL
description: Azure Cosmos DB for PostgreSQL database service resource provider REST APIs
version: 2023-03-02-preview
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- azure_auth:
- user_impersonation
securityDefinitions:
azure_auth:
type: oauth2
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
flow: implicit
description: Azure Active Directory OAuth2 Flow
scopes:
user_impersonation: Impersonate your user account.
paths:
/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2:
get:
tags:
- Clusters
operationId: microsoftAzureClustersList
x-ms-examples:
List all the clusters:
$ref: ./examples/ClusterList.json
description: Lists all clusters in a subscription.
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ClusterListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Dbforpostgresql Servergroupsv2
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2:
get:
tags:
- Clusters
operationId: microsoftAzureClustersListbyresourcegroup
x-ms-examples:
List the clusters by resource group:
$ref: ./examples/ClusterListByResourceGroup.json
description: Lists all clusters in a resource group.
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ClusterListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
: put:
description: Creates a new cluster with servers.
tags:
- Clusters
operationId: microsoftAzureClustersCreate
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
Create a new single node cluster:
$ref: ./examples/ClusterCreateSingleNode.json
Create a new multi-node cluster:
$ref: ./examples/ClusterCreateMultiNode.json
Create a new single node Burstable 1 vCore cluster:
$ref: ./examples/ClusterCreateBurstablev1.json
Create a new single node Burstable 2 vCores cluster:
$ref: ./examples/ClusterCreateBurstablev2.json
Create a new cluster as a point in time restore:
$ref: ./examples/ClusterCreatePITR.json
Create a new cluster as a read replica:
$ref: ./examples/ClusterCreateReadReplica.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/Cluster'
description: The required parameters for creating or updating a cluster.
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Cluster'
'201':
description: Created
headers:
location:
type: string
azure-async-operation:
type: string
schema:
$ref: '#/definitions/Cluster'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername
get:
description: >-
Gets information about a cluster such as compute and storage
configuration and cluster lifecycle metadata such as cluster creation
date and time.
tags:
- Clusters
operationId: microsoftAzureClustersGet
x-ms-examples:
Get the cluster:
$ref: ./examples/ClusterGet.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Cluster'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername
delete:
description: Deletes a cluster together with servers in it.
tags:
- Clusters
operationId: microsoftAzureClustersDelete
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Delete the cluster:
$ref: ./examples/ClusterDelete.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
responses:
'200':
description: OK
'202':
description: Accepted
headers:
location:
type: string
azure-async-operation:
type: string
'204':
description: NoContent
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername
patch:
description: >-
Updates an existing cluster. The request body can contain one or several
properties from the cluster definition.
tags:
- Clusters
operationId: microsoftAzureClustersUpdate
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Update multiple configuration settings of the cluster:
$ref: ./examples/ClusterUpdate.json
Scale compute up or down:
$ref: ./examples/ClusterScaleCompute.json
Scale up storage:
$ref: ./examples/ClusterScaleStorage.json
'Scale out: Add new worker nodes':
$ref: ./examples/ClusterAddNode.json
Update or define maintenance window:
$ref: ./examples/ClusterUpdateMaintenanceWindow.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/ClusterForUpdate'
description: The parameters for updating a cluster.
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Cluster'
'202':
description: Accepted
headers:
location:
type: string
azure-async-operation:
type: string
schema:
$ref: '#/definitions/Cluster'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/servers
: get:
description: Lists servers of a cluster.
tags:
- Servers
operationId: microsoftAzureServersListbycluster
x-ms-examples:
List servers of the cluster:
$ref: ./examples/ServerListByCluster.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ClusterServerListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName:
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Servers
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/servers/{serverName}
: get:
description: Gets information about a server in cluster.
tags:
- Servers
operationId: microsoftAzureServersGet
x-ms-examples:
Get the server of cluster:
$ref: ./examples/ServerGet.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/ServerNameParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ClusterServer'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Servers Servername
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/servers/{serverName}/configurations
: get:
description: List all the configurations of a server in cluster.
tags:
- Configurations
operationId: microsoftAzureConfigurationsListbyserver
x-ms-examples:
List configurations of the server that in the cluster:
$ref: ./examples/ConfigurationListByServer.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/ServerNameParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ServerConfigurationListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Servers Servername Configurations
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/configurations
: get:
description: List all the configurations of a cluster.
tags:
- Configurations
operationId: microsoftAzureConfigurationsListbycluster
x-ms-examples:
List configurations of the cluster:
$ref: ./examples/ConfigurationListByCluster.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ClusterConfigurationListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Configurations
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/configurations/{configurationName}
: get:
description: Gets information of a configuration for coordinator and nodes.
tags:
- Configurations
operationId: microsoftAzureConfigurationsGet
x-ms-examples:
Get configuration details.:
$ref: ./examples/ConfigurationGet.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/ConfigurationNameParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Configuration'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Configurations Configurationname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/coordinatorConfigurations/{configurationName}
: get:
description: Gets information of a configuration for coordinator.
tags:
- Configurations
operationId: microsoftAzureConfigurationsGetcoordinator
x-ms-examples:
Get configuration details for coordinator.:
$ref: ./examples/ConfigurationGetCoordinator.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/ConfigurationNameParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ServerConfiguration'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Coordinatorconfigurations Configurationname
put:
description: Updates configuration of coordinator in a cluster
tags:
- Configurations
operationId: microsoftAzureConfigurationsUpdateoncoordinator
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
Update single configuration of coordinator:
$ref: ./examples/ConfigurationUpdateCoordinator.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/ConfigurationNameParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/ServerConfiguration'
description: The required parameters for updating a cluster configuration.
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ServerConfiguration'
'201':
description: Accepted
schema:
$ref: '#/definitions/ServerConfiguration'
headers:
location:
type: string
azure-async-operation:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Coordinatorconfigurations Configurationname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/nodeConfigurations/{configurationName}
: get:
description: Gets information of a configuration for worker nodes.
tags:
- Configurations
operationId: microsoftAzureConfigurationsGetnode
x-ms-examples:
Get configuration details for node.:
$ref: ./examples/ConfigurationGetNode.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/ConfigurationNameParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ServerConfiguration'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Nodeconfigurations Configurationname
put:
description: Updates configuration of worker nodes in a cluster
tags:
- Configurations
operationId: microsoftAzureConfigurationsUpdateonnode
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
Update single configuration of nodes:
$ref: ./examples/ConfigurationUpdateNode.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/ConfigurationNameParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/ServerConfiguration'
description: The required parameters for updating a cluster configuration.
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ServerConfiguration'
'201':
description: Accepted
schema:
$ref: '#/definitions/ServerConfiguration'
headers:
location:
type: string
azure-async-operation:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Nodeconfigurations Configurationname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/firewallRules/{firewallRuleName}
: put:
description: >-
Creates a new cluster firewall rule or updates an existing cluster
firewall rule.
tags:
- FirewallRules
operationId: microsoftAzureFirewallrulesCreateorupdate
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
Create a firewall rule of the cluster:
$ref: ./examples/FirewallRuleCreate.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/FirewallRuleNameParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/FirewallRule'
description: The required parameters for creating or updating a firewall rule.
responses:
'200':
description: OK
schema:
$ref: '#/definitions/FirewallRule'
'201':
description: Accepted
schema:
$ref: '#/definitions/FirewallRule'
headers:
location:
type: string
azure-async-operation:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Firewallrules Firewallrulename
delete:
description: Deletes a cluster firewall rule.
tags:
- FirewallRules
operationId: microsoftAzureFirewallrulesDelete
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Delete the firewall rule of the cluster:
$ref: ./examples/FirewallRuleDelete.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/FirewallRuleNameParameter'
responses:
'202':
description: Accepted
headers:
location:
type: string
azure-async-operation:
type: string
'204':
description: NoContent
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Firewallrules Firewallrulename
get:
description: Gets information about a cluster firewall rule.
tags:
- FirewallRules
operationId: microsoftAzureFirewallrulesGet
x-ms-examples:
Get the firewall rule of the cluster:
$ref: ./examples/FirewallRuleGet.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
- $ref: '#/parameters/FirewallRuleNameParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/FirewallRule'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Firewallrules Firewallrulename
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/firewallRules
: get:
description: Lists all the firewall rules on cluster.
tags:
- FirewallRules
operationId: microsoftAzureFirewallrulesListbycluster
x-ms-examples:
List firewall rules of the cluster:
$ref: ./examples/FirewallRuleListByCluster.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ClusterNameParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/FirewallRuleListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName:
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Firewallrules
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/roles/{roleName}
: get:
description: Gets information about a cluster role.
tags:
- Roles
operationId: microsoftAzureRolesGet
x-ms-examples:
Get the role of the cluster:
$ref: ./examples/RoleGet.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdPa
# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-cosmos-db-for-postgresql-openapi-original.yml