{ "swagger": "2.0", "info": { "title": "Azure SQL Database server firewall rules", "description": "Provides create, read, update, and delete functionality for Azure SQL Database server firewall rules.", "version": "2014-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" ], "operationId": "FirewallRules_CreateOrUpdate", "description": "Creates or updates a firewall rule.", "x-ms-examples": { "Create a firewall rule max/min": { "$ref": "./examples/FirewallRuleCreate.json" }, "Update a firewall rule max/min": { "$ref": "./examples/FirewallRuleUpdate.json" } }, "parameters": [ { "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "firewallRuleName", "in": "path", "required": true, "type": "string", "description": "The name of the firewall rule." }, { "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" } } } }, "delete": { "tags": [ "FirewallRules" ], "operationId": "FirewallRules_Delete", "description": "Deletes a firewall rule.", "x-ms-examples": { "Delete a firewall rule": { "$ref": "./examples/FirewallRuleDelete.json" } }, "parameters": [ { "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "firewallRuleName", "in": "path", "required": true, "type": "string", "description": "The name of the firewall rule." } ], "responses": { "200": { "description": "OK" }, "204": { "description": "NoContent" } } }, "get": { "tags": [ "FirewallRules" ], "operationId": "FirewallRules_Get", "description": "Gets a firewall rule.", "x-ms-examples": { "Get Firewall Rule": { "$ref": "./examples/FirewallRuleGet.json" } }, "parameters": [ { "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "firewallRuleName", "in": "path", "required": true, "type": "string", "description": "The name of the firewall rule." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FirewallRule" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" ], "operationId": "FirewallRules_ListByServer", "description": "Returns a list of firewall rules.", "x-ms-examples": { "List Firewall Rules": { "$ref": "./examples/FirewallRuleList.json" } }, "parameters": [ { "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FirewallRuleListResult" } } }, "x-ms-pageable": { "nextLinkName": null } } } }, "definitions": { "FirewallRuleProperties": { "properties": { "startIpAddress": { "type": "string", "description": "The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' to represent all Azure-internal IP addresses." }, "endIpAddress": { "type": "string", "description": "The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' to represent all Azure-internal IP addresses." } }, "required": [ "startIpAddress", "endIpAddress" ], "description": "Represents the properties of a server firewall rule." }, "FirewallRule": { "properties": { "kind": { "type": "string", "description": "Kind of server that contains this firewall rule.", "readOnly": true }, "location": { "type": "string", "description": "Location of the server that contains this firewall rule.", "readOnly": true }, "type": { "type": "string", "description": "Type of resource this is.", "readOnly": true }, "properties": { "$ref": "#/definitions/FirewallRuleProperties", "description": "The properties representing the resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a server firewall rule." }, "FirewallRuleListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/FirewallRule" }, "description": "The list of server firewall rules." } }, "description": "Represents the response to a List Firewall Rules request." } }, "parameters": { "ServerNameParameter": { "name": "serverName", "in": "path", "required": true, "type": "string", "description": "The name of the server.", "x-ms-parameter-location": "method" } }, "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" } } } }