|
| 1 | +{ |
| 2 | + "swagger": "2.0", |
| 3 | + "info": { |
| 4 | + "title": "PostgreSQLManagementClient", |
| 5 | + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, administrators, log files, configurations, migrations, advanced threat protection settings with new business model.", |
| 6 | + "version": "2025-08-01" |
| 7 | + }, |
| 8 | + "host": "management.azure.com", |
| 9 | + "schemes": [ |
| 10 | + "https" |
| 11 | + ], |
| 12 | + "consumes": [ |
| 13 | + "application/json" |
| 14 | + ], |
| 15 | + "produces": [ |
| 16 | + "application/json" |
| 17 | + ], |
| 18 | + "security": [ |
| 19 | + { |
| 20 | + "azure_auth": [ |
| 21 | + "user_impersonation" |
| 22 | + ] |
| 23 | + } |
| 24 | + ], |
| 25 | + "securityDefinitions": { |
| 26 | + "azure_auth": { |
| 27 | + "type": "oauth2", |
| 28 | + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", |
| 29 | + "flow": "implicit", |
| 30 | + "description": "Microsoft Entra OAuth2 Flow", |
| 31 | + "scopes": { |
| 32 | + "user_impersonation": "impersonate your user account" |
| 33 | + } |
| 34 | + } |
| 35 | + }, |
| 36 | + "paths": { |
| 37 | + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings": { |
| 38 | + "get": { |
| 39 | + "tags": [ |
| 40 | + "AdvancedThreatProtectionSettings" |
| 41 | + ], |
| 42 | + "description": "Lists state of advanced threat protection settings for a server.", |
| 43 | + "operationId": "AdvancedThreatProtectionSettings_ListByServer", |
| 44 | + "parameters": [ |
| 45 | + { |
| 46 | + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" |
| 47 | + }, |
| 48 | + { |
| 49 | + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" |
| 50 | + }, |
| 51 | + { |
| 52 | + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" |
| 53 | + }, |
| 54 | + { |
| 55 | + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" |
| 56 | + } |
| 57 | + ], |
| 58 | + "responses": { |
| 59 | + "200": { |
| 60 | + "description": "OK.", |
| 61 | + "schema": { |
| 62 | + "$ref": "#/definitions/AdvancedThreatProtectionSettingsList" |
| 63 | + } |
| 64 | + }, |
| 65 | + "default": { |
| 66 | + "description": "Error response describing why the operation failed.", |
| 67 | + "schema": { |
| 68 | + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" |
| 69 | + } |
| 70 | + } |
| 71 | + }, |
| 72 | + "x-ms-examples": { |
| 73 | + "List state of advanced threat protection settings for a server.": { |
| 74 | + "$ref": "./examples/AdvancedThreatProtectionSettingsListByServer.json" |
| 75 | + } |
| 76 | + }, |
| 77 | + "x-ms-pageable": { |
| 78 | + "nextLinkName": "nextLink" |
| 79 | + } |
| 80 | + } |
| 81 | + }, |
| 82 | + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{threatProtectionName}": { |
| 83 | + "get": { |
| 84 | + "tags": [ |
| 85 | + "AdvancedThreatProtectionSettings" |
| 86 | + ], |
| 87 | + "description": "Gets state of advanced threat protection settings for a server.", |
| 88 | + "operationId": "AdvancedThreatProtectionSettings_Get", |
| 89 | + "parameters": [ |
| 90 | + { |
| 91 | + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" |
| 92 | + }, |
| 93 | + { |
| 94 | + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" |
| 95 | + }, |
| 96 | + { |
| 97 | + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" |
| 98 | + }, |
| 99 | + { |
| 100 | + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" |
| 101 | + }, |
| 102 | + { |
| 103 | + "$ref": "#/parameters/ThreatProtectionNameParameter" |
| 104 | + } |
| 105 | + ], |
| 106 | + "responses": { |
| 107 | + "200": { |
| 108 | + "description": "OK.", |
| 109 | + "schema": { |
| 110 | + "$ref": "#/definitions/AdvancedThreatProtectionSettingsModel" |
| 111 | + } |
| 112 | + }, |
| 113 | + "default": { |
| 114 | + "description": "Error response describing why the operation failed.", |
| 115 | + "schema": { |
| 116 | + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" |
| 117 | + } |
| 118 | + } |
| 119 | + }, |
| 120 | + "x-ms-examples": { |
| 121 | + "Get state of advanced threat protection settings for a server.": { |
| 122 | + "$ref": "./examples/AdvancedThreatProtectionSettingsGet.json" |
| 123 | + } |
| 124 | + } |
| 125 | + }, |
| 126 | + "put": { |
| 127 | + "tags": [ |
| 128 | + "AdvancedThreatProtectionSettings" |
| 129 | + ], |
| 130 | + "description": "Creates or updates a server's Advanced Threat Protection settings.", |
| 131 | + "operationId": "ServerThreatProtectionSettings_CreateOrUpdate", |
| 132 | + "parameters": [ |
| 133 | + { |
| 134 | + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" |
| 135 | + }, |
| 136 | + { |
| 137 | + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" |
| 138 | + }, |
| 139 | + { |
| 140 | + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" |
| 141 | + }, |
| 142 | + { |
| 143 | + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" |
| 144 | + }, |
| 145 | + { |
| 146 | + "$ref": "#/parameters/ThreatProtectionNameParameter" |
| 147 | + }, |
| 148 | + { |
| 149 | + "name": "parameters", |
| 150 | + "in": "body", |
| 151 | + "description": "The Advanced Threat Protection state for the server.", |
| 152 | + "required": true, |
| 153 | + "schema": { |
| 154 | + "$ref": "#/definitions/AdvancedThreatProtectionSettingsModel" |
| 155 | + } |
| 156 | + } |
| 157 | + ], |
| 158 | + "responses": { |
| 159 | + "202": { |
| 160 | + "description": "Accepted.", |
| 161 | + "headers": { |
| 162 | + "Location": { |
| 163 | + "type": "string" |
| 164 | + }, |
| 165 | + "Azure-AsyncOperation": { |
| 166 | + "type": "string" |
| 167 | + } |
| 168 | + } |
| 169 | + }, |
| 170 | + "default": { |
| 171 | + "description": "Error response describing why the operation failed.", |
| 172 | + "schema": { |
| 173 | + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" |
| 174 | + } |
| 175 | + } |
| 176 | + }, |
| 177 | + "x-ms-long-running-operation": true, |
| 178 | + "x-ms-long-running-operation-options": { |
| 179 | + "final-state-via": "azure-async-operation" |
| 180 | + }, |
| 181 | + "x-ms-examples": { |
| 182 | + "Update the advanced threat protection settings of a server.": { |
| 183 | + "$ref": "./examples/AdvancedThreatProtectionSettingsCreateOrUpdate.json" |
| 184 | + } |
| 185 | + } |
| 186 | + } |
| 187 | + } |
| 188 | + }, |
| 189 | + "definitions": { |
| 190 | + "AdvancedThreatProtectionSettingsProperties": { |
| 191 | + "description": "Properties of advanced threat protection state for a server.", |
| 192 | + "required": [ |
| 193 | + "state" |
| 194 | + ], |
| 195 | + "type": "object", |
| 196 | + "properties": { |
| 197 | + "state": { |
| 198 | + "description": "Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the server.", |
| 199 | + "enum": [ |
| 200 | + "Enabled", |
| 201 | + "Disabled" |
| 202 | + ], |
| 203 | + "type": "string", |
| 204 | + "x-ms-enum": { |
| 205 | + "name": "ThreatProtectionState", |
| 206 | + "modelAsString": false, |
| 207 | + "values": [ |
| 208 | + { |
| 209 | + "value": "Enabled", |
| 210 | + "description": "Advanced threat protection is enabled." |
| 211 | + }, |
| 212 | + { |
| 213 | + "value": "Disabled", |
| 214 | + "description": "Advanced threat protection is disabled." |
| 215 | + } |
| 216 | + ] |
| 217 | + } |
| 218 | + }, |
| 219 | + "creationTime": { |
| 220 | + "format": "date-time", |
| 221 | + "description": "Specifies the creation time (UTC) of the policy.", |
| 222 | + "type": "string", |
| 223 | + "readOnly": true |
| 224 | + } |
| 225 | + } |
| 226 | + }, |
| 227 | + "AdvancedThreatProtectionSettingsModel": { |
| 228 | + "description": "Advanced threat protection settings of the server.", |
| 229 | + "type": "object", |
| 230 | + "allOf": [ |
| 231 | + { |
| 232 | + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" |
| 233 | + } |
| 234 | + ], |
| 235 | + "properties": { |
| 236 | + "properties": { |
| 237 | + "$ref": "#/definitions/AdvancedThreatProtectionSettingsProperties", |
| 238 | + "description": "Advanced threat protection properties.", |
| 239 | + "x-ms-client-flatten": true |
| 240 | + } |
| 241 | + } |
| 242 | + }, |
| 243 | + "AdvancedThreatProtectionSettingsList": { |
| 244 | + "description": "List of advanced threat protection settings for a server.", |
| 245 | + "type": "object", |
| 246 | + "properties": { |
| 247 | + "value": { |
| 248 | + "description": "Array of results.", |
| 249 | + "type": "array", |
| 250 | + "items": { |
| 251 | + "$ref": "#/definitions/AdvancedThreatProtectionSettingsModel" |
| 252 | + }, |
| 253 | + "readOnly": true |
| 254 | + }, |
| 255 | + "nextLink": { |
| 256 | + "description": "Link used to get the next page of results.", |
| 257 | + "type": "string", |
| 258 | + "format": "uri" |
| 259 | + } |
| 260 | + } |
| 261 | + } |
| 262 | + }, |
| 263 | + "parameters": { |
| 264 | + "ThreatProtectionNameParameter": { |
| 265 | + "name": "threatProtectionName", |
| 266 | + "in": "path", |
| 267 | + "description": "Name of the advanced threat protection settings.", |
| 268 | + "required": true, |
| 269 | + "type": "string", |
| 270 | + "enum": [ |
| 271 | + "Default" |
| 272 | + ], |
| 273 | + "x-ms-enum": { |
| 274 | + "name": "ThreatProtectionName", |
| 275 | + "modelAsString": true, |
| 276 | + "values": [ |
| 277 | + { |
| 278 | + "value": "Default", |
| 279 | + "description": "Default advanced threat protection settings." |
| 280 | + } |
| 281 | + ] |
| 282 | + }, |
| 283 | + "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*", |
| 284 | + "x-ms-parameter-location": "method" |
| 285 | + } |
| 286 | + } |
| 287 | +} |
0 commit comments