Azure Classic

v5.24.0 published on Wednesday, Nov 9, 2022 by Pulumi

FirewallRule

Allows you to manage an Azure SQL Firewall Rule.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleServer = new Azure.MSSql.Server("exampleServer", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        Version = "12.0",
        AdministratorLogin = "4dm1n157r470r",
        AdministratorLoginPassword = "4-v3ry-53cr37-p455w0rd",
    });

    var exampleFirewallRule = new Azure.MSSql.FirewallRule("exampleFirewallRule", new()
    {
        ServerId = exampleServer.Id,
        StartIpAddress = "10.0.17.62",
        EndIpAddress = "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 {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleServer, err := mssql.NewServer(ctx, "exampleServer", &mssql.ServerArgs{
			ResourceGroupName:          exampleResourceGroup.Name,
			Location:                   exampleResourceGroup.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, "exampleFirewallRule", &mssql.FirewallRuleArgs{
			ServerId:       exampleServer.ID(),
			StartIpAddress: pulumi.String("10.0.17.62"),
			EndIpAddress:   pulumi.String("10.0.17.62"),
		})
		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.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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleServer = new Server("exampleServer", ServerArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .version("12.0")
            .administratorLogin("4dm1n157r470r")
            .administratorLoginPassword("4-v3ry-53cr37-p455w0rd")
            .build());

        var exampleFirewallRule = new FirewallRule("exampleFirewallRule", FirewallRuleArgs.builder()        
            .serverId(exampleServer.id())
            .startIpAddress("10.0.17.62")
            .endIpAddress("10.0.17.62")
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_server = azure.mssql.Server("exampleServer",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    version="12.0",
    administrator_login="4dm1n157r470r",
    administrator_login_password="4-v3ry-53cr37-p455w0rd")
example_firewall_rule = azure.mssql.FirewallRule("exampleFirewallRule",
    server_id=example_server.id,
    start_ip_address="10.0.17.62",
    end_ip_address="10.0.17.62")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleServer = new azure.mssql.Server("exampleServer", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    version: "12.0",
    administratorLogin: "4dm1n157r470r",
    administratorLoginPassword: "4-v3ry-53cr37-p455w0rd",
});
const exampleFirewallRule = new azure.mssql.FirewallRule("exampleFirewallRule", {
    serverId: exampleServer.id,
    startIpAddress: "10.0.17.62",
    endIpAddress: "10.0.17.62",
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleServer:
    type: azure:mssql:Server
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      version: 12.0
      administratorLogin: 4dm1n157r470r
      administratorLoginPassword: 4-v3ry-53cr37-p455w0rd
  exampleFirewallRule:
    type: azure:mssql:FirewallRule
    properties:
      serverId: ${exampleServer.id}
      startIpAddress: 10.0.17.62
      endIpAddress: 10.0.17.62

Create FirewallRule Resource

new FirewallRule(name: string, args: FirewallRuleArgs, opts?: CustomResourceOptions);
@overload
def FirewallRule(resource_name: 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)
@overload
def FirewallRule(resource_name: str,
                 args: FirewallRuleArgs,
                 opts: Optional[ResourceOptions] = 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.

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.

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.

ServerId string

The resource ID of the SQL Server on which to create the Firewall Rule.

StartIpAddress string

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

Name string

The name of the firewall rule.

EndIpAddress string

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

ServerId string

The resource ID of the SQL Server on which to create the Firewall Rule.

StartIpAddress string

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

Name string

The name of the firewall rule.

endIpAddress String

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

serverId String

The resource ID of the SQL Server on which to create the Firewall Rule.

startIpAddress String

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

name String

The name of the firewall rule.

endIpAddress string

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

serverId string

The resource ID of the SQL Server on which to create the Firewall Rule.

startIpAddress string

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

name string

The name of the firewall rule.

end_ip_address str

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

server_id str

The resource ID of the SQL Server on which to create the Firewall Rule.

start_ip_address str

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

name str

The name of the firewall rule.

endIpAddress String

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

serverId String

The resource ID of the SQL Server on which to create the Firewall Rule.

startIpAddress String

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

name String

The name of the firewall rule.

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.

Name string

The name of the firewall rule.

ServerId string

The resource ID of the SQL Server on which to create the Firewall Rule.

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.

Name string

The name of the firewall rule.

ServerId string

The resource ID of the SQL Server on which to create the Firewall Rule.

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.

name String

The name of the firewall rule.

serverId String

The resource ID of the SQL Server on which to create the Firewall Rule.

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.

name string

The name of the firewall rule.

serverId string

The resource ID of the SQL Server on which to create the Firewall Rule.

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.

name str

The name of the firewall rule.

server_id str

The resource ID of the SQL Server on which to create the Firewall Rule.

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.

name String

The name of the firewall rule.

serverId String

The resource ID of the SQL Server on which to create the Firewall Rule.

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.