Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. synapse
  5. IpFirewallRule
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.synapse.IpFirewallRule

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

IP firewall rule Azure REST API version: 2021-06-01. Prior API version in Azure Native 1.x: 2021-03-01.

Other available API versions: 2021-06-01-preview.

Example Usage

Create an IP firewall rule

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var ipFirewallRule = new AzureNative.Synapse.IpFirewallRule("ipFirewallRule", new()
    {
        EndIpAddress = "10.0.0.254",
        ResourceGroupName = "ExampleResourceGroup",
        RuleName = "ExampleIpFirewallRule",
        StartIpAddress = "10.0.0.0",
        WorkspaceName = "ExampleWorkspace",
    });

});
Copy
package main

import (
	synapse "github.com/pulumi/pulumi-azure-native-sdk/synapse/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synapse.NewIpFirewallRule(ctx, "ipFirewallRule", &synapse.IpFirewallRuleArgs{
			EndIpAddress:      pulumi.String("10.0.0.254"),
			ResourceGroupName: pulumi.String("ExampleResourceGroup"),
			RuleName:          pulumi.String("ExampleIpFirewallRule"),
			StartIpAddress:    pulumi.String("10.0.0.0"),
			WorkspaceName:     pulumi.String("ExampleWorkspace"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.synapse.IpFirewallRule;
import com.pulumi.azurenative.synapse.IpFirewallRuleArgs;
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 ipFirewallRule = new IpFirewallRule("ipFirewallRule", IpFirewallRuleArgs.builder()
            .endIpAddress("10.0.0.254")
            .resourceGroupName("ExampleResourceGroup")
            .ruleName("ExampleIpFirewallRule")
            .startIpAddress("10.0.0.0")
            .workspaceName("ExampleWorkspace")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const ipFirewallRule = new azure_native.synapse.IpFirewallRule("ipFirewallRule", {
    endIpAddress: "10.0.0.254",
    resourceGroupName: "ExampleResourceGroup",
    ruleName: "ExampleIpFirewallRule",
    startIpAddress: "10.0.0.0",
    workspaceName: "ExampleWorkspace",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

ip_firewall_rule = azure_native.synapse.IpFirewallRule("ipFirewallRule",
    end_ip_address="10.0.0.254",
    resource_group_name="ExampleResourceGroup",
    rule_name="ExampleIpFirewallRule",
    start_ip_address="10.0.0.0",
    workspace_name="ExampleWorkspace")
Copy
resources:
  ipFirewallRule:
    type: azure-native:synapse:IpFirewallRule
    properties:
      endIpAddress: 10.0.0.254
      resourceGroupName: ExampleResourceGroup
      ruleName: ExampleIpFirewallRule
      startIpAddress: 10.0.0.0
      workspaceName: ExampleWorkspace
Copy

Create IpFirewallRule Resource

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

Constructor syntax

new IpFirewallRule(name: string, args: IpFirewallRuleArgs, opts?: CustomResourceOptions);
@overload
def IpFirewallRule(resource_name: str,
                   args: IpFirewallRuleArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def IpFirewallRule(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   resource_group_name: Optional[str] = None,
                   workspace_name: Optional[str] = None,
                   end_ip_address: Optional[str] = None,
                   rule_name: Optional[str] = None,
                   start_ip_address: Optional[str] = None)
func NewIpFirewallRule(ctx *Context, name string, args IpFirewallRuleArgs, opts ...ResourceOption) (*IpFirewallRule, error)
public IpFirewallRule(string name, IpFirewallRuleArgs args, CustomResourceOptions? opts = null)
public IpFirewallRule(String name, IpFirewallRuleArgs args)
public IpFirewallRule(String name, IpFirewallRuleArgs args, CustomResourceOptions options)

type: azure-native:synapse:IpFirewallRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IpFirewallRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IpFirewallRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IpFirewallRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IpFirewallRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IpFirewallRuleArgs
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 ipFirewallRuleResource = new AzureNative.Synapse.IpFirewallRule("ipFirewallRuleResource", new()
{
    ResourceGroupName = "string",
    WorkspaceName = "string",
    EndIpAddress = "string",
    RuleName = "string",
    StartIpAddress = "string",
});
Copy
example, err := synapse.NewIpFirewallRule(ctx, "ipFirewallRuleResource", &synapse.IpFirewallRuleArgs{
	ResourceGroupName: "string",
	WorkspaceName:     "string",
	EndIpAddress:      "string",
	RuleName:          "string",
	StartIpAddress:    "string",
})
Copy
var ipFirewallRuleResource = new IpFirewallRule("ipFirewallRuleResource", IpFirewallRuleArgs.builder()
    .resourceGroupName("string")
    .workspaceName("string")
    .endIpAddress("string")
    .ruleName("string")
    .startIpAddress("string")
    .build());
Copy
ip_firewall_rule_resource = azure_native.synapse.IpFirewallRule("ipFirewallRuleResource",
    resource_group_name=string,
    workspace_name=string,
    end_ip_address=string,
    rule_name=string,
    start_ip_address=string)
Copy
const ipFirewallRuleResource = new azure_native.synapse.IpFirewallRule("ipFirewallRuleResource", {
    resourceGroupName: "string",
    workspaceName: "string",
    endIpAddress: "string",
    ruleName: "string",
    startIpAddress: "string",
});
Copy
type: azure-native:synapse:IpFirewallRule
properties:
    endIpAddress: string
    resourceGroupName: string
    ruleName: string
    startIpAddress: string
    workspaceName: string
Copy

IpFirewallRule 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 IpFirewallRule resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
EndIpAddress string
The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress
RuleName Changes to this property will trigger replacement. string
The IP firewall rule name
StartIpAddress string
The start IP address of the firewall rule. Must be IPv4 format
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
EndIpAddress string
The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress
RuleName Changes to this property will trigger replacement. string
The IP firewall rule name
StartIpAddress string
The start IP address of the firewall rule. Must be IPv4 format
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
endIpAddress String
The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress
ruleName Changes to this property will trigger replacement. String
The IP firewall rule name
startIpAddress String
The start IP address of the firewall rule. Must be IPv4 format
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
endIpAddress string
The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress
ruleName Changes to this property will trigger replacement. string
The IP firewall rule name
startIpAddress string
The start IP address of the firewall rule. Must be IPv4 format
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
end_ip_address str
The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress
rule_name Changes to this property will trigger replacement. str
The IP firewall rule name
start_ip_address str
The start IP address of the firewall rule. Must be IPv4 format
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
endIpAddress String
The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress
ruleName Changes to this property will trigger replacement. String
The IP firewall rule name
startIpAddress String
The start IP address of the firewall rule. Must be IPv4 format

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Resource provisioning state
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Resource provisioning state
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Resource provisioning state
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
provisioningState string
Resource provisioning state
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
provisioning_state str
Resource provisioning state
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Resource provisioning state
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Import

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

$ pulumi import azure-native:synapse:IpFirewallRule ExampleIpFirewallRule /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/firewallRules/{ruleName}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native