{ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2024-08-01" }, "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": "Microsoft Entra OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" ], "operationId": "FirewallRules_CreateOrUpdate", "x-ms-examples": { "Create a new firewall rule or update an existing firewall rule.": { "$ref": "./examples/FirewallRuleCreate.json" } }, "description": "Creates a new firewall rule or updates an existing firewall rule.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./types/common-types.json#/parameters/ServerNameParameter" }, { "$ref": "#/parameters/FirewallRuleNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/FirewallRule" }, "description": "Parameters required for creating or updating a firewall rule." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FirewallRule" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/FirewallRule" } }, "202": { "description": "Accepted", "headers": { "Location": { "type": "string" } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "delete": { "tags": [ "FirewallRules" ], "operationId": "FirewallRules_Delete", "x-ms-examples": { "Delete an existing firewall rule.": { "$ref": "./examples/FirewallRuleDelete.json" } }, "description": "Deletes an existing firewall rule.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./types/common-types.json#/parameters/ServerNameParameter" }, { "$ref": "#/parameters/FirewallRuleNameParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted", "headers": { "Location": { "type": "string" } } }, "204": { "description": "NoContent" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "FirewallRules" ], "operationId": "FirewallRules_Get", "x-ms-examples": { "Get information about a firewall rule in a flexible server.": { "$ref": "./examples/FirewallRuleGet.json" } }, "description": "Gets information about a firewall rule in a flexible server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./types/common-types.json#/parameters/ServerNameParameter" }, { "$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/v5/types.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" ], "operationId": "FirewallRules_ListByServer", "x-ms-examples": { "List information about all firewall rules in a flexible server.": { "$ref": "./examples/FirewallRuleListByServer.json" } }, "description": "Lists information about all firewall rules in a flexible server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./types/common-types.json#/parameters/ServerNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FirewallRuleListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "FirewallRuleProperties": { "type": "object", "properties": { "startIpAddress": { "type": "string", "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", "description": "IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format." }, "endIpAddress": { "type": "string", "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", "description": "IP address defining the end of the range of addresses of a firewall rule. Must be expressed in IPv4 format." } }, "required": [ "startIpAddress", "endIpAddress" ], "description": "Properties of a firewall rule." }, "FirewallRule": { "type": "object", "properties": { "properties": { "$ref": "#/definitions/FirewallRuleProperties", "x-ms-client-flatten": true, "description": "Properties of a firewall rule." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ], "required": [ "properties" ], "description": "Firewall rule." }, "FirewallRuleListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/FirewallRule" }, "description": "List of firewall rules in a flexible server." }, "nextLink": { "description": "Link to retrieve next page of results.", "type": "string" } }, "description": "List of firewall rules." } }, "parameters": { "FirewallRuleNameParameter": { "name": "firewallRuleName", "in": "path", "required": true, "type": "string", "description": "Name of the firewall rule.", "minLength": 1, "pattern": "^[-\\w\\._]+$", "x-ms-parameter-location": "method" } } }