1. Packages
  2. Azure Classic
  3. API Docs
  4. mssql
  5. FirewallRule

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.mssql.FirewallRule

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Allows you to manage an Azure SQL Firewall Rule.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleServer = new azure.mssql.Server("example", {
        name: "mysqlserver",
        resourceGroupName: example.name,
        location: example.location,
        version: "12.0",
        administratorLogin: "4dm1n157r470r",
        administratorLoginPassword: "4-v3ry-53cr37-p455w0rd",
    });
    const exampleFirewallRule = new azure.mssql.FirewallRule("example", {
        name: "FirewallRule1",
        serverId: exampleServer.id,
        startIpAddress: "10.0.17.62",
        endIpAddress: "10.0.17.62",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_server = azure.mssql.Server("example",
        name="mysqlserver",
        resource_group_name=example.name,
        location=example.location,
        version="12.0",
        administrator_login="4dm1n157r470r",
        administrator_login_password="4-v3ry-53cr37-p455w0rd")
    example_firewall_rule = azure.mssql.FirewallRule("example",
        name="FirewallRule1",
        server_id=example_server.id,
        start_ip_address="10.0.17.62",
        end_ip_address="10.0.17.62")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/mssql"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleServer, err := mssql.NewServer(ctx, "example", &mssql.ServerArgs{
    			Name:                       pulumi.String("mysqlserver"),
    			ResourceGroupName:          example.Name,
    			Location:                   example.Location,
    			Version:                    pulumi.String("12.0"),
    			AdministratorLogin:         pulumi.String("4dm1n157r470r"),
    			AdministratorLoginPassword: pulumi.String("4-v3ry-53cr37-p455w0rd"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = mssql.NewFirewallRule(ctx, "example", &mssql.FirewallRuleArgs{
    			Name:           pulumi.String("FirewallRule1"),
    			ServerId:       exampleServer.ID(),
    			StartIpAddress: pulumi.String("10.0.17.62"),
    			EndIpAddress:   pulumi.String("10.0.17.62"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleServer = new Azure.MSSql.Server("example", new()
        {
            Name = "mysqlserver",
            ResourceGroupName = example.Name,
            Location = example.Location,
            Version = "12.0",
            AdministratorLogin = "4dm1n157r470r",
            AdministratorLoginPassword = "4-v3ry-53cr37-p455w0rd",
        });
    
        var exampleFirewallRule = new Azure.MSSql.FirewallRule("example", new()
        {
            Name = "FirewallRule1",
            ServerId = exampleServer.Id,
            StartIpAddress = "10.0.17.62",
            EndIpAddress = "10.0.17.62",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.mssql.Server;
    import com.pulumi.azure.mssql.ServerArgs;
    import com.pulumi.azure.mssql.FirewallRule;
    import com.pulumi.azure.mssql.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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleServer = new Server("exampleServer", ServerArgs.builder()
                .name("mysqlserver")
                .resourceGroupName(example.name())
                .location(example.location())
                .version("12.0")
                .administratorLogin("4dm1n157r470r")
                .administratorLoginPassword("4-v3ry-53cr37-p455w0rd")
                .build());
    
            var exampleFirewallRule = new FirewallRule("exampleFirewallRule", FirewallRuleArgs.builder()
                .name("FirewallRule1")
                .serverId(exampleServer.id())
                .startIpAddress("10.0.17.62")
                .endIpAddress("10.0.17.62")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleServer:
        type: azure:mssql:Server
        name: example
        properties:
          name: mysqlserver
          resourceGroupName: ${example.name}
          location: ${example.location}
          version: '12.0'
          administratorLogin: 4dm1n157r470r
          administratorLoginPassword: 4-v3ry-53cr37-p455w0rd
      exampleFirewallRule:
        type: azure:mssql:FirewallRule
        name: example
        properties:
          name: FirewallRule1
          serverId: ${exampleServer.id}
          startIpAddress: 10.0.17.62
          endIpAddress: 10.0.17.62
    

    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,
                     end_ip_address: Optional[str] = None,
                     server_id: Optional[str] = None,
                     start_ip_address: Optional[str] = None,
                     name: 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:mssql: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.

    Example

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

    var azureFirewallRuleResource = new Azure.MSSql.FirewallRule("azureFirewallRuleResource", new()
    {
        EndIpAddress = "string",
        ServerId = "string",
        StartIpAddress = "string",
        Name = "string",
    });
    
    example, err := mssql.NewFirewallRule(ctx, "azureFirewallRuleResource", &mssql.FirewallRuleArgs{
    	EndIpAddress:   pulumi.String("string"),
    	ServerId:       pulumi.String("string"),
    	StartIpAddress: pulumi.String("string"),
    	Name:           pulumi.String("string"),
    })
    
    var azureFirewallRuleResource = new FirewallRule("azureFirewallRuleResource", FirewallRuleArgs.builder()
        .endIpAddress("string")
        .serverId("string")
        .startIpAddress("string")
        .name("string")
        .build());
    
    azure_firewall_rule_resource = azure.mssql.FirewallRule("azureFirewallRuleResource",
        end_ip_address="string",
        server_id="string",
        start_ip_address="string",
        name="string")
    
    const azureFirewallRuleResource = new azure.mssql.FirewallRule("azureFirewallRuleResource", {
        endIpAddress: "string",
        serverId: "string",
        startIpAddress: "string",
        name: "string",
    });
    
    type: azure:mssql:FirewallRule
    properties:
        endIpAddress: string
        name: string
        serverId: 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

    The FirewallRule resource accepts the following input properties:

    EndIpAddress string

    The ending IP address to allow through the firewall for this rule.

    NOTE: The Azure feature Allow access to Azure services can be enabled by setting start_ip_address and end_ip_address to 0.0.0.0 which (is documented in the Azure API Docs).

    ServerId string
    The resource ID of the SQL Server on which to create the Firewall Rule. Changing this forces a new resource to be created.
    StartIpAddress string
    The starting IP address to allow through the firewall for this rule.
    Name string
    The name of the firewall rule. Changing this forces a new resource to be created.
    EndIpAddress string

    The ending IP address to allow through the firewall for this rule.

    NOTE: The Azure feature Allow access to Azure services can be enabled by setting start_ip_address and end_ip_address to 0.0.0.0 which (is documented in the Azure API Docs).

    ServerId string
    The resource ID of the SQL Server on which to create the Firewall Rule. Changing this forces a new resource to be created.
    StartIpAddress string
    The starting IP address to allow through the firewall for this rule.
    Name string
    The name of the firewall rule. Changing this forces a new resource to be created.
    endIpAddress String

    The ending IP address to allow through the firewall for this rule.

    NOTE: The Azure feature Allow access to Azure services can be enabled by setting start_ip_address and end_ip_address to 0.0.0.0 which (is documented in the Azure API Docs).

    serverId String
    The resource ID of the SQL Server on which to create the Firewall Rule. Changing this forces a new resource to be created.
    startIpAddress String
    The starting IP address to allow through the firewall for this rule.
    name String
    The name of the firewall rule. Changing this forces a new resource to be created.
    endIpAddress string

    The ending IP address to allow through the firewall for this rule.

    NOTE: The Azure feature Allow access to Azure services can be enabled by setting start_ip_address and end_ip_address to 0.0.0.0 which (is documented in the Azure API Docs).

    serverId string
    The resource ID of the SQL Server on which to create the Firewall Rule. Changing this forces a new resource to be created.
    startIpAddress string
    The starting IP address to allow through the firewall for this rule.
    name string
    The name of the firewall rule. Changing this forces a new resource to be created.
    end_ip_address str

    The ending IP address to allow through the firewall for this rule.

    NOTE: The Azure feature Allow access to Azure services can be enabled by setting start_ip_address and end_ip_address to 0.0.0.0 which (is documented in the Azure API Docs).

    server_id str
    The resource ID of the SQL Server on which to create the Firewall Rule. Changing this forces a new resource to be created.
    start_ip_address str
    The starting IP address to allow through the firewall for this rule.
    name str
    The name of the firewall rule. Changing this forces a new resource to be created.
    endIpAddress String

    The ending IP address to allow through the firewall for this rule.

    NOTE: The Azure feature Allow access to Azure services can be enabled by setting start_ip_address and end_ip_address to 0.0.0.0 which (is documented in the Azure API Docs).

    serverId String
    The resource ID of the SQL Server on which to create the Firewall Rule. Changing this forces a new resource to be created.
    startIpAddress String
    The starting IP address to allow through the firewall for this rule.
    name String
    The name of the firewall rule. Changing this forces a new resource to be created.

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FirewallRule Resource

    Get an existing FirewallRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FirewallRuleState, opts?: CustomResourceOptions): FirewallRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            end_ip_address: Optional[str] = None,
            name: Optional[str] = None,
            server_id: Optional[str] = None,
            start_ip_address: Optional[str] = None) -> FirewallRule
    func GetFirewallRule(ctx *Context, name string, id IDInput, state *FirewallRuleState, opts ...ResourceOption) (*FirewallRule, error)
    public static FirewallRule Get(string name, Input<string> id, FirewallRuleState? state, CustomResourceOptions? opts = null)
    public static FirewallRule get(String name, Output<String> id, FirewallRuleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    EndIpAddress string

    The ending IP address to allow through the firewall for this rule.

    NOTE: The Azure feature Allow access to Azure services can be enabled by setting start_ip_address and end_ip_address to 0.0.0.0 which (is documented in the Azure API Docs).

    Name string
    The name of the firewall rule. Changing this forces a new resource to be created.
    ServerId string
    The resource ID of the SQL Server on which to create the Firewall Rule. Changing this forces a new resource to be created.
    StartIpAddress string
    The starting IP address to allow through the firewall for this rule.
    EndIpAddress string

    The ending IP address to allow through the firewall for this rule.

    NOTE: The Azure feature Allow access to Azure services can be enabled by setting start_ip_address and end_ip_address to 0.0.0.0 which (is documented in the Azure API Docs).

    Name string
    The name of the firewall rule. Changing this forces a new resource to be created.
    ServerId string
    The resource ID of the SQL Server on which to create the Firewall Rule. Changing this forces a new resource to be created.
    StartIpAddress string
    The starting IP address to allow through the firewall for this rule.
    endIpAddress String

    The ending IP address to allow through the firewall for this rule.

    NOTE: The Azure feature Allow access to Azure services can be enabled by setting start_ip_address and end_ip_address to 0.0.0.0 which (is documented in the Azure API Docs).

    name String
    The name of the firewall rule. Changing this forces a new resource to be created.
    serverId String
    The resource ID of the SQL Server on which to create the Firewall Rule. Changing this forces a new resource to be created.
    startIpAddress String
    The starting IP address to allow through the firewall for this rule.
    endIpAddress string

    The ending IP address to allow through the firewall for this rule.

    NOTE: The Azure feature Allow access to Azure services can be enabled by setting start_ip_address and end_ip_address to 0.0.0.0 which (is documented in the Azure API Docs).

    name string
    The name of the firewall rule. Changing this forces a new resource to be created.
    serverId string
    The resource ID of the SQL Server on which to create the Firewall Rule. Changing this forces a new resource to be created.
    startIpAddress string
    The starting IP address to allow through the firewall for this rule.
    end_ip_address str

    The ending IP address to allow through the firewall for this rule.

    NOTE: The Azure feature Allow access to Azure services can be enabled by setting start_ip_address and end_ip_address to 0.0.0.0 which (is documented in the Azure API Docs).

    name str
    The name of the firewall rule. Changing this forces a new resource to be created.
    server_id str
    The resource ID of the SQL Server on which to create the Firewall Rule. Changing this forces a new resource to be created.
    start_ip_address str
    The starting IP address to allow through the firewall for this rule.
    endIpAddress String

    The ending IP address to allow through the firewall for this rule.

    NOTE: The Azure feature Allow access to Azure services can be enabled by setting start_ip_address and end_ip_address to 0.0.0.0 which (is documented in the Azure API Docs).

    name String
    The name of the firewall rule. Changing this forces a new resource to be created.
    serverId String
    The resource ID of the SQL Server on which to create the Firewall Rule. Changing this forces a new resource to be created.
    startIpAddress String
    The starting IP address to allow through the firewall for this rule.

    Import

    SQL Firewall Rules can be imported using the resource id, e.g.

    $ pulumi import azure:mssql/firewallRule:FirewallRule rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Sql/servers/myserver/firewallRules/rule1
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi