Firewall Rules - Replace

服務:

SQL Database

API 版本:

2025-01-01

取代伺服器上的所有防火牆規則。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	類型	Description
values	FirewallRule[]	伺服器防火牆規則。

回應

名稱	類型	Description
200 OK	FirewallRule	Azure 運作順利完成。
202 Accepted		要求已接受進行處理，但尚未完成處理。
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow.

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Replace firewall rules

範例要求

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

範例回覆

狀態碼:

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"
  }
}

狀態碼:

202

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤附加資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	錯誤回應
FirewallRule	伺服器防火牆規則。
FirewallRuleList	伺服器防火牆規則的清單。

ErrorAdditionalInfo

Object

資源管理錯誤附加資訊。

名稱	類型	Description
info	object	附加資訊。
type	string	其他資訊類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤附加資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

FirewallRule

Object

伺服器防火牆規則。

名稱	類型	Description
id	string	資源標識碼。
name	string	資源名稱。
properties.endIpAddress	string	防火牆規則的結束IP位址。 必須是 IPv4 格式。 必須大於或等於 startIpAddress。 所有 Azure 內部 IP 位址都用值 '0.0.0.0'。
properties.startIpAddress	string	防火牆規則的起始IP位址。 必須是 IPv4 格式。 所有 Azure 內部 IP 位址都用值 '0.0.0.0'。
type	string	資源類型。

FirewallRuleList

Object

伺服器防火牆規則的清單。

名稱	類型	Description
values	FirewallRule[]	伺服器防火牆規則。