All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.synapse.kotlin.FirewallRuleArgs.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.synapse.kotlin

import com.pulumi.azure.synapse.FirewallRuleArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 * Allows you to Manages a Synapse Firewall Rule.
 * ## Example Usage
 * 
 * ```typescript
 * 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",
 * });
 * ```
 * ```python
 * 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={
 *         "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")
 * ```
 * ```csharp
 * 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",
 *     });
 * });
 * ```
 * ```go
 * 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
 * 	})
 * }
 * ```
 * ```java
 * 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());
 *     }
 * }
 * ```
 * ```yaml
 * 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
 * ```
 * 
 * ## Import
 * Synapse Firewall Rule can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:synapse/firewallRule:FirewallRule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup1/providers/Microsoft.Synapse/workspaces/workspace1/firewallRules/rule1
 * ```
 * @property endIpAddress 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 setting `start_ip_address` and `end_ip_address` to `0.0.0.0`.
 * > **NOTE:** The Azure feature `Allow access to Azure services` requires the `name` to be `AllowAllWindowsAzureIps`.
 * @property name The Name of the firewall rule. Changing this forces a new resource to be created.
 * @property startIpAddress The starting IP address to allow through the firewall for this rule.
 * @property synapseWorkspaceId The ID of the Synapse Workspace on which to create the Firewall Rule. Changing this forces a new resource to be created.
 */
public data class FirewallRuleArgs(
    public val endIpAddress: Output? = null,
    public val name: Output? = null,
    public val startIpAddress: Output? = null,
    public val synapseWorkspaceId: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.azure.synapse.FirewallRuleArgs =
        com.pulumi.azure.synapse.FirewallRuleArgs.builder()
            .endIpAddress(endIpAddress?.applyValue({ args0 -> args0 }))
            .name(name?.applyValue({ args0 -> args0 }))
            .startIpAddress(startIpAddress?.applyValue({ args0 -> args0 }))
            .synapseWorkspaceId(synapseWorkspaceId?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [FirewallRuleArgs].
 */
@PulumiTagMarker
public class FirewallRuleArgsBuilder internal constructor() {
    private var endIpAddress: Output? = null

    private var name: Output? = null

    private var startIpAddress: Output? = null

    private var synapseWorkspaceId: Output? = null

    /**
     * @param value 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 setting `start_ip_address` and `end_ip_address` to `0.0.0.0`.
     * > **NOTE:** The Azure feature `Allow access to Azure services` requires the `name` to be `AllowAllWindowsAzureIps`.
     */
    @JvmName("tltbdlmwtkhmudpn")
    public suspend fun endIpAddress(`value`: Output) {
        this.endIpAddress = value
    }

    /**
     * @param value The Name of the firewall rule. Changing this forces a new resource to be created.
     */
    @JvmName("ohapvnsrjlanteic")
    public suspend fun name(`value`: Output) {
        this.name = value
    }

    /**
     * @param value The starting IP address to allow through the firewall for this rule.
     */
    @JvmName("husdrwnnltggdknf")
    public suspend fun startIpAddress(`value`: Output) {
        this.startIpAddress = value
    }

    /**
     * @param value The ID of the Synapse Workspace on which to create the Firewall Rule. Changing this forces a new resource to be created.
     */
    @JvmName("yquhbmgkekibhcju")
    public suspend fun synapseWorkspaceId(`value`: Output) {
        this.synapseWorkspaceId = value
    }

    /**
     * @param value 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 setting `start_ip_address` and `end_ip_address` to `0.0.0.0`.
     * > **NOTE:** The Azure feature `Allow access to Azure services` requires the `name` to be `AllowAllWindowsAzureIps`.
     */
    @JvmName("ncktegvcxikrsplo")
    public suspend fun endIpAddress(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.endIpAddress = mapped
    }

    /**
     * @param value The Name of the firewall rule. Changing this forces a new resource to be created.
     */
    @JvmName("yaygkmkxohijumxu")
    public suspend fun name(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.name = mapped
    }

    /**
     * @param value The starting IP address to allow through the firewall for this rule.
     */
    @JvmName("cvwjufhuvqdbsncy")
    public suspend fun startIpAddress(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.startIpAddress = mapped
    }

    /**
     * @param value The ID of the Synapse Workspace on which to create the Firewall Rule. Changing this forces a new resource to be created.
     */
    @JvmName("maysvsdjkwcjodmt")
    public suspend fun synapseWorkspaceId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.synapseWorkspaceId = mapped
    }

    internal fun build(): FirewallRuleArgs = FirewallRuleArgs(
        endIpAddress = endIpAddress,
        name = name,
        startIpAddress = startIpAddress,
        synapseWorkspaceId = synapseWorkspaceId,
    )
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy