We recommend using Azure Native.
azure.synapse.FirewallRule
Explore with Pulumi AI
Allows you to Manages a Synapse 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 exampleAccount = new azure.storage.Account("example", {
name: "examplestorageacc",
resourceGroupName: example.name,
location: example.location,
accountTier: "Standard",
accountReplicationType: "LRS",
accountKind: "StorageV2",
isHnsEnabled: true,
});
const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("example", {
name: "example",
storageAccountId: exampleAccount.id,
});
const exampleWorkspace = new azure.synapse.Workspace("example", {
name: "example",
resourceGroupName: example.name,
location: example.location,
storageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.id,
sqlAdministratorLogin: "sqladminuser",
sqlAdministratorLoginPassword: "H@Sh1CoR3!",
identity: {
type: "SystemAssigned",
},
});
const exampleFirewallRule = new azure.synapse.FirewallRule("example", {
name: "AllowAll",
synapseWorkspaceId: exampleWorkspace.id,
startIpAddress: "0.0.0.0",
endIpAddress: "255.255.255.255",
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_account = azure.storage.Account("example",
name="examplestorageacc",
resource_group_name=example.name,
location=example.location,
account_tier="Standard",
account_replication_type="LRS",
account_kind="StorageV2",
is_hns_enabled=True)
example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("example",
name="example",
storage_account_id=example_account.id)
example_workspace = azure.synapse.Workspace("example",
name="example",
resource_group_name=example.name,
location=example.location,
storage_data_lake_gen2_filesystem_id=example_data_lake_gen2_filesystem.id,
sql_administrator_login="sqladminuser",
sql_administrator_login_password="H@Sh1CoR3!",
identity=azure.synapse.WorkspaceIdentityArgs(
type="SystemAssigned",
))
example_firewall_rule = azure.synapse.FirewallRule("example",
name="AllowAll",
synapse_workspace_id=example_workspace.id,
start_ip_address="0.0.0.0",
end_ip_address="255.255.255.255")
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/synapse"
"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
}
exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
Name: pulumi.String("examplestorageacc"),
ResourceGroupName: example.Name,
Location: example.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, "example", &storage.DataLakeGen2FilesystemArgs{
Name: pulumi.String("example"),
StorageAccountId: exampleAccount.ID(),
})
if err != nil {
return err
}
exampleWorkspace, err := synapse.NewWorkspace(ctx, "example", &synapse.WorkspaceArgs{
Name: pulumi.String("example"),
ResourceGroupName: example.Name,
Location: example.Location,
StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
SqlAdministratorLogin: pulumi.String("sqladminuser"),
SqlAdministratorLoginPassword: pulumi.String("H@Sh1CoR3!"),
Identity: &synapse.WorkspaceIdentityArgs{
Type: pulumi.String("SystemAssigned"),
},
})
if err != nil {
return err
}
_, err = synapse.NewFirewallRule(ctx, "example", &synapse.FirewallRuleArgs{
Name: pulumi.String("AllowAll"),
SynapseWorkspaceId: exampleWorkspace.ID(),
StartIpAddress: pulumi.String("0.0.0.0"),
EndIpAddress: pulumi.String("255.255.255.255"),
})
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 exampleAccount = new Azure.Storage.Account("example", new()
{
Name = "examplestorageacc",
ResourceGroupName = example.Name,
Location = example.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
AccountKind = "StorageV2",
IsHnsEnabled = true,
});
var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("example", new()
{
Name = "example",
StorageAccountId = exampleAccount.Id,
});
var exampleWorkspace = new Azure.Synapse.Workspace("example", new()
{
Name = "example",
ResourceGroupName = example.Name,
Location = example.Location,
StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
SqlAdministratorLogin = "sqladminuser",
SqlAdministratorLoginPassword = "H@Sh1CoR3!",
Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
{
Type = "SystemAssigned",
},
});
var exampleFirewallRule = new Azure.Synapse.FirewallRule("example", new()
{
Name = "AllowAll",
SynapseWorkspaceId = exampleWorkspace.Id,
StartIpAddress = "0.0.0.0",
EndIpAddress = "255.255.255.255",
});
});
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.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.DataLakeGen2Filesystem;
import com.pulumi.azure.storage.DataLakeGen2FilesystemArgs;
import com.pulumi.azure.synapse.Workspace;
import com.pulumi.azure.synapse.WorkspaceArgs;
import com.pulumi.azure.synapse.inputs.WorkspaceIdentityArgs;
import com.pulumi.azure.synapse.FirewallRule;
import com.pulumi.azure.synapse.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 exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.name("examplestorageacc")
.resourceGroupName(example.name())
.location(example.location())
.accountTier("Standard")
.accountReplicationType("LRS")
.accountKind("StorageV2")
.isHnsEnabled("true")
.build());
var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()
.name("example")
.storageAccountId(exampleAccount.id())
.build());
var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
.name("example")
.resourceGroupName(example.name())
.location(example.location())
.storageDataLakeGen2FilesystemId(exampleDataLakeGen2Filesystem.id())
.sqlAdministratorLogin("sqladminuser")
.sqlAdministratorLoginPassword("H@Sh1CoR3!")
.identity(WorkspaceIdentityArgs.builder()
.type("SystemAssigned")
.build())
.build());
var exampleFirewallRule = new FirewallRule("exampleFirewallRule", FirewallRuleArgs.builder()
.name("AllowAll")
.synapseWorkspaceId(exampleWorkspace.id())
.startIpAddress("0.0.0.0")
.endIpAddress("255.255.255.255")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleAccount:
type: azure:storage:Account
name: example
properties:
name: examplestorageacc
resourceGroupName: ${example.name}
location: ${example.location}
accountTier: Standard
accountReplicationType: LRS
accountKind: StorageV2
isHnsEnabled: 'true'
exampleDataLakeGen2Filesystem:
type: azure:storage:DataLakeGen2Filesystem
name: example
properties:
name: example
storageAccountId: ${exampleAccount.id}
exampleWorkspace:
type: azure:synapse:Workspace
name: example
properties:
name: example
resourceGroupName: ${example.name}
location: ${example.location}
storageDataLakeGen2FilesystemId: ${exampleDataLakeGen2Filesystem.id}
sqlAdministratorLogin: sqladminuser
sqlAdministratorLoginPassword: H@Sh1CoR3!
identity:
type: SystemAssigned
exampleFirewallRule:
type: azure:synapse:FirewallRule
name: example
properties:
name: AllowAll
synapseWorkspaceId: ${exampleWorkspace.id}
startIpAddress: 0.0.0.0
endIpAddress: 255.255.255.255
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 FirewallRule("examplefirewallRuleResourceResourceFromSynapsefirewallRule", 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
The FirewallRule resource accepts the following input properties:
- End
Ip stringAddress 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 settingstart_ip_address
andend_ip_address
to0.0.0.0
.NOTE: The Azure feature
Allow access to Azure services
requires thename
to beAllowAllWindowsAzureIps
.- Start
Ip stringAddress - The starting IP address to allow through the firewall for this rule.
- Synapse
Workspace stringId - 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 stringAddress 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 settingstart_ip_address
andend_ip_address
to0.0.0.0
.NOTE: The Azure feature
Allow access to Azure services
requires thename
to beAllowAllWindowsAzureIps
.- Start
Ip stringAddress - The starting IP address to allow through the firewall for this rule.
- Synapse
Workspace stringId - 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 StringAddress 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 settingstart_ip_address
andend_ip_address
to0.0.0.0
.NOTE: The Azure feature
Allow access to Azure services
requires thename
to beAllowAllWindowsAzureIps
.- start
Ip StringAddress - The starting IP address to allow through the firewall for this rule.
- synapse
Workspace StringId - 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 stringAddress 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 settingstart_ip_address
andend_ip_address
to0.0.0.0
.NOTE: The Azure feature
Allow access to Azure services
requires thename
to beAllowAllWindowsAzureIps
.- start
Ip stringAddress - The starting IP address to allow through the firewall for this rule.
- synapse
Workspace stringId - 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_ straddress 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 settingstart_ip_address
andend_ip_address
to0.0.0.0
.NOTE: The Azure feature
Allow access to Azure services
requires thename
to beAllowAllWindowsAzureIps
.- start_
ip_ straddress - The starting IP address to allow through the firewall for this rule.
- synapse_
workspace_ strid - 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.
- end
Ip StringAddress 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 settingstart_ip_address
andend_ip_address
to0.0.0.0
.NOTE: The Azure feature
Allow access to Azure services
requires thename
to beAllowAllWindowsAzureIps
.- start
Ip StringAddress - The starting IP address to allow through the firewall for this rule.
- synapse
Workspace StringId - 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)
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.
- End
Ip stringAddress 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 settingstart_ip_address
andend_ip_address
to0.0.0.0
.NOTE: The Azure feature
Allow access to Azure services
requires thename
to beAllowAllWindowsAzureIps
.- Name string
- The Name of the firewall rule. Changing this forces a new resource to be created.
- Start
Ip stringAddress - The starting IP address to allow through the firewall for this rule.
- Synapse
Workspace stringId - The ID of the Synapse Workspace on which to create the Firewall Rule. Changing this forces a new resource to be created.
- End
Ip stringAddress 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 settingstart_ip_address
andend_ip_address
to0.0.0.0
.NOTE: The Azure feature
Allow access to Azure services
requires thename
to beAllowAllWindowsAzureIps
.- Name string
- The Name of the firewall rule. Changing this forces a new resource to be created.
- Start
Ip stringAddress - The starting IP address to allow through the firewall for this rule.
- Synapse
Workspace stringId - The ID of the Synapse Workspace on which to create the Firewall Rule. Changing this forces a new resource to be created.
- end
Ip StringAddress 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 settingstart_ip_address
andend_ip_address
to0.0.0.0
.NOTE: The Azure feature
Allow access to Azure services
requires thename
to beAllowAllWindowsAzureIps
.- name String
- The Name of the firewall rule. Changing this forces a new resource to be created.
- start
Ip StringAddress - The starting IP address to allow through the firewall for this rule.
- synapse
Workspace StringId - The ID of the Synapse Workspace on which to create the Firewall Rule. Changing this forces a new resource to be created.
- end
Ip stringAddress 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 settingstart_ip_address
andend_ip_address
to0.0.0.0
.NOTE: The Azure feature
Allow access to Azure services
requires thename
to beAllowAllWindowsAzureIps
.- name string
- The Name of the firewall rule. Changing this forces a new resource to be created.
- start
Ip stringAddress - The starting IP address to allow through the firewall for this rule.
- synapse
Workspace stringId - The ID of the Synapse Workspace on which to create the Firewall Rule. Changing this forces a new resource to be created.
- end_
ip_ straddress 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 settingstart_ip_address
andend_ip_address
to0.0.0.0
.NOTE: The Azure feature
Allow access to Azure services
requires thename
to beAllowAllWindowsAzureIps
.- name str
- The Name of the firewall rule. Changing this forces a new resource to be created.
- start_
ip_ straddress - The starting IP address to allow through the firewall for this rule.
- synapse_
workspace_ strid - The ID of the Synapse Workspace on which to create the Firewall Rule. Changing this forces a new resource to be created.
- end
Ip StringAddress 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 settingstart_ip_address
andend_ip_address
to0.0.0.0
.NOTE: The Azure feature
Allow access to Azure services
requires thename
to beAllowAllWindowsAzureIps
.- name String
- The Name of the firewall rule. Changing this forces a new resource to be created.
- start
Ip StringAddress - The starting IP address to allow through the firewall for this rule.
- synapse
Workspace StringId - 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.