Azure Classic v5.39.0, Apr 1 23

azure.synapse.FirewallRule

Allows you to Manages a Synapse 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 exampleAccount = new Azure.Storage.Account("exampleAccount", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
        AccountKind = "StorageV2",
        IsHnsEnabled = true,
    });

    var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", new()
    {
        StorageAccountId = exampleAccount.Id,
    });

    var exampleWorkspace = new Azure.Synapse.Workspace("exampleWorkspace", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
        SqlAdministratorLogin = "sqladminuser",
        SqlAdministratorLoginPassword = "H@Sh1CoR3!",
        Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
        {
            Type = "SystemAssigned",
        },
    });

    var exampleFirewallRule = new Azure.Synapse.FirewallRule("exampleFirewallRule", new()
    {
        SynapseWorkspaceId = exampleWorkspace.Id,
        StartIpAddress = "0.0.0.0",
        EndIpAddress = "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 {
		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
		}
		exampleWorkspace, 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!"),
			Identity: &synapse.WorkspaceIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
		})
		if err != nil {
			return err
		}
		_, err = synapse.NewFirewallRule(ctx, "exampleFirewallRule", &synapse.FirewallRuleArgs{
			SynapseWorkspaceId: exampleWorkspace.ID(),
			StartIpAddress:     pulumi.String("0.0.0.0"),
			EndIpAddress:       pulumi.String("255.255.255.255"),
		})
		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.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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .accountKind("StorageV2")
            .isHnsEnabled("true")
            .build());

        var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()        
            .storageAccountId(exampleAccount.id())
            .build());

        var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .storageDataLakeGen2FilesystemId(exampleDataLakeGen2Filesystem.id())
            .sqlAdministratorLogin("sqladminuser")
            .sqlAdministratorLoginPassword("H@Sh1CoR3!")
            .identity(WorkspaceIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .build());

        var exampleFirewallRule = new FirewallRule("exampleFirewallRule", FirewallRuleArgs.builder()        
            .synapseWorkspaceId(exampleWorkspace.id())
            .startIpAddress("0.0.0.0")
            .endIpAddress("255.255.255.255")
            .build());

    }
}

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!",
    identity=azure.synapse.WorkspaceIdentityArgs(
        type="SystemAssigned",
    ))
example_firewall_rule = azure.synapse.FirewallRule("exampleFirewallRule",
    synapse_workspace_id=example_workspace.id,
    start_ip_address="0.0.0.0",
    end_ip_address="255.255.255.255")

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!",
    identity: {
        type: "SystemAssigned",
    },
});
const exampleFirewallRule = new azure.synapse.FirewallRule("exampleFirewallRule", {
    synapseWorkspaceId: exampleWorkspace.id,
    startIpAddress: "0.0.0.0",
    endIpAddress: "255.255.255.255",
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleAccount:
    type: azure:storage:Account
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      accountTier: Standard
      accountReplicationType: LRS
      accountKind: StorageV2
      isHnsEnabled: 'true'
  exampleDataLakeGen2Filesystem:
    type: azure:storage:DataLakeGen2Filesystem
    properties:
      storageAccountId: ${exampleAccount.id}
  exampleWorkspace:
    type: azure:synapse:Workspace
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      storageDataLakeGen2FilesystemId: ${exampleDataLakeGen2Filesystem.id}
      sqlAdministratorLogin: sqladminuser
      sqlAdministratorLoginPassword: H@Sh1CoR3!
      identity:
        type: SystemAssigned
  exampleFirewallRule:
    type: azure:synapse:FirewallRule
    properties:
      synapseWorkspaceId: ${exampleWorkspace.id}
      startIpAddress: 0.0.0.0
      endIpAddress: 255.255.255.255

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,
                 start_ip_address: Optional[str] = None,
                 synapse_workspace_id: 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:synapse: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.
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)

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. 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

Package Details

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