Firewall Rules - Create Or Update

Tjänst:

SQL Database

API-version:

2023-08-01

Skapar eller uppdaterar en brandväggsregel.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
firewallRuleName	path	True	string	Namnet på brandväggsregeln.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string	Det prenumerations-ID som identifierar en Azure-prenumeration.
api-version	query	True	string	DEN API-version som ska användas för begäran.

Begärandetext

Name	Typ	Description
name	string	Resursnamn.
properties.endIpAddress	string	Brandväggsregelns slut-IP-adress. Måste vara IPv4-format. Måste vara större än eller lika med startIpAddress. Använd värdet "0.0.0.0" för alla Azure-interna IP-adresser.
properties.startIpAddress	string	Brandväggsregelns start-IP-adress. Måste vara IPv4-format. Använd värdet "0.0.0.0" för alla Azure-interna IP-adresser.

Svar

Name	Typ	Description
200 OK	FirewallRule	Brandväggsregeln har uppdaterats.
201 Created	FirewallRule	Brandväggsregeln har skapats.
Other Status Codes	ErrorResponse	Felsvar: *** 400 ManagedInstanceStoppingOrS toppad – Konfliktåtgärd som skickas när instansen är i stopptillstånd 400 ManagedInstanceStarting – Konfliktåtgärd som skickas när instansen är i starttillstånd 400 InvalidResourceId – Ogiltig resursidentifierare. 400 MismatchingSubscriptionWithUrl – Den angivna prenumerationen matchade inte prenumerationen i URL:en. 400 MismatchingResourceGroupNameWithUrl – Det angivna resursgruppsnamnet matchade inte namnet i URL:en. 400 MismatchingServerNameWithUrl – Det angivna servernamnet matchade inte namnet i URL:en. 400 InvalidServerFirewallRuleResourceRequest – resursbegäran för serverbrandväggsregeln är ogiltig. 400 InvalidServerFirewallRuleResourceParameters – resursparametern för serverns brandväggsregel är ogiltig. 400 FirewallRuleNotIPv4Address – den angivna brandväggsregeladressen är inte IPv4 400 TooManyFirewallRules – De angivna brandväggsreglerna är över gränsen. 400 FirewallRuleInvalidRange – det angivna brandväggsregelintervallet är ogiltigt. 400 FirewallRuleNameTooLong – det angivna brandväggsregelnamnet är för långt 400 FirewallRuleNameEmpty – Det angivna brandväggsregelnamnet är tomt 400 DenyPublicEndpointEnabled – Det går inte att skapa eller ändra brandväggsregler när det offentliga nätverksgränssnittet för servern är inaktiverat. Om du vill hantera brandväggsregler på server- eller databasnivå aktiverar du det offentliga nätverksgränssnittet. 400 FirewallRuleNameInvalid – det angivna brandväggsregelnamnet innehåller specialtecken. 404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen. 404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte 429 SubscriptionTooManyRequests – Begäranden utöver maxbegäranden som kan bearbetas av tillgängliga resurser. 429 SubscriptionTooManyCreateUpdateRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser. 503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Exempel

Create a firewall rule max/min

Update a firewall rule max/min

Create a firewall rule max/min

Exempelbegäran

HTTP

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

{
  "properties": {
    "startIpAddress": "0.0.0.3",
    "endIpAddress": "0.0.0.3"
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/FirewallRuleCreate.json
// this example is just showing the usage of "FirewallRules_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "firewallrulecrudtest-12";
string serverName = "firewallrulecrudtest-6285";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlFirewallRuleResource
SqlFirewallRuleCollection collection = sqlServer.GetSqlFirewallRules();

// invoke the operation
string firewallRuleName = "firewallrulecrudtest-5370";
SqlFirewallRuleData data = new SqlFirewallRuleData
{
    StartIPAddress = "0.0.0.3",
    EndIPAddress = "0.0.0.3",
};
ArmOperation<SqlFirewallRuleResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, firewallRuleName, data);
SqlFirewallRuleResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlFirewallRuleData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Exempelsvar

Statuskod:

200

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

Statuskod:

201

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

Update a firewall rule max/min

Exempelbegäran

HTTP

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

{
  "properties": {
    "startIpAddress": "0.0.0.1",
    "endIpAddress": "0.0.0.1"
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/FirewallRuleUpdate.json
// this example is just showing the usage of "FirewallRules_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "firewallrulecrudtest-12";
string serverName = "firewallrulecrudtest-6285";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlFirewallRuleResource
SqlFirewallRuleCollection collection = sqlServer.GetSqlFirewallRules();

// invoke the operation
string firewallRuleName = "firewallrulecrudtest-3927";
SqlFirewallRuleData data = new SqlFirewallRuleData
{
    StartIPAddress = "0.0.0.1",
    EndIPAddress = "0.0.0.1",
};
ArmOperation<SqlFirewallRuleResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, firewallRuleName, data);
SqlFirewallRuleResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlFirewallRuleData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Exempelsvar

Statuskod:

200

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

Statuskod:

201

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

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
FirewallRule	En brandväggsregel för servern.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

FirewallRule

Objekt

En brandväggsregel för servern.

Name	Typ	Description
id	string	Resurs-ID.
name	string	Resursnamn.
properties.endIpAddress	string	Brandväggsregelns slut-IP-adress. Måste vara IPv4-format. Måste vara större än eller lika med startIpAddress. Använd värdet "0.0.0.0" för alla Azure-interna IP-adresser.
properties.startIpAddress	string	Brandväggsregelns start-IP-adress. Måste vara IPv4-format. Använd värdet "0.0.0.0" för alla Azure-interna IP-adresser.
type	string	Resurstyp.