{ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", "version": "2026-10-01", "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.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Operations" }, { "name": "AdministratorMicrosoftEntras" }, { "name": "Migrations" }, { "name": "Servers" }, { "name": "AdvancedThreatProtectionSettingsModels" }, { "name": "BackupAutomaticAndOnDemands" }, { "name": "Configurations" }, { "name": "Databases" }, { "name": "FirewallRules" }, { "name": "BackupsLongTermRetentionOperations" }, { "name": "PrivateEndpointConnections" }, { "name": "PrivateLinkResources" }, { "name": "TuningOptionsOperationGroup" }, { "name": "VirtualEndpoints" }, { "name": "MaintenanceEvents" }, { "name": "MajorVersionUpgradePrecheck" } ], "paths": { "/providers/Microsoft.DBforPostgreSQL/getPrivateDnsZoneSuffix": { "post": { "operationId": "PrivateDnsZoneSuffix_Get", "description": "Gets the private DNS zone suffix.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PrivateDnsZoneSuffix" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get the private DNS suffix.": { "$ref": "./examples/PrivateDnsZoneSuffixGet.json" } } } }, "/providers/Microsoft.DBforPostgreSQL/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "Lists all available REST API operations.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OperationList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all available REST API operations.": { "$ref": "./examples/OperationsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability": { "post": { "operationId": "NameAvailability_CheckGlobally", "description": "Checks the validity and availability of the given name, to assign it to a new server or to use it as the base name of a new pair of virtual endpoints.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "parameters", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/CheckNameAvailabilityRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/NameAvailabilityModel" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Check the validity and availability of the given name, to assign it to a new server or to use it as the base name of a new pair of virtual endpoints.": { "$ref": "./examples/NameAvailabilityCheckGlobally.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/flexibleServers": { "get": { "operationId": "Servers_ListBySubscription", "tags": [ "Servers" ], "description": "Lists all servers in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ServerList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all servers in a subscription.": { "$ref": "./examples/ServersListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/capabilities": { "get": { "operationId": "CapabilitiesByLocation_List", "description": "Lists the capabilities available in a given location for a specific subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "locationName", "in": "path", "description": "The name of the location.", "required": true, "type": "string", "minLength": 1, "pattern": "^[-\\w\\._]+$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/CapabilityList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List the capabilities available in a given location for a specific subscription.": { "$ref": "./examples/CapabilitiesByLocationList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/checkNameAvailability": { "post": { "operationId": "NameAvailability_CheckWithLocation", "description": "Check the availability of name for resource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "locationName", "in": "path", "description": "The name of the location.", "required": true, "type": "string", "minLength": 1, "pattern": "^[-\\w\\._]+$" }, { "name": "parameters", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/CheckNameAvailabilityRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/NameAvailabilityModel" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Check the validity and availability of the given name, in the given location, to assign it to a new server or to use it as the base name of a new pair of virtual endpoints": { "$ref": "./examples/NameAvailabilityCheckWithLocation.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/checkVirtualNetworkSubnetUsage": { "post": { "operationId": "VirtualNetworkSubnetUsage_List", "description": "Lists the virtual network subnet usage for a given virtual network.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "locationName", "in": "path", "description": "The name of the location.", "required": true, "type": "string", "minLength": 1, "pattern": "^[-\\w\\._]+$" }, { "name": "parameters", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "#/definitions/VirtualNetworkSubnetUsageParameter" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/VirtualNetworkSubnetUsageModel" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List the virtual network subnet usage for a given virtual network.": { "$ref": "./examples/VirtualNetworkSubnetUsageList.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/resourceType/flexibleServers/usages": { "get": { "operationId": "QuotaUsages_List", "description": "Get quota usages at specified location in a given subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "locationName", "in": "path", "description": "The name of the location.", "required": true, "type": "string", "minLength": 1, "pattern": "^[-\\w\\._]+$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/QuotaUsageList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List of quota usages for servers": { "$ref": "./examples/QuotaUsagesForFlexibleServers.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers": { "get": { "operationId": "Servers_ListByResourceGroup", "tags": [ "Servers" ], "description": "Lists all servers in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ServerList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all servers in a resource group.": { "$ref": "./examples/ServersListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}": { "get": { "operationId": "Servers_Get", "tags": [ "Servers" ], "description": "Gets information about an existing server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Server" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get information about an existing server that is integrated into a virtual network provided by customer.": { "$ref": "./examples/ServersGetWithVnet.json" }, "Get information about an existing server that isn't integrated into a virtual network provided by customer and has private endpoint connections.": { "$ref": "./examples/ServersGetWithPrivateEndpoints.json" }, "Get information about an existing server.": { "$ref": "./examples/ServersGet.json" } } }, "put": { "operationId": "Servers_CreateOrUpdate", "tags": [ "Servers" ], "description": "Creates a new server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "parameters", "in": "body", "description": "Parameters required to create a new server or to update an existing server.", "required": true, "schema": { "$ref": "#/definitions/Server" } } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a new elastic cluster.": { "$ref": "./examples/ServersClusterCreate.json" }, "Create a new server in Microsoft owned virtual network with zone redundant high availability.": { "$ref": "./examples/ServersCreateInMicrosoftOwnedVirtualNetworkWithZoneRedundantHighAvailability.json" }, "Create a new server in your own virtual network with same zone high availability.": { "$ref": "./examples/ServersCreateInYourOwnVirtualNetworkWithSameZoneHighAvailability.json" }, "Create a new server using a backup of a server that was deleted or dropped recently.": { "$ref": "./examples/ServersCreateReviveDropped.json" }, "Create a new server using a point in time restore of a backup of an existing server.": { "$ref": "./examples/ServersCreatePointInTimeRestore.json" }, "Create a new server using a restore of a geographically redundant backup of an existing server, with data encryption based on customer managed key with automatic key version update.": { "$ref": "./examples/ServersCreateGeoRestoreWithDataEncryptionEnabledAutoUpdate.json" }, "Create a new server using a restore of a geographically redundant backup of an existing server, with data encryption based on customer managed key.": { "$ref": "./examples/ServersCreateGeoRestoreWithDataEncryptionEnabled.json" }, "Create a new server with Microsoft Entra authentication enabled in your own virtual network and without high availability.": { "$ref": "./examples/ServersCreateWithMicrosoftEntraEnabledInYourOwnVirtualNetworkWithoutHighAvailability.json" }, "Create a new server with data encryption based on customer managed key with automatic key version update.": { "$ref": "./examples/ServersCreateWithDataEncryptionEnabledAutoUpdate.json" }, "Create a new server with data encryption based on customer managed key.": { "$ref": "./examples/ServersCreateWithDataEncryptionEnabled.json" }, "Create a read replica of an existing server.": { "$ref": "./examples/ServersCreateReplica.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Server" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Servers_Update", "tags": [ "Servers" ], "description": "Updates an existing server. The request body can contain one or multiple of the properties present in the normal server definition.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "parameters", "in": "body", "description": "Parameters required to update a server.", "required": true, "schema": { "$ref": "#/definitions/ServerForPatch" } } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Enable or disable FIPS mode on an existing server.": { "$ref": "./examples/ServersUpdateFIPS.json" }, "Promote a read replica to a standalone server with forced data synchronization. Meaning that it doesn't wait for data in the read replica to be synchronized with its source server before it initiates the promotion to a standalone server.": { "$ref": "./examples/ServersPromoteReplicaAsForcedStandaloneServer.json" }, "Promote a read replica to a standalone server with planned data synchronization. Meaning that it waits for data in the read replica to be fully synchronized with its source server before it initiates the promotion to a standalone server.": { "$ref": "./examples/ServersPromoteReplicaAsPlannedStandaloneServer.json" }, "Switch over a read replica to primary server with forced data synchronization. Meaning that it doesn't wait for data in the read replica to be synchronized with its source server before it initiates the switching of roles between the read replica and the primary server.": { "$ref": "./examples/ServersPromoteReplicaAsForcedSwitchover.json" }, "Switch over a read replica to primary server with planned data synchronization. Meaning that it waits for data in the read replica to be fully synchronized with its source server before it initiates the switching of roles between the read replica and the primary server.": { "$ref": "./examples/ServersPromoteReplicaAsPlannedSwitchover.json" }, "Update an existing server to upgrade the major version of PostgreSQL database engine.": { "$ref": "./examples/ServersUpdateWithMajorVersionUpgrade.json" }, "Update an existing server with Microsoft Entra authentication enabled.": { "$ref": "./examples/ServersUpdateWithMicrosoftEntraEnabled.json" }, "Update an existing server with custom maintenance window.": { "$ref": "./examples/ServersUpdateWithCustomMaintenanceWindow.json" }, "Update an existing server with data encryption based on customer managed key with automatic key version update.": { "$ref": "./examples/ServersUpdateWithDataEncryptionEnabledAutoUpdate.json" }, "Update an existing server with data encryption based on customer managed key.": { "$ref": "./examples/ServersUpdateWithDataEncryptionEnabled.json" }, "Update an existing server.": { "$ref": "./examples/ServersUpdate.json" }, "Update the storage performance of a server using Premium SSD v2.": { "$ref": "./examples/ServersUpdateWithPremiumSsdV2.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Server" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Servers_Delete", "tags": [ "Servers" ], "description": "Deletes or drops an existing server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete or drop an existing server.": { "$ref": "./examples/ServersDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators": { "get": { "operationId": "AdministratorsMicrosoftEntra_ListByServer", "tags": [ "AdministratorMicrosoftEntras" ], "description": "List all server administrators associated to a Microsoft Entra principal.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AdministratorMicrosoftEntraList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List information about all server administrators associated to Microsoft Entra principals.": { "$ref": "./examples/AdministratorsMicrosoftEntraListByServer.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators/{objectId}": { "get": { "operationId": "AdministratorsMicrosoftEntra_Get", "tags": [ "AdministratorMicrosoftEntras" ], "description": "Gets information about a server administrator associated to a Microsoft Entra principal.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "objectId", "in": "path", "description": "Object identifier of the Microsoft Entra principal.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AdministratorMicrosoftEntra" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get information about a server administrator associated to a Microsoft Entra principal.": { "$ref": "./examples/AdministratorsMicrosoftEntraGet.json" } } }, "put": { "operationId": "AdministratorsMicrosoftEntra_CreateOrUpdate", "tags": [ "AdministratorMicrosoftEntras" ], "description": "Creates a new server administrator associated to a Microsoft Entra principal.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "objectId", "in": "path", "description": "Object identifier of the Microsoft Entra principal.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Required parameters for adding a server administrator associated to a Microsoft Entra principal.", "required": true, "schema": { "$ref": "#/definitions/AdministratorMicrosoftEntraAdd" } } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Add a server administrator associated to a Microsoft Entra principal.": { "$ref": "./examples/AdministratorsMicrosoftEntraAdd.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/AdministratorMicrosoftEntra" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "AdministratorsMicrosoftEntra_Delete", "tags": [ "AdministratorMicrosoftEntras" ], "description": "Deletes an existing server administrator associated to a Microsoft Entra principal.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "objectId", "in": "path", "description": "Object identifier of the Microsoft Entra principal.", "required": true, "type": "string" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a server administrator associated to a Microsoft Entra principal.": { "$ref": "./examples/AdministratorsMicrosoftEntraDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings": { "get": { "operationId": "AdvancedThreatProtectionSettings_ListByServer", "tags": [ "AdvancedThreatProtectionSettingsModels" ], "description": "Lists state of advanced threat protection settings for a server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AdvancedThreatProtectionSettingsList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List state of advanced threat protection settings for a server.": { "$ref": "./examples/AdvancedThreatProtectionSettingsListByServer.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{threatProtectionName}": { "get": { "operationId": "AdvancedThreatProtectionSettings_Get", "tags": [ "AdvancedThreatProtectionSettingsModels" ], "description": "Gets state of advanced threat protection settings for a server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "threatProtectionName", "in": "path", "description": "Name of the advanced threat protection settings.", "required": true, "type": "string", "enum": [ "Default" ], "x-ms-enum": { "name": "ThreatProtectionName", "modelAsString": true, "values": [ { "name": "Default", "value": "Default", "description": "Default advanced threat protection settings." } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AdvancedThreatProtectionSettingsModel" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get state of advanced threat protection settings for a server.": { "$ref": "./examples/AdvancedThreatProtectionSettingsGet.json" } } }, "put": { "operationId": "ServerThreatProtectionSettings_CreateOrUpdate", "tags": [ "AdvancedThreatProtectionSettingsModels" ], "description": "Creates or updates a server's Advanced Threat Protection settings.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "threatProtectionName", "in": "path", "description": "Name of the advanced threat protection settings.", "required": true, "type": "string", "enum": [ "Default" ], "x-ms-enum": { "name": "ThreatProtectionName", "modelAsString": true, "values": [ { "name": "Default", "value": "Default", "description": "Default advanced threat protection settings." } ] } }, { "name": "parameters", "in": "body", "description": "The Advanced Threat Protection state for the server.", "required": true, "schema": { "$ref": "#/definitions/AdvancedThreatProtectionSettingsModel" } } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update the advanced threat protection settings of a server.": { "$ref": "./examples/AdvancedThreatProtectionSettingsCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/AdvancedThreatProtectionSettingsModel" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/backups": { "get": { "operationId": "BackupsAutomaticAndOnDemand_ListByServer", "tags": [ "BackupAutomaticAndOnDemands" ], "description": "Lists all available backups of a server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BackupAutomaticAndOnDemandList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all available backups of a server.": { "$ref": "./examples/BackupsAutomaticAndOnDemandListByServer.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/backups/{backupName}": { "get": { "operationId": "BackupsAutomaticAndOnDemand_Get", "tags": [ "BackupAutomaticAndOnDemands" ], "description": "Gets information of an on demand backup, given its name.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "backupName", "in": "path", "description": "Name of the backup.", "required": true, "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[-\\w\\._]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BackupAutomaticAndOnDemand" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get an on demand backup, given its name.": { "$ref": "./examples/BackupsAutomaticAndOnDemandGet.json" } } }, "put": { "operationId": "BackupsAutomaticAndOnDemand_Create", "tags": [ "BackupAutomaticAndOnDemands" ], "description": "Creates an on demand backup of a server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "backupName", "in": "path", "description": "Name of the backup.", "required": true, "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[-\\w\\._]+$" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create an on demand backup of a server.": { "$ref": "./examples/BackupsAutomaticAndOnDemandCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/BackupAutomaticAndOnDemand" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "BackupsAutomaticAndOnDemand_Delete", "tags": [ "BackupAutomaticAndOnDemands" ], "description": "Deletes a specific backup, given its name.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "backupName", "in": "path", "description": "Name of the backup.", "required": true, "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[-\\w\\._]+$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete an on demand backup, given its name.": { "$ref": "./examples/BackupsAutomaticAndOnDemandDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/capabilities": { "get": { "operationId": "CapabilitiesByServer_List", "tags": [ "Servers" ], "description": "Lists the capabilities available for a given server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CapabilityList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List the capabilities available for a given server.": { "$ref": "./examples/CapabilitiesByServerList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/checkMigrationNameAvailability": { "post": { "operationId": "Migrations_CheckNameAvailability", "tags": [ "Servers" ], "summary": "Check the validity and availability of the given name, to assign it to a new migration.", "description": "Checks if a proposed migration name is valid and available.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "parameters", "in": "body", "description": "Parameters required to check if a migration name is valid and available.", "required": true, "schema": { "$ref": "#/definitions/MigrationNameAvailability" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrationNameAvailability" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Check the validity and availability of the given name, to assign it to a new migration.": { "$ref": "./examples/MigrationsCheckNameAvailability.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations": { "get": { "operationId": "Configurations_ListByServer", "tags": [ "Configurations" ], "description": "Lists all configurations (also known as server parameters) of a server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConfigurationList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all configurations (also known as server parameters) of a server.": { "$ref": "./examples/ConfigurationsListByServer.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}": { "get": { "operationId": "Configurations_Get", "tags": [ "Configurations" ], "description": "Gets information about a specific configuration (also known as server parameter) of a server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "configurationName", "in": "path", "description": "Name of the configuration (also known as server parameter).", "required": true, "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[-\\w\\._]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Configuration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get information about a specific configuration (also known as server parameter) of a server.": { "$ref": "./examples/ConfigurationsGet.json" } } }, "put": { "operationId": "Configurations_Put", "tags": [ "Configurations" ], "description": "Updates, using Put verb, the value assigned to a specific modifiable configuration (also known as server parameter) of a server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "configurationName", "in": "path", "description": "Name of the configuration (also known as server parameter).", "required": true, "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[-\\w\\._]+$" }, { "name": "parameters", "in": "body", "description": "Parameters required to update the value of a specific modifiable configuration (also known as server parameter).", "required": true, "schema": { "$ref": "#/definitions/ConfigurationForUpdate" } } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update, using Put verb, the value assigned to a specific modifiable configuration (also known as server parameter) of a server.": { "$ref": "./examples/ConfigurationsUpdateUsingPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Configuration" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Configurations_Update", "tags": [ "Configurations" ], "description": "Updates the value assigned to a specific modifiable configuration (also known as server parameter) of a server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "configurationName", "in": "path", "description": "Name of the configuration (also known as server parameter).", "required": true, "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[-\\w\\._]+$" }, { "name": "parameters", "in": "body", "description": "Parameters required to update the value of a specific modifiable configuration (also known as server parameter).", "required": true, "schema": { "$ref": "#/definitions/ConfigurationForUpdate" } } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update the value assigned to a specific modifiable configuration (also known as server parameter) of a server.": { "$ref": "./examples/ConfigurationsUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Configuration" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases": { "get": { "operationId": "Databases_ListByServer", "tags": [ "Databases" ], "description": "Lists all databases in a server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatabaseList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all databases in a server.": { "$ref": "./examples/DatabasesListByServer.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName}": { "get": { "operationId": "Databases_Get", "tags": [ "Databases" ], "description": "Gets information about an existing database.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "databaseName", "in": "path", "description": "Name of the database (case-sensitive). Exact database names can be retrieved by getting the list of all existing databases in a server.", "required": true, "type": "string", "minLength": 1, "maxLength": 63, "pattern": "^[a-zA-Z_][\\w\\-]{0,62}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Database" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get information about an existing database.": { "$ref": "./examples/DatabasesGet.json" } } }, "put": { "operationId": "Databases_Create", "tags": [ "Databases" ], "description": "Creates a new database.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "databaseName", "in": "path", "description": "Name of the database (case-sensitive). Exact database names can be retrieved by getting the list of all existing databases in a server.", "required": true, "type": "string", "minLength": 1, "maxLength": 63, "pattern": "^[a-zA-Z_][\\w\\-]{0,62}$" }, { "name": "parameters", "in": "body", "description": "Parameters required to create a new database.", "required": true, "schema": { "$ref": "#/definitions/Database" } } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a database.": { "$ref": "./examples/DatabasesCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Database" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Databases_Delete", "tags": [ "Databases" ], "description": "Deletes an existing database.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "databaseName", "in": "path", "description": "Name of the database (case-sensitive). Exact database names can be retrieved by getting the list of all existing databases in a server.", "required": true, "type": "string", "minLength": 1, "maxLength": 63, "pattern": "^[a-zA-Z_][\\w\\-]{0,62}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete an existing database": { "$ref": "./examples/DatabasesDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules": { "get": { "operationId": "FirewallRules_ListByServer", "tags": [ "FirewallRules" ], "description": "Lists information about all firewall rules in a server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/FirewallRuleList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List information about all firewall rules in a server.": { "$ref": "./examples/FirewallRulesListByServer.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}": { "get": { "operationId": "FirewallRules_Get", "tags": [ "FirewallRules" ], "description": "Gets information about a firewall rule in a server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, { "name": "firewallRuleName", "in": "path", "description": "Name of the firewall rule.", "required": true, "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9][-_a-zA-Z0-9]{0,79}(?