1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. FirewallRule
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.sql.FirewallRule

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    A server firewall rule. Azure REST API version: 2021-11-01. Prior API version in Azure Native 1.x: 2020-11-01-preview.

    Other available API versions: 2014-04-01, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview.

    Example Usage

    Create a firewall rule max/min

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var firewallRule = new AzureNative.Sql.FirewallRule("firewallRule", new()
        {
            EndIpAddress = "0.0.0.3",
            FirewallRuleName = "firewallrulecrudtest-5370",
            ResourceGroupName = "firewallrulecrudtest-12",
            ServerName = "firewallrulecrudtest-6285",
            StartIpAddress = "0.0.0.3",
        });
    
    });
    
    package main
    
    import (
    	sql "github.com/pulumi/pulumi-azure-native-sdk/sql/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sql.NewFirewallRule(ctx, "firewallRule", &sql.FirewallRuleArgs{
    			EndIpAddress:      pulumi.String("0.0.0.3"),
    			FirewallRuleName:  pulumi.String("firewallrulecrudtest-5370"),
    			ResourceGroupName: pulumi.String("firewallrulecrudtest-12"),
    			ServerName:        pulumi.String("firewallrulecrudtest-6285"),
    			StartIpAddress:    pulumi.String("0.0.0.3"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.sql.FirewallRule;
    import com.pulumi.azurenative.sql.FirewallRuleArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var firewallRule = new FirewallRule("firewallRule", FirewallRuleArgs.builder()
                .endIpAddress("0.0.0.3")
                .firewallRuleName("firewallrulecrudtest-5370")
                .resourceGroupName("firewallrulecrudtest-12")
                .serverName("firewallrulecrudtest-6285")
                .startIpAddress("0.0.0.3")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    firewall_rule = azure_native.sql.FirewallRule("firewallRule",
        end_ip_address="0.0.0.3",
        firewall_rule_name="firewallrulecrudtest-5370",
        resource_group_name="firewallrulecrudtest-12",
        server_name="firewallrulecrudtest-6285",
        start_ip_address="0.0.0.3")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const firewallRule = new azure_native.sql.FirewallRule("firewallRule", {
        endIpAddress: "0.0.0.3",
        firewallRuleName: "firewallrulecrudtest-5370",
        resourceGroupName: "firewallrulecrudtest-12",
        serverName: "firewallrulecrudtest-6285",
        startIpAddress: "0.0.0.3",
    });
    
    resources:
      firewallRule:
        type: azure-native:sql:FirewallRule
        properties:
          endIpAddress: 0.0.0.3
          firewallRuleName: firewallrulecrudtest-5370
          resourceGroupName: firewallrulecrudtest-12
          serverName: firewallrulecrudtest-6285
          startIpAddress: 0.0.0.3
    

    Update a firewall rule max/min

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var firewallRule = new AzureNative.Sql.FirewallRule("firewallRule", new()
        {
            EndIpAddress = "0.0.0.1",
            FirewallRuleName = "firewallrulecrudtest-3927",
            ResourceGroupName = "firewallrulecrudtest-12",
            ServerName = "firewallrulecrudtest-6285",
            StartIpAddress = "0.0.0.1",
        });
    
    });
    
    package main
    
    import (
    	sql "github.com/pulumi/pulumi-azure-native-sdk/sql/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sql.NewFirewallRule(ctx, "firewallRule", &sql.FirewallRuleArgs{
    			EndIpAddress:      pulumi.String("0.0.0.1"),
    			FirewallRuleName:  pulumi.String("firewallrulecrudtest-3927"),
    			ResourceGroupName: pulumi.String("firewallrulecrudtest-12"),
    			ServerName:        pulumi.String("firewallrulecrudtest-6285"),
    			StartIpAddress:    pulumi.String("0.0.0.1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.sql.FirewallRule;
    import com.pulumi.azurenative.sql.FirewallRuleArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var firewallRule = new FirewallRule("firewallRule", FirewallRuleArgs.builder()
                .endIpAddress("0.0.0.1")
                .firewallRuleName("firewallrulecrudtest-3927")
                .resourceGroupName("firewallrulecrudtest-12")
                .serverName("firewallrulecrudtest-6285")
                .startIpAddress("0.0.0.1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    firewall_rule = azure_native.sql.FirewallRule("firewallRule",
        end_ip_address="0.0.0.1",
        firewall_rule_name="firewallrulecrudtest-3927",
        resource_group_name="firewallrulecrudtest-12",
        server_name="firewallrulecrudtest-6285",
        start_ip_address="0.0.0.1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const firewallRule = new azure_native.sql.FirewallRule("firewallRule", {
        endIpAddress: "0.0.0.1",
        firewallRuleName: "firewallrulecrudtest-3927",
        resourceGroupName: "firewallrulecrudtest-12",
        serverName: "firewallrulecrudtest-6285",
        startIpAddress: "0.0.0.1",
    });
    
    resources:
      firewallRule:
        type: azure-native:sql:FirewallRule
        properties:
          endIpAddress: 0.0.0.1
          firewallRuleName: firewallrulecrudtest-3927
          resourceGroupName: firewallrulecrudtest-12
          serverName: firewallrulecrudtest-6285
          startIpAddress: 0.0.0.1
    

    Create FirewallRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FirewallRule(name: string, args: FirewallRuleArgs, opts?: CustomResourceOptions);
    @overload
    def FirewallRule(resource_name: str,
                     args: FirewallRuleArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def FirewallRule(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     resource_group_name: Optional[str] = None,
                     server_name: Optional[str] = None,
                     end_ip_address: Optional[str] = None,
                     firewall_rule_name: Optional[str] = None,
                     name: Optional[str] = None,
                     start_ip_address: Optional[str] = None)
    func NewFirewallRule(ctx *Context, name string, args FirewallRuleArgs, opts ...ResourceOption) (*FirewallRule, error)
    public FirewallRule(string name, FirewallRuleArgs args, CustomResourceOptions? opts = null)
    public FirewallRule(String name, FirewallRuleArgs args)
    public FirewallRule(String name, FirewallRuleArgs args, CustomResourceOptions options)
    
    type: azure-native:sql:FirewallRule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args FirewallRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FirewallRuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FirewallRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FirewallRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FirewallRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var examplefirewallRuleResourceResourceFromSql = new AzureNative.Sql.FirewallRule("examplefirewallRuleResourceResourceFromSql", new()
    {
        ResourceGroupName = "string",
        ServerName = "string",
        EndIpAddress = "string",
        FirewallRuleName = "string",
        Name = "string",
        StartIpAddress = "string",
    });
    
    example, err := sql.NewFirewallRule(ctx, "examplefirewallRuleResourceResourceFromSql", &sql.FirewallRuleArgs{
    	ResourceGroupName: pulumi.String("string"),
    	ServerName:        pulumi.String("string"),
    	EndIpAddress:      pulumi.String("string"),
    	FirewallRuleName:  pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	StartIpAddress:    pulumi.String("string"),
    })
    
    var examplefirewallRuleResourceResourceFromSql = new FirewallRule("examplefirewallRuleResourceResourceFromSql", FirewallRuleArgs.builder()
        .resourceGroupName("string")
        .serverName("string")
        .endIpAddress("string")
        .firewallRuleName("string")
        .name("string")
        .startIpAddress("string")
        .build());
    
    examplefirewall_rule_resource_resource_from_sql = azure_native.sql.FirewallRule("examplefirewallRuleResourceResourceFromSql",
        resource_group_name="string",
        server_name="string",
        end_ip_address="string",
        firewall_rule_name="string",
        name="string",
        start_ip_address="string")
    
    const examplefirewallRuleResourceResourceFromSql = new azure_native.sql.FirewallRule("examplefirewallRuleResourceResourceFromSql", {
        resourceGroupName: "string",
        serverName: "string",
        endIpAddress: "string",
        firewallRuleName: "string",
        name: "string",
        startIpAddress: "string",
    });
    
    type: azure-native:sql:FirewallRule
    properties:
        endIpAddress: string
        firewallRuleName: string
        name: string
        resourceGroupName: string
        serverName: string
        startIpAddress: string
    

    FirewallRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The FirewallRule resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ServerName string
    The name of the server.
    EndIpAddress string
    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' for all Azure-internal IP addresses.
    FirewallRuleName string
    The name of the firewall rule.
    Name string
    Resource name.
    StartIpAddress string
    The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ServerName string
    The name of the server.
    EndIpAddress string
    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' for all Azure-internal IP addresses.
    FirewallRuleName string
    The name of the firewall rule.
    Name string
    Resource name.
    StartIpAddress string
    The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName String
    The name of the server.
    endIpAddress String
    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' for all Azure-internal IP addresses.
    firewallRuleName String
    The name of the firewall rule.
    name String
    Resource name.
    startIpAddress String
    The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses.
    resourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName string
    The name of the server.
    endIpAddress string
    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' for all Azure-internal IP addresses.
    firewallRuleName string
    The name of the firewall rule.
    name string
    Resource name.
    startIpAddress string
    The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses.
    resource_group_name str
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    server_name str
    The name of the server.
    end_ip_address str
    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' for all Azure-internal IP addresses.
    firewall_rule_name str
    The name of the firewall rule.
    name str
    Resource name.
    start_ip_address str
    The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName String
    The name of the server.
    endIpAddress String
    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' for all Azure-internal IP addresses.
    firewallRuleName String
    The name of the firewall rule.
    name String
    Resource name.
    startIpAddress String
    The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FirewallRule resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Resource type.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Resource type.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Resource type.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Resource type.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:sql:FirewallRule firewallrulecrudtest-3927 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules/{firewallRuleName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi