{ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", "version": "2017-12-01-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}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}": { "put": { "tags": [ "Servers" ], "operationId": "Servers_Create", "x-ms-examples": { "Create a new server": { "$ref": "./examples/ServerCreate.json" }, "Create a database as a point in time restore": { "$ref": "./examples/ServerCreatePointInTimeRestore.json" }, "Create a server as a geo restore ": { "$ref": "./examples/ServerCreateGeoRestoreMode.json" }, "Create a replica server": { "$ref": "./examples/ServerCreateReplicaMode.json" } }, "description": "Creates a new server, or will overwrite an existing server.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServerForCreate" }, "description": "The required parameters for creating or updating a server." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Server" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/Server" } }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true }, "patch": { "tags": [ "Servers" ], "operationId": "Servers_Update", "x-ms-examples": { "ServerUpdate": { "$ref": "./examples/ServerUpdate.json" } }, "description": "Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServerUpdateParameters" }, "description": "The required parameters for updating a server." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Server" } }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true }, "delete": { "tags": [ "Servers" ], "operationId": "Servers_Delete", "x-ms-examples": { "ServerDelete": { "$ref": "./examples/ServerDelete.json" } }, "description": "Deletes a server.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "204": { "description": "NoContent" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true }, "get": { "tags": [ "Servers" ], "operationId": "Servers_Get", "x-ms-examples": { "ServerGet": { "$ref": "./examples/ServerGet.json" } }, "description": "Gets information about a server.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Server" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers": { "get": { "tags": [ "Servers" ], "operationId": "Servers_ListByResourceGroup", "x-ms-examples": { "ServerListByResourceGroup": { "$ref": "./examples/ServerListByResourceGroup.json" } }, "description": "List all the servers in a given resource group.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ServerListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/servers": { "get": { "tags": [ "Servers" ], "operationId": "Servers_List", "x-ms-examples": { "ServerList": { "$ref": "./examples/ServerList.json" } }, "description": "List all the servers in a given subscription.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ServerListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/replicas": { "get": { "tags": [ "Replicas" ], "operationId": "Replicas_ListByServer", "x-ms-examples": { "ReplicasListByServer": { "$ref": "./examples/ReplicasListByServer.json" } }, "description": "List all the replicas for a given server.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ServerListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" ], "operationId": "Servers_Restart", "x-ms-examples": { "ServerRestart": { "$ref": "./examples/ServerRestart.json" } }, "description": "Restarts a server.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" ], "operationId": "FirewallRules_CreateOrUpdate", "x-ms-examples": { "FirewallRuleCreate": { "$ref": "./examples/FirewallRuleCreate.json" } }, "description": "Creates a new firewall rule or updates an existing firewall rule.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "$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": "Created", "schema": { "$ref": "#/definitions/FirewallRule" } }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true }, "delete": { "tags": [ "FirewallRules" ], "operationId": "FirewallRules_Delete", "x-ms-examples": { "FirewallRuleDelete": { "$ref": "./examples/FirewallRuleDelete.json" } }, "description": "Deletes a server firewall rule.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "$ref": "#/parameters/FirewallRuleNameParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "204": { "description": "NoContent" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true }, "get": { "tags": [ "FirewallRules" ], "operationId": "FirewallRules_Get", "x-ms-examples": { "FirewallRuleGet": { "$ref": "./examples/FirewallRuleGet.json" } }, "description": "Gets information about a server firewall rule.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "$ref": "#/parameters/FirewallRuleNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FirewallRule" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" ], "operationId": "FirewallRules_ListByServer", "x-ms-examples": { "FirewallRuleList": { "$ref": "./examples/FirewallRuleListByServer.json" } }, "description": "List all the firewall rules in a given server.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FirewallRuleListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" ], "description": "Gets a virtual network rule.", "operationId": "VirtualNetworkRules_Get", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/virtualNetworkRuleNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved a specified virtual network rule.", "schema": { "$ref": "#/definitions/VirtualNetworkRule" } }, "default": { "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." } }, "x-ms-examples": { "Gets a virtual network rule": { "$ref": "./examples/VirtualNetworkRulesGet.json" } } }, "put": { "tags": [ "VirtualNetworkRules" ], "description": "Creates or updates an existing virtual network rule.", "operationId": "VirtualNetworkRules_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/virtualNetworkRuleNameParameter" }, { "name": "parameters", "in": "body", "description": "The requested virtual Network Rule Resource state.", "required": true, "schema": { "$ref": "#/definitions/VirtualNetworkRule" } } ], "responses": { "200": { "description": "Successfully updated a virtual network rule.", "schema": { "$ref": "#/definitions/VirtualNetworkRule" } }, "default": { "description": "*** Error Responses: ***\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 NullVirtualNetworkRequest - Virtual Network Request is Null\n\n * 400 NullVirtualNetworkRequestParameters - Virtual Network Request Parameters are Null\n\n * 400 NullVirtualNetworkSubnetId - The Virtual Network Subnet Id is null\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 VirtualNetworkRuleNotEnabled - Azure SQL Server Virtual Network Rule feature is not enabled\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation." }, "202": { "description": "Accepted" }, "201": { "description": "Successfully created a virtual network rule.", "schema": { "$ref": "#/definitions/VirtualNetworkRule" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Create or update a virtual network rule": { "$ref": "./examples/VirtualNetworkRulesCreateOrUpdate.json" } } }, "delete": { "tags": [ "VirtualNetworkRules" ], "description": "Deletes the virtual network rule with the given name.", "operationId": "VirtualNetworkRules_Delete", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "$ref": "#/parameters/virtualNetworkRuleNameParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted the virtual network rule." }, "default": { "description": "*** Error Responses: ***\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 NullVirtualNetworkRequest - Virtual Network Request is Null\n\n * 400 NullVirtualNetworkRequestParameters - Virtual Network Request Parameters are Null\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation." }, "202": { "description": "Accepted" }, "204": { "description": "The specified virtual network rule does not exist." } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Delete a virtual network rule": { "$ref": "./examples/VirtualNetworkRulesDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" ], "description": "Gets a list of virtual network rules in a server.", "operationId": "VirtualNetworkRules_ListByServer", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved the list of virtual network rules.", "schema": { "$ref": "#/definitions/VirtualNetworkRuleListResult" } }, "default": { "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List virtual network rules": { "$ref": "./examples/VirtualNetworkRulesList.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" ], "operationId": "Databases_CreateOrUpdate", "x-ms-examples": { "DatabaseCreate": { "$ref": "./examples/DatabaseCreate.json" } }, "description": "Creates a new database or updates an existing database.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "$ref": "#/parameters/DatabaseNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Database" }, "description": "The required parameters for creating or updating a database." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Database" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/Database" } }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true }, "delete": { "tags": [ "Databases" ], "operationId": "Databases_Delete", "x-ms-examples": { "DatabaseDelete": { "$ref": "./examples/DatabaseDelete.json" } }, "description": "Deletes a database.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "$ref": "#/parameters/DatabaseNameParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "204": { "description": "NoContent" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true }, "get": { "tags": [ "Databases" ], "operationId": "Databases_Get", "x-ms-examples": { "DatabaseGet": { "$ref": "./examples/DatabaseGet.json" } }, "description": "Gets information about a database.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "$ref": "#/parameters/DatabaseNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Database" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases": { "get": { "tags": [ "Databases" ], "operationId": "Databases_ListByServer", "x-ms-examples": { "DatabaseList": { "$ref": "./examples/DatabaseListByServer.json" } }, "description": "List all the databases in a given server.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DatabaseListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" ], "operationId": "Configurations_CreateOrUpdate", "x-ms-examples": { "ConfigurationCreateOrUpdate": { "$ref": "./examples/ConfigurationCreateOrUpdate.json" } }, "description": "Updates a configuration of a server.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "$ref": "#/parameters/ConfigurationNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Configuration" }, "description": "The required parameters for updating a server configuration." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Configuration" } }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true }, "get": { "tags": [ "Configurations" ], "operationId": "Configurations_Get", "x-ms-examples": { "ConfigurationGet": { "$ref": "./examples/ConfigurationGet.json" } }, "description": "Gets information about a configuration of server.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "$ref": "#/parameters/ConfigurationNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Configuration" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" ], "operationId": "Configurations_ListByServer", "x-ms-examples": { "ConfigurationList": { "$ref": "./examples/ConfigurationListByServer.json" } }, "description": "List all the configurations in a given server.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/updateConfigurations": { "post": { "tags": [ "ConfigurationsUpdate" ], "operationId": "ServerParameters_ListUpdateConfigurations", "x-ms-examples": { "ConfigurationList": { "$ref": "./examples/ConfigurationsUpdateByServer.json" } }, "description": "Update a list of configurations in a given server.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "value", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationListResult" }, "description": "The parameters for updating a list of server configuration." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationListResult" } }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" ], "operationId": "LogFiles_ListByServer", "x-ms-examples": { "LogFileList": { "$ref": "./examples/LogFileListByServer.json" } }, "description": "List all the log files in a given server.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LogFileListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/administrators/activeDirectory": { "get": { "tags": [ "ServerAdministrators" ], "operationId": "ServerAdministrators_Get", "x-ms-examples": { "ServerAdministratorGet": { "$ref": "./examples/ServerAdminGet.json" } }, "description": "Gets information about a AAD server administrator.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ServerAdministratorResource" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "put": { "tags": [ "ServerAdministrators" ], "operationId": "ServerAdministrators_CreateOrUpdate", "x-ms-examples": { "ServerAdministratorCreate": { "$ref": "./examples/ServerAdminCreateUpdate.json" } }, "description": "Creates or update active directory administrator on an existing server. The update action will overwrite the existing administrator.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "properties", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServerAdministratorResource" }, "description": "The required parameters for creating or updating an AAD server administrator." } ], "responses": { "200": { "description": "Successfully updated the active directory administrator", "schema": { "$ref": "#/definitions/ServerAdministratorResource" } }, "202": { "description": "Operation in progress", "schema": { "$ref": "#/definitions/ServerAdministratorResource" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true }, "delete": { "tags": [ "ServerAdministrators" ], "operationId": "ServerAdministrators_Delete", "x-ms-examples": { "ServerAdministratorsDelete": { "$ref": "./examples/ServerAdminDelete.json" } }, "description": "Deletes AAD Administrator.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" } ], "responses": { "200": { "description": "Successfully deleted the active directory administrator" }, "202": { "description": "Operation in progress" }, "204": { "description": "The specified Server active directory administrator does not exist" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/administrators": { "get": { "tags": [ "ServerAdministrators" ], "operationId": "ServerAdministrators_List", "description": "Returns a list of server Administrators.", "x-ms-examples": { "get a list of server administrators": { "$ref": "./examples/ServerAdminList.json" } }, "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ServerAdministratorResourceListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/recoverableServers": { "get": { "tags": [ "RecoverableServers" ], "operationId": "RecoverableServers_Get", "x-ms-examples": { "ReplicasListByServer": { "$ref": "./examples/RecoverableServersGet.json" } }, "description": "Gets a recoverable PostgreSQL Server.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RecoverableServerResource" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/performanceTiers": { "get": { "tags": [ "ServerBasedPerformanceTier" ], "operationId": "ServerBasedPerformanceTier_List", "x-ms-examples": { "PerformanceTiersList": { "$ref": "./examples/PerformanceTiersListByServer.json" } }, "description": "List all the performance tiers for a PostgreSQL server.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PerformanceTierListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" ], "operationId": "LocationBasedPerformanceTier_List", "x-ms-examples": { "PerformanceTiersList": { "$ref": "./examples/PerformanceTiersListByLocation.json" } }, "description": "List all the performance tiers at specified location in a given subscription.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/LocationNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PerformanceTierListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" ], "operationId": "CheckNameAvailability_Execute", "x-ms-examples": { "NameAvailability": { "$ref": "./examples/CheckNameAvailability.json" } }, "description": "Check the availability of name for resource", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "name": "nameAvailabilityRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/NameAvailabilityRequest" }, "description": "The required parameters for checking if resource name is available." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NameAvailability" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { "get": { "tags": [ "ServerSecurityAlertPolicies" ], "description": "Get a server's security alert policy.", "operationId": "ServerSecurityAlertPolicies_Get", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "securityAlertPolicyName", "in": "path", "description": "The name of the security alert policy.", "required": true, "type": "string", "enum": [ "Default" ], "x-ms-enum": { "name": "SecurityAlertPolicyName", "modelAsString": true } }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved the server threat detection policy.", "schema": { "$ref": "#/definitions/ServerSecurityAlertPolicy" } }, "default": { "description": "Error response describing why the operation of getting security alert policies failed." } }, "x-ms-examples": { "Get a server's threat detection policy": { "$ref": "./examples/ServerSecurityAlertsGet.json" } } }, "put": { "tags": [ "ServerSecurityAlertPolicies" ], "description": "Creates or updates a threat detection policy.", "operationId": "ServerSecurityAlertPolicies_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "securityAlertPolicyName", "in": "path", "description": "The name of the threat detection policy.", "required": true, "type": "string", "enum": [ "Default" ], "x-ms-enum": { "name": "SecurityAlertPolicyName", "modelAsString": true } }, { "name": "parameters", "in": "body", "description": "The server security alert policy.", "required": true, "schema": { "$ref": "#/definitions/ServerSecurityAlertPolicy" } }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully updated the threat detection policy.", "schema": { "$ref": "#/definitions/ServerSecurityAlertPolicy" } }, "default": { "description": "Error response describing why the operation of setting security alert policies failed." }, "202": { "description": "Created request to set the server threat detection policy." } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Update a server's threat detection policy with all parameters": { "$ref": "./examples/ServerSecurityAlertsCreateMax.json" }, "Update a server's threat detection policy with minimal parameters": { "$ref": "./examples/ServerSecurityAlertsCreateMin.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/securityAlertPolicies": { "get": { "tags": [ "ServerSecurityAlertPolicies" ], "description": "Get the server's threat detection policies.", "operationId": "ServerSecurityAlertPolicies_ListByServer", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved the server threat detection policies.", "schema": { "$ref": "#/definitions/ServerSecurityAlertPolicyListResult" } }, "default": { "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List the server's threat detection policies": { "$ref": "./examples/ServerSecurityAlertsListByServer.json" } } } }, "/providers/Microsoft.DBforPostgreSQL/operations": { "get": { "tags": [ "Operations" ], "operationId": "Operations_List", "x-ms-examples": { "OperationList": { "$ref": "./examples/OperationList.json" } }, "description": "Lists all of the available REST API operations.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } } }, "definitions": { "ServerVersion": { "type": "string", "description": "The version of a server.", "enum": [ "9.5", "9.6", "10", "10.0", "10.2", "11" ], "x-ms-enum": { "name": "ServerVersion", "modelAsString": true } }, "SslEnforcement": { "type": "string", "description": "Enable ssl enforcement or not when connect to server.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "SslEnforcementEnum", "modelAsString": false } }, "MinimalTlsVersion": { "type": "string", "description": "Enforce a minimal Tls version for the server.", "enum": [ "TLS1_0", "TLS1_1", "TLS1_2", "TLSEnforcementDisabled" ], "x-ms-enum": { "name": "MinimalTlsVersionEnum", "modelAsString": true } }, "ServerPrivateEndpointConnection": { "description": "A private endpoint connection under a server", "type": "object", "properties": { "id": { "description": "Resource Id of the private endpoint connection.", "type": "string", "readOnly": true }, "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", "description": "Private endpoint connection properties", "readOnly": true } } }, "PrivateEndpointConnectionProperties": { "description": "Properties of a private endpoint connection.", "type": "object", "properties": { "privateEndpoint": { "$ref": "#/definitions/PrivateEndpointProperty", "description": "Private endpoint which the connection belongs to." }, "privateLinkServiceConnectionState": { "$ref": "#/definitions/PrivateLinkServiceConnectionStateProperty", "description": "Connection state of the private endpoint connection." }, "provisioningState": { "description": "State of the private endpoint connection.", "enum": [ "Approving", "Ready", "Dropping", "Failed", "Rejecting" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "PrivateEndpointProvisioningState", "modelAsString": true } } } }, "PrivateEndpointProperty": { "type": "object", "properties": { "id": { "description": "Resource id of the private endpoint.", "type": "string" } }, "x-ms-azure-resource": true }, "PrivateLinkServiceConnectionStateProperty": { "required": [ "status", "description" ], "type": "object", "properties": { "status": { "description": "The private link service connection status.", "enum": [ "Approved", "Pending", "Rejected", "Disconnected" ], "type": "string", "x-ms-enum": { "name": "PrivateLinkServiceConnectionStateStatus", "modelAsString": true } }, "description": { "description": "The private link service connection description.", "type": "string" }, "actionsRequired": { "description": "The actions required for private link service connection.", "enum": [ "None" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "PrivateLinkServiceConnectionStateActionsRequire", "modelAsString": true } } } }, "ServerProperties": { "properties": { "administratorLogin": { "type": "string", "description": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation)." }, "version": { "$ref": "#/definitions/ServerVersion", "description": "Server version." }, "sslEnforcement": { "$ref": "#/definitions/SslEnforcement", "description": "Enable ssl enforcement or not when connect to server." }, "minimalTlsVersion": { "$ref": "#/definitions/MinimalTlsVersion", "description": "Enforce a minimal Tls version for the server." }, "byokEnforcement": { "type": "string", "description": "Status showing whether the server data encryption is enabled with customer-managed keys.", "readOnly": true }, "infrastructureEncryption": { "type": "string", "description": "Status showing whether the server enabled infrastructure encryption.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "InfrastructureEncryption", "modelAsString": true } }, "userVisibleState": { "type": "string", "description": "A state of a server that is visible to user.", "enum": [ "Ready", "Dropping", "Disabled", "Inaccessible" ], "x-ms-enum": { "name": "ServerState", "modelAsString": true } }, "fullyQualifiedDomainName": { "type": "string", "description": "The fully qualified domain name of a server." }, "earliestRestoreDate": { "type": "string", "format": "date-time", "description": "Earliest restore point creation time (ISO8601 format)" }, "storageProfile": { "$ref": "#/definitions/StorageProfile", "description": "Storage profile of a server." }, "replicationRole": { "type": "string", "description": "The replication role of the server." }, "masterServerId": { "type": "string", "description": "The master server id of a replica server." }, "replicaCapacity": { "type": "integer", "format": "int32", "minimum": 0, "description": "The maximum number of replicas that a master server can have." }, "publicNetworkAccess": { "type": "string", "description": "Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "PublicNetworkAccessEnum", "modelAsString": true } }, "privateEndpointConnections": { "description": "List of private endpoint connections on a server", "type": "array", "items": { "$ref": "#/definitions/ServerPrivateEndpointConnection" }, "readOnly": true } }, "description": "The properties of a server." }, "StorageProfile": { "properties": { "backupRetentionDays": { "type": "integer", "format": "int32", "description": "Backup retention days for the server." }, "geoRedundantBackup": { "type": "string", "description": "Enable Geo-redundant or not for server backup.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "GeoRedundantBackup", "modelAsString": true } }, "storageMB": { "type": "integer", "format": "int32", "description": "Max storage allowed for a server." }, "storageAutogrow": { "type": "string", "description": "Enable Storage Auto Grow.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "StorageAutogrow", "modelAsString": true } } }, "description": "Storage Profile properties of a server" }, "ServerPropertiesForCreate": { "discriminator": "createMode", "required": [ "createMode" ], "properties": { "version": { "$ref": "#/definitions/ServerVersion", "description": "Server version." }, "sslEnforcement": { "$ref": "#/definitions/SslEnforcement", "description": "Enable ssl enforcement or not when connect to server." }, "minimalTlsVersion": { "$ref": "#/definitions/MinimalTlsVersion", "description": "Enforce a minimal Tls version for the server." }, "storageProfile": { "$ref": "#/definitions/StorageProfile", "description": "Storage profile of a server." }, "createMode": { "type": "string", "description": "The mode to create a new server.", "enum": [ "Default", "PointInTimeRestore", "GeoRestore", "Replica" ], "x-ms-enum": { "name": "CreateMode", "modelAsString": true } } }, "description": "The properties used to create a new server." }, "ServerPropertiesForDefaultCreate": { "x-ms-discriminator-value": "Default", "allOf": [ { "$ref": "#/definitions/ServerPropertiesForCreate" } ], "properties": { "administratorLogin": { "type": "string", "description": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation)." }, "administratorLoginPassword": { "type": "string", "format": "password", "description": "The password of the administrator login.", "x-ms-secret": true } }, "required": [ "administratorLogin", "administratorLoginPassword" ], "description": "The properties used to create a new server." }, "ServerPropertiesForRestore": { "x-ms-discriminator-value": "PointInTimeRestore", "allOf": [ { "$ref": "#/definitions/ServerPropertiesForCreate" } ], "properties": { "sourceServerId": { "type": "string", "description": "The source server id to restore from." }, "restorePointInTime": { "type": "string", "format": "date-time", "description": "Restore point creation time (ISO8601 format), specifying the time to restore from." } }, "required": [ "sourceServerId", "restorePointInTime" ], "description": "The properties used to create a new server by restoring from a backup." }, "ServerPropertiesForGeoRestore": { "x-ms-discriminator-value": "GeoRestore", "allOf": [ { "$ref": "#/definitions/ServerPropertiesForCreate" } ], "properties": { "sourceServerId": { "type": "string", "description": "The source server id to restore from." } }, "required": [ "sourceServerId" ], "description": "The properties used to create a new server by restoring to a different region from a geo replicated backup." }, "ServerPropertiesForReplica": { "x-ms-discriminator-value": "Replica", "allOf": [ { "$ref": "#/definitions/ServerPropertiesForCreate" } ], "properties": { "sourceServerId": { "type": "string", "description": "The master server id to create replica from." } }, "required": [ "sourceServerId" ], "description": "The properties to create a new replica." }, "Sku": { "properties": { "name": { "type": "string", "description": "The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8." }, "tier": { "type": "string", "description": "The tier of the particular SKU, e.g. Basic.", "enum": [ "Basic", "GeneralPurpose", "MemoryOptimized" ], "x-ms-enum": { "name": "SkuTier", "modelAsString": true } }, "capacity": { "type": "integer", "format": "int32", "minimum": 0, "description": "The scale up/out capacity, representing server's compute units." }, "size": { "type": "string", "description": "The size code, to be interpreted by resource as appropriate." }, "family": { "type": "string", "description": "The family of hardware." } }, "required": [ "name" ], "description": "Billing information related properties of a server." }, "ResourceIdentity": { "description": "Azure Active Directory identity configuration for a resource.", "type": "object", "properties": { "principalId": { "format": "uuid", "description": "The Azure Active Directory principal id.", "type": "string", "readOnly": true }, "type": { "description": "The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.", "enum": [ "SystemAssigned" ], "type": "string", "x-ms-enum": { "name": "IdentityType", "modelAsString": true } }, "tenantId": { "format": "uuid", "description": "The Azure Active Directory tenant id.", "type": "string", "readOnly": true } } }, "Server": { "properties": { "identity": { "$ref": "#/definitions/ResourceIdentity", "description": "The Azure Active Directory identity of the server." }, "sku": { "$ref": "#/definitions/Sku", "description": "The SKU (pricing tier) of the server." }, "properties": { "$ref": "#/definitions/ServerProperties", "x-ms-client-flatten": true, "description": "Properties of the server." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" } ], "description": "Represents a server." }, "ServerForCreate": { "properties": { "sku": { "$ref": "#/definitions/Sku", "description": "The SKU (pricing tier) of the server." }, "properties": { "$ref": "#/definitions/ServerPropertiesForCreate", "x-ms-client-flatten": false, "description": "Properties of the server." }, "location": { "type": "string", "description": "The location the resource resides in." }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Application-specific metadata in the form of key-value pairs." } }, "required": [ "properties", "location" ], "description": "Represents a server to be created." }, "ServerUpdateParameters": { "properties": { "sku": { "$ref": "#/definitions/Sku", "description": "The SKU (pricing tier) of the server." }, "properties": { "properties": { "storageProfile": { "$ref": "#/definitions/StorageProfile", "description": "Storage profile of a server." }, "administratorLoginPassword": { "type": "string", "format": "password", "description": "The password of the administrator login." }, "version": { "$ref": "#/definitions/ServerVersion", "description": "The version of a server." }, "sslEnforcement": { "$ref": "#/definitions/SslEnforcement", "description": "Enable ssl enforcement or not when connect to server." }, "minimalTlsVersion": { "$ref": "#/definitions/MinimalTlsVersion", "description": "Enforce a minimal Tls version for the server." }, "replicationRole": { "type": "string", "description": "The replication role of the server." } }, "x-ms-client-flatten": true, "description": "The properties that can be updated for a server." }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Application-specific metadata in the form of key-value pairs." } }, "description": "Parameters allowed to update for a server." }, "ServerListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/Server" }, "description": "The list of servers" } }, "description": "A list of servers." }, "FirewallRuleProperties": { "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": "The start IP address of the server firewall rule. Must be 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": "The end IP address of the server firewall rule. Must be IPv4 format." } }, "required": [ "startIpAddress", "endIpAddress" ], "description": "The properties of a server firewall rule." }, "FirewallRule": { "properties": { "properties": { "$ref": "#/definitions/FirewallRuleProperties", "x-ms-client-flatten": true, "description": "The properties of a firewall rule." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "required": [ "properties" ], "description": "Represents a server firewall rule." }, "FirewallRuleListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/FirewallRule" }, "description": "The list of firewall rules in a server." } }, "description": "A list of firewall rules." }, "VirtualNetworkRuleProperties": { "description": "Properties of a virtual network rule.", "required": [ "virtualNetworkSubnetId" ], "type": "object", "properties": { "virtualNetworkSubnetId": { "description": "The ARM resource id of the virtual network subnet.", "type": "string" }, "ignoreMissingVnetServiceEndpoint": { "description": "Create firewall rule before the virtual network has vnet service endpoint enabled.", "type": "boolean" }, "state": { "description": "Virtual Network Rule State", "enum": [ "Initializing", "InProgress", "Ready", "Deleting", "Unknown" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "VirtualNetworkRuleState", "modelAsString": true } } } }, "VirtualNetworkRule": { "description": "A virtual network rule.", "type": "object", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { "properties": { "$ref": "#/definitions/VirtualNetworkRuleProperties", "description": "Resource properties.", "x-ms-client-flatten": true } } }, "VirtualNetworkRuleListResult": { "description": "A list of virtual network rules.", "type": "object", "properties": { "value": { "description": "Array of results.", "type": "array", "items": { "$ref": "#/definitions/VirtualNetworkRule" }, "readOnly": true }, "nextLink": { "description": "Link to retrieve next page of results.", "type": "string", "readOnly": true } } }, "DatabaseProperties": { "properties": { "charset": { "type": "string", "description": "The charset of the database." }, "collation": { "type": "string", "description": "The collation of the database." } }, "description": "The properties of a database." }, "Database": { "properties": { "properties": { "$ref": "#/definitions/DatabaseProperties", "x-ms-client-flatten": true, "description": "The properties of a database." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Database." }, "DatabaseListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/Database" }, "description": "The list of databases housed in a server" } }, "description": "A List of databases." }, "ConfigurationProperties": { "properties": { "value": { "type": "string", "description": "Value of the configuration." }, "description": { "type": "string", "readOnly": true, "description": "Description of the configuration." }, "defaultValue": { "type": "string", "readOnly": true, "description": "Default value of the configuration." }, "dataType": { "type": "string", "readOnly": true, "description": "Data type of the configuration." }, "allowedValues": { "type": "string", "readOnly": true, "description": "Allowed values of the configuration." }, "source": { "type": "string", "description": "Source of the configuration." } }, "description": "The properties of a configuration." }, "Configuration": { "properties": { "properties": { "$ref": "#/definitions/ConfigurationProperties", "x-ms-client-flatten": true, "description": "The properties of a configuration." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Configuration." }, "ConfigurationListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/Configuration" }, "description": "The list of server configurations." } }, "description": "A list of server configurations." }, "OperationDisplay": { "properties": { "provider": { "type": "string", "readOnly": true, "description": "Operation resource provider name." }, "resource": { "type": "string", "readOnly": true, "description": "Resource on which the operation is performed." }, "operation": { "type": "string", "readOnly": true, "description": "Localized friendly name for the operation." }, "description": { "type": "string", "readOnly": true, "description": "Operation description." } }, "description": "Display metadata associated with the operation." }, "Operation": { "properties": { "name": { "type": "string", "readOnly": true, "description": "The name of the operation being performed on this particular object." }, "display": { "$ref": "#/definitions/OperationDisplay", "readOnly": true, "description": "The localized display information for this particular operation or action." }, "origin": { "type": "string", "readOnly": true, "description": "The intended executor of the operation.", "enum": [ "NotSpecified", "user", "system" ], "x-ms-enum": { "name": "OperationOrigin", "modelAsString": true } }, "properties": { "type": "object", "additionalProperties": { "type": "object" }, "readOnly": true, "x-ms-client-flatten": false, "description": "Additional descriptions for the operation." } }, "description": "REST API operation definition." }, "OperationListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/Operation" }, "description": "The list of resource provider operations." } }, "description": "A list of resource provider operations." }, "LogFileProperties": { "properties": { "sizeInKB": { "type": "integer", "format": "int64", "description": "Size of the log file." }, "createdTime": { "type": "string", "readOnly": true, "format": "date-time", "description": "Creation timestamp of the log file." }, "lastModifiedTime": { "type": "string", "readOnly": true, "format": "date-time", "description": "Last modified timestamp of the log file." }, "type": { "type": "string", "description": "Type of the log file." }, "url": { "type": "string", "description": "The url to download the log file from." } }, "description": "The properties of a log file." }, "LogFile": { "properties": { "name": { "type": "string", "description": "The name of the log file." }, "properties": { "$ref": "#/definitions/LogFileProperties", "x-ms-client-flatten": true, "description": "The properties of the log file." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a log file." }, "LogFileListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/LogFile" }, "description": "The list of log files." } }, "description": "A list of log files." }, "PerformanceTierServiceLevelObjectives": { "properties": { "id": { "type": "string", "description": "ID for the service level objective." }, "edition": { "type": "string", "description": "Edition of the performance tier." }, "vCore": { "type": "integer", "format": "int32", "description": "vCore associated with the service level objective" }, "hardwareGeneration": { "type": "string", "description": "Hardware generation associated with the service level objective" }, "maxBackupRetentionDays": { "type": "integer", "format": "int32", "description": "Maximum Backup retention in days for the performance tier edition" }, "minBackupRetentionDays": { "type": "integer", "format": "int32", "description": "Minimum Backup retention in days for the performance tier edition" }, "maxStorageMB": { "type": "integer", "format": "int32", "description": "Max storage allowed for a server." }, "minStorageMB": { "type": "integer", "format": "int32", "description": "Max storage allowed for a server." } }, "description": "Service level objectives for performance tier." }, "PerformanceTierProperties": { "properties": { "id": { "type": "string", "description": "ID of the performance tier." }, "maxBackupRetentionDays": { "type": "integer", "format": "int32", "description": "Maximum Backup retention in days for the performance tier edition" }, "minBackupRetentionDays": { "type": "integer", "format": "int32", "description": "Minimum Backup retention in days for the performance tier edition" }, "maxStorageMB": { "type": "integer", "format": "int32", "description": "Max storage allowed for a server." }, "minLargeStorageMB": { "type": "integer", "format": "int32", "description": "Max storage allowed for a server." }, "maxLargeStorageMB": { "type": "integer", "format": "int32", "description": "Max storage allowed for a server." }, "minStorageMB": { "type": "integer", "format": "int32", "description": "Max storage allowed for a server." }, "serviceLevelObjectives": { "type": "array", "items": { "$ref": "#/definitions/PerformanceTierServiceLevelObjectives" }, "description": "Service level objectives associated with the performance tier" } }, "description": "Performance tier properties" }, "PerformanceTierListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PerformanceTierProperties" }, "description": "The list of performance tiers" } }, "description": "A list of performance tiers." }, "NameAvailabilityRequest": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Resource name to verify." }, "type": { "type": "string", "description": "Resource type used for verification." } }, "description": "Request from client to check resource name availability." }, "NameAvailability": { "properties": { "message": { "type": "string", "description": "Error Message." }, "nameAvailable": { "type": "boolean", "description": "Indicates whether the resource name is available." }, "reason": { "type": "string", "description": "Reason for name being unavailable." } }, "description": "Represents a resource name availability." }, "SecurityAlertPolicyProperties": { "description": "Properties of a security alert policy.", "required": [ "state" ], "type": "object", "properties": { "state": { "description": "Specifies the state of the policy, whether it is enabled or disabled.", "enum": [ "Enabled", "Disabled" ], "type": "string", "x-ms-enum": { "name": "ServerSecurityAlertPolicyState", "modelAsString": false } }, "disabledAlerts": { "description": "Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly", "type": "array", "items": { "type": "string" } }, "emailAddresses": { "description": "Specifies an array of e-mail addresses to which the alert is sent.", "type": "array", "items": { "type": "string" } }, "emailAccountAdmins": { "description": "Specifies that the alert is sent to the account administrators.", "type": "boolean" }, "storageEndpoint": { "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.", "type": "string" }, "storageAccountAccessKey": { "description": "Specifies the identifier key of the Threat Detection audit storage account.", "type": "string" }, "retentionDays": { "format": "int32", "description": "Specifies the number of days to keep in the Threat Detection audit logs.", "type": "integer" } } }, "ServerSecurityAlertPolicy": { "description": "A server security alert policy.", "type": "object", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { "properties": { "$ref": "#/definitions/SecurityAlertPolicyProperties", "description": "Resource properties.", "x-ms-client-flatten": true } } }, "CloudError": { "x-ms-external": true, "properties": { "error": { "$ref": "#/definitions/CloudErrorBody" } }, "description": "An error response from the Batch service." }, "ServerSecurityAlertPolicyListResult": { "description": "A list of the server's security alert policies.", "type": "object", "properties": { "value": { "description": "Array of results.", "type": "array", "items": { "$ref": "#/definitions/ServerSecurityAlertPolicy" }, "readOnly": true }, "nextLink": { "description": "Link to retrieve next page of results.", "type": "string", "readOnly": true } } }, "CloudErrorBody": { "x-ms-external": true, "properties": { "code": { "type": "string", "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." }, "message": { "type": "string", "description": "A message describing the error, intended to be suitable for display in a user interface." }, "target": { "type": "string", "description": "The target of the particular error. For example, the name of the property in error." }, "details": { "type": "array", "items": { "$ref": "#/definitions/CloudErrorBody" }, "description": "A list of additional details about the error." } }, "description": "An error response from the Batch service." }, "ServerAdministratorProperties": { "properties": { "administratorType": { "type": "string", "description": "The type of administrator.", "enum": [ "ActiveDirectory" ], "x-ms-enum": { "name": "AdministratorType" } }, "login": { "type": "string", "description": "The server administrator login account name." }, "sid": { "type": "string", "description": "The server administrator Sid (Secure ID).", "format": "uuid" }, "tenantId": { "type": "string", "description": "The server Active Directory Administrator tenant id.", "format": "uuid" } }, "required": [ "tenantId", "administratorType", "login", "sid" ], "description": "The properties of an server Administrator." }, "ServerAdministratorResource": { "properties": { "properties": { "$ref": "#/definitions/ServerAdministratorProperties", "x-ms-client-flatten": true, "description": "Properties of the server AAD administrator." } }, "description": "Represents a and external administrator to be created.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ] }, "ServerAdministratorResourceListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ServerAdministratorResource" }, "description": "The list of server Active Directory Administrators for the server." } }, "description": "The response to a list Active Directory Administrators request." }, "RecoverableServerProperties": { "description": "The recoverable server's properties.", "type": "object", "properties": { "lastAvailableBackupDateTime": { "type": "string", "description": "The last available backup date time.", "readOnly": true }, "serviceLevelObjective": { "type": "string", "description": "The service level objective", "readOnly": true }, "edition": { "type": "string", "description": "Edition of the performance tier.", "readOnly": true }, "vCore": { "type": "integer", "format": "int32", "description": "vCore associated with the service level objective", "readOnly": true }, "hardwareGeneration": { "type": "string", "description": "Hardware generation associated with the service level objective", "readOnly": true }, "version": { "type": "string", "description": "The PostgreSQL version", "readOnly": true } } }, "RecoverableServerResource": { "description": "A recoverable server resource.", "type": "object", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { "properties": { "$ref": "#/definitions/RecoverableServerProperties", "description": "Resource properties.", "x-ms-client-flatten": true } } } }, "parameters": { "SubscriptionIdParameter": { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "description": "The subscription ID that identifies an Azure subscription." }, "ApiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "description": "The API version to use for the request." }, "ResourceGroupParameter": { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", "x-ms-parameter-location": "method" }, "ServerNameParameter": { "name": "serverName", "in": "path", "required": true, "type": "string", "description": "The name of the server.", "x-ms-parameter-location": "method" }, "FirewallRuleNameParameter": { "name": "firewallRuleName", "in": "path", "required": true, "type": "string", "description": "The name of the server firewall rule.", "x-ms-parameter-location": "method" }, "virtualNetworkRuleNameParameter": { "name": "virtualNetworkRuleName", "in": "path", "description": "The name of the virtual network rule.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "DatabaseNameParameter": { "name": "databaseName", "in": "path", "required": true, "type": "string", "description": "The name of the database.", "x-ms-parameter-location": "method" }, "ConfigurationNameParameter": { "name": "configurationName", "in": "path", "required": true, "type": "string", "description": "The name of the server configuration.", "x-ms-parameter-location": "method" }, "LocationNameParameter": { "name": "locationName", "in": "path", "required": true, "type": "string", "description": "The name of the location.", "x-ms-parameter-location": "method" }, "SecurityAlertPolicyNameParameter": { "name": "securityAlertPolicyName", "in": "path", "description": "The name of the security alert policy.", "required": true, "type": "string", "enum": [ "default" ], "x-ms-parameter-location": "method" } } }