Firewall Rules - Replace

Dienst:

SQL Database

API-Version:

2025-01-01

Ersetzt alle Firewallregeln auf dem Server.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules?api-version=2025-01-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
values	FirewallRule[]	Eine Serverfirewallregel.

Antworten

Name	Typ	Beschreibung
200 OK	FirewallRule	Azure-Operation erfolgreich abgeschlossen.
202 Accepted		Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Replace firewall rules

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/firewallrulecrudtest-12/providers/Microsoft.Sql/servers/firewallrulecrudtest-6285/firewallRules?api-version=2025-01-01

{
  "values": [
    {
      "name": "firewallrulecrudtest-5370 ",
      "properties": {
        "endIpAddress": "100.0.0.0",
        "startIpAddress": "0.0.0.0"
      }
    }
  ]
}

Java

import com.azure.resourcemanager.sql.fluent.models.FirewallRuleInner;
import com.azure.resourcemanager.sql.models.FirewallRuleList;
import java.util.Arrays;

/**
 * Samples for FirewallRules Replace.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/FirewallRuleReplace.json
     */
    /**
     * Sample code: Replace firewall rules.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void replaceFirewallRules(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getFirewallRules().replaceWithResponse("firewallrulecrudtest-12",
            "firewallrulecrudtest-6285",
            new FirewallRuleList().withValues(Arrays.asList(new FirewallRuleInner()
                .withName("firewallrulecrudtest-5370 ").withStartIpAddress("0.0.0.0").withEndIpAddress("100.0.0.0"))),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python firewall_rule_replace.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.firewall_rules.replace(
        resource_group_name="firewallrulecrudtest-12",
        server_name="firewallrulecrudtest-6285",
        parameters={
            "values": [
                {
                    "name": "firewallrulecrudtest-5370 ",
                    "properties": {"endIpAddress": "100.0.0.0", "startIpAddress": "0.0.0.0"},
                }
            ]
        },
    )
    print(response)


# x-ms-original-file: 2025-01-01/FirewallRuleReplace.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to replaces all firewall rules on the server.
 *
 * @summary replaces all firewall rules on the server.
 * x-ms-original-file: 2025-01-01/FirewallRuleReplace.json
 */
async function replaceFirewallRules() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.firewallRules.replace(
    "firewallrulecrudtest-12",
    "firewallrulecrudtest-6285",
    {
      values: [
        {
          name: "firewallrulecrudtest-5370 ",
          endIpAddress: "100.0.0.0",
          startIpAddress: "0.0.0.0",
        },
      ],
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:

200

{
  "name": "firewallrulecrudtest-5370",
  "type": "Microsoft.Sql/servers/firewallRules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/firewallrulecrudtest-12/providers/Microsoft.Sql/servers/firewallrulecrudtest-6285/firewallRules/firewallrulecrudtest-5370",
  "properties": {
    "endIpAddress": "0.0.0.3",
    "startIpAddress": "0.0.0.3"
  }
}

Statuscode:

202

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
FirewallRule	Eine Serverfirewallregel.
FirewallRuleList	Eine Liste der Serverfirewallregeln.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

FirewallRule

Objekt

Eine Serverfirewallregel.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Ressourcenname.
properties.endIpAddress	string	Die IP-Endadresse der Firewallregel. Muss das IPv4-Format sein. Muss größer oder gleich "startIpAddress" sein. Verwendungswert '0.0.0.0' für alle Azure-internen IP-Adressen.
properties.startIpAddress	string	Die Start-IP-Adresse der Firewallregel. Muss das IPv4-Format sein. Verwendungswert '0.0.0.0' für alle Azure-internen IP-Adressen.
type	string	Ressourcentyp.

FirewallRuleList

Objekt

Eine Liste der Serverfirewallregeln.

Name	Typ	Beschreibung
values	FirewallRule[]	Eine Serverfirewallregel.