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

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.synapse.FirewallRule

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Allows you to Manages a Synapse Firewall Rule.

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
            AccountKind = "StorageV2",
            IsHnsEnabled = true,
        });
        var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", new Azure.Storage.DataLakeGen2FilesystemArgs
        {
            StorageAccountId = exampleAccount.Id,
        });
        var exampleWorkspace = new Azure.Synapse.Workspace("exampleWorkspace", new Azure.Synapse.WorkspaceArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
            SqlAdministratorLogin = "sqladminuser",
            SqlAdministratorLoginPassword = "H@Sh1CoR3!",
        });
        var exampleFirewallRule = new Azure.Synapse.FirewallRule("exampleFirewallRule", new Azure.Synapse.FirewallRuleArgs
        {
            SynapseWorkspaceId = azurerm_synapse_workspace.Test.Id,
            StartIpAddress = "0.0.0.0",
            EndIpAddress = "255.255.255.255",
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/storage"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/synapse"
	"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
		}
		exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
			ResourceGroupName:      exampleResourceGroup.Name,
			Location:               exampleResourceGroup.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
			AccountKind:            pulumi.String("StorageV2"),
			IsHnsEnabled:           pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleDataLakeGen2Filesystem, err := storage.NewDataLakeGen2Filesystem(ctx, "exampleDataLakeGen2Filesystem", &storage.DataLakeGen2FilesystemArgs{
			StorageAccountId: exampleAccount.ID(),
		})
		if err != nil {
			return err
		}
		_, err = synapse.NewWorkspace(ctx, "exampleWorkspace", &synapse.WorkspaceArgs{
			ResourceGroupName:               exampleResourceGroup.Name,
			Location:                        exampleResourceGroup.Location,
			StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
			SqlAdministratorLogin:           pulumi.String("sqladminuser"),
			SqlAdministratorLoginPassword:   pulumi.String("H@Sh1CoR3!"),
		})
		if err != nil {
			return err
		}
		_, err = synapse.NewFirewallRule(ctx, "exampleFirewallRule", &synapse.FirewallRuleArgs{
			SynapseWorkspaceId: pulumi.Any(azurerm_synapse_workspace.Test.Id),
			StartIpAddress:     pulumi.String("0.0.0.0"),
			EndIpAddress:       pulumi.String("255.255.255.255"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
    accountKind: "StorageV2",
    isHnsEnabled: "true",
});
const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", {storageAccountId: exampleAccount.id});
const exampleWorkspace = new azure.synapse.Workspace("exampleWorkspace", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    storageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.id,
    sqlAdministratorLogin: "sqladminuser",
    sqlAdministratorLoginPassword: "H@Sh1CoR3!",
});
const exampleFirewallRule = new azure.synapse.FirewallRule("exampleFirewallRule", {
    synapseWorkspaceId: azurerm_synapse_workspace.test.id,
    startIpAddress: "0.0.0.0",
    endIpAddress: "255.255.255.255",
});

    import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS",
    account_kind="StorageV2",
    is_hns_enabled=True)
example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", storage_account_id=example_account.id)
example_workspace = azure.synapse.Workspace("exampleWorkspace",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    storage_data_lake_gen2_filesystem_id=example_data_lake_gen2_filesystem.id,
    sql_administrator_login="sqladminuser",
    sql_administrator_login_password="H@Sh1CoR3!")
example_firewall_rule = azure.synapse.FirewallRule("exampleFirewallRule",
    synapse_workspace_id=azurerm_synapse_workspace["test"]["id"],
    start_ip_address="0.0.0.0",
    end_ip_address="255.255.255.255")

    Example coming soon!

    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,
                 start_ip_address: Optional[str] = None,
                 synapse_workspace_id: 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:synapse: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 examplefirewallRuleResourceResourceFromSynapsefirewallRule = new Azure.Synapse.FirewallRule("examplefirewallRuleResourceResourceFromSynapsefirewallRule", new()
{
    EndIpAddress = "string",
    StartIpAddress = "string",
    SynapseWorkspaceId = "string",
    Name = "string",
});

    example, err := synapse.NewFirewallRule(ctx, "examplefirewallRuleResourceResourceFromSynapsefirewallRule", &synapse.FirewallRuleArgs{
	EndIpAddress:       pulumi.String("string"),
	StartIpAddress:     pulumi.String("string"),
	SynapseWorkspaceId: pulumi.String("string"),
	Name:               pulumi.String("string"),
})

    var examplefirewallRuleResourceResourceFromSynapsefirewallRule = new com.pulumi.azure.synapse.FirewallRule("examplefirewallRuleResourceResourceFromSynapsefirewallRule", com.pulumi.azure.synapse.FirewallRuleArgs.builder()
    .endIpAddress("string")
    .startIpAddress("string")
    .synapseWorkspaceId("string")
    .name("string")
    .build());

    examplefirewall_rule_resource_resource_from_synapsefirewall_rule = azure.synapse.FirewallRule("examplefirewallRuleResourceResourceFromSynapsefirewallRule",
    end_ip_address="string",
    start_ip_address="string",
    synapse_workspace_id="string",
    name="string")

    const examplefirewallRuleResourceResourceFromSynapsefirewallRule = new azure.synapse.FirewallRule("examplefirewallRuleResourceResourceFromSynapsefirewallRule", {
    endIpAddress: "string",
    startIpAddress: "string",
    synapseWorkspaceId: "string",
    name: "string",
});

    type: azure:synapse:FirewallRule
properties:
    endIpAddress: string
    name: string
    startIpAddress: string
    synapseWorkspaceId: 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:

    EndIpAddress string
    The ending IP address to allow through the firewall for this rule.
    StartIpAddress string
    The starting IP address to allow through the firewall for this rule.
    SynapseWorkspaceId string
    The ID of the Synapse Workspace on which to create the Firewall Rule. Changing this forces a new resource to be created.
    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.
    StartIpAddress string
    The starting IP address to allow through the firewall for this rule.
    SynapseWorkspaceId string
    The ID of the Synapse Workspace on which to create the Firewall Rule. Changing this forces a new resource to be created.
    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.
    startIpAddress String
    The starting IP address to allow through the firewall for this rule.
    synapseWorkspaceId String
    The ID of the Synapse Workspace on which to create the Firewall Rule. Changing this forces a new resource to be created.
    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.
    startIpAddress string
    The starting IP address to allow through the firewall for this rule.
    synapseWorkspaceId string
    The ID of the Synapse Workspace on which to create the Firewall Rule. Changing this forces a new resource to be created.
    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.
    start_ip_address str
    The starting IP address to allow through the firewall for this rule.
    synapse_workspace_id str
    The ID of the Synapse Workspace on which to create the Firewall Rule. Changing this forces a new resource to be created.
    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.
    startIpAddress String
    The starting IP address to allow through the firewall for this rule.
    synapseWorkspaceId String
    The ID of the Synapse Workspace on which to create the Firewall Rule. Changing this forces a new resource to be created.
    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,
        start_ip_address: Optional[str] = None,
        synapse_workspace_id: 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)
    resources:  _:    type: azure:synapse:FirewallRule    get:      id: ${id}
    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. Changing this forces a new resource to be created.
    StartIpAddress string
    The starting IP address to allow through the firewall for this rule.
    SynapseWorkspaceId string
    The ID of the Synapse Workspace on which to create 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.
    Name string
    The Name of 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.
    SynapseWorkspaceId string
    The ID of the Synapse Workspace on which to create 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.
    name String
    The Name of 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.
    synapseWorkspaceId String
    The ID of the Synapse Workspace on which to create 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.
    name string
    The Name of 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.
    synapseWorkspaceId string
    The ID of the Synapse Workspace on which to create 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.
    name str
    The Name of 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.
    synapse_workspace_id str
    The ID of the Synapse Workspace on which to create 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.
    name String
    The Name of 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.
    synapseWorkspaceId String
    The ID of the Synapse Workspace on which to create the Firewall Rule. Changing this forces a new resource to be created.

    Import

    Synapse Firewall Rule can be imported using the resource id, e.g.

     $ pulumi import azure:synapse/firewallRule:FirewallRule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup1/providers/Microsoft.Synapse/workspaces/workspace1/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.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.