pulumi-azure-kotlin/com.pulumi.azure.mysql.kotlin/FirewallRuleArgs

FirewallRuleArgs

data class FirewallRuleArgs(val endIpAddress: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val serverName: Output<String>? = null, val startIpAddress: Output<String>? = null) : ConvertibleToJava<FirewallRuleArgs>

Manages a Firewall Rule for a MySQL Server.

Note: Azure Database for MySQL Single Server and its sub resources are scheduled for retirement by 2024-09-16 and will migrate to using Azure Database for MySQL Flexible Server: https://go.microsoft.com/fwlink/?linkid=2216041. The azure.mysql.FirewallRule resource is deprecated and will be removed in v4.0 of the AzureRM Provider. Please use the azure.mysql.FlexibleServerFirewallRule resource instead.

Example Usage

Single IP Address)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
    name: "api-rg-pro",
    location: "West Europe",
});
const exampleServer = new azure.mysql.Server("example", {
    name: "example",
    location: example.location,
    resourceGroupName: example.name,
    version: "5.7",
    skuName: "GP_Gen5_2",
    sslEnforcementEnabled: true,
});
const exampleFirewallRule = new azure.mysql.FirewallRule("example", {
    name: "office",
    resourceGroupName: example.name,
    serverName: exampleServer.name,
    startIpAddress: "40.112.8.12",
    endIpAddress: "40.112.8.12",
});
Content copied to clipboard
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
    name="api-rg-pro",
    location="West Europe")
example_server = azure.mysql.Server("example",
    name="example",
    location=example.location,
    resource_group_name=example.name,
    version="5.7",
    sku_name="GP_Gen5_2",
    ssl_enforcement_enabled=True)
example_firewall_rule = azure.mysql.FirewallRule("example",
    name="office",
    resource_group_name=example.name,
    server_name=example_server.name,
    start_ip_address="40.112.8.12",
    end_ip_address="40.112.8.12")
Content copied to clipboard
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 = "api-rg-pro",
        Location = "West Europe",
    });
    var exampleServer = new Azure.MySql.Server("example", new()
    {
        Name = "example",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Version = "5.7",
        SkuName = "GP_Gen5_2",
        SslEnforcementEnabled = true,
    });
    var exampleFirewallRule = new Azure.MySql.FirewallRule("example", new()
    {
        Name = "office",
        ResourceGroupName = example.Name,
        ServerName = exampleServer.Name,
        StartIpAddress = "40.112.8.12",
        EndIpAddress = "40.112.8.12",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/mysql"
	"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("api-rg-pro"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleServer, err := mysql.NewServer(ctx, "example", &mysql.ServerArgs{
			Name:                  pulumi.String("example"),
			Location:              example.Location,
			ResourceGroupName:     example.Name,
			Version:               pulumi.String("5.7"),
			SkuName:               pulumi.String("GP_Gen5_2"),
			SslEnforcementEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = mysql.NewFirewallRule(ctx, "example", &mysql.FirewallRuleArgs{
			Name:              pulumi.String("office"),
			ResourceGroupName: example.Name,
			ServerName:        exampleServer.Name,
			StartIpAddress:    pulumi.String("40.112.8.12"),
			EndIpAddress:      pulumi.String("40.112.8.12"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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.mysql.Server;
import com.pulumi.azure.mysql.ServerArgs;
import com.pulumi.azure.mysql.FirewallRule;
import com.pulumi.azure.mysql.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("api-rg-pro")
            .location("West Europe")
            .build());
        var exampleServer = new Server("exampleServer", ServerArgs.builder()
            .name("example")
            .location(example.location())
            .resourceGroupName(example.name())
            .version("5.7")
            .skuName("GP_Gen5_2")
            .sslEnforcementEnabled(true)
            .build());
        var exampleFirewallRule = new FirewallRule("exampleFirewallRule", FirewallRuleArgs.builder()
            .name("office")
            .resourceGroupName(example.name())
            .serverName(exampleServer.name())
            .startIpAddress("40.112.8.12")
            .endIpAddress("40.112.8.12")
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: api-rg-pro
      location: West Europe
  exampleServer:
    type: azure:mysql:Server
    name: example
    properties:
      name: example
      location: ${example.location}
      resourceGroupName: ${example.name}
      version: '5.7'
      skuName: GP_Gen5_2
      sslEnforcementEnabled: true
  exampleFirewallRule:
    type: azure:mysql:FirewallRule
    name: example
    properties:
      name: office
      resourceGroupName: ${example.name}
      serverName: ${exampleServer.name}
      startIpAddress: 40.112.8.12
      endIpAddress: 40.112.8.12
Content copied to clipboard

IP Range)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
    name: "api-rg-pro",
    location: "West Europe",
});
const exampleServer = new azure.mysql.Server("example", {});
const exampleFirewallRule = new azure.mysql.FirewallRule("example", {
    name: "office",
    resourceGroupName: example.name,
    serverName: exampleServer.name,
    startIpAddress: "40.112.0.0",
    endIpAddress: "40.112.255.255",
});
Content copied to clipboard
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
    name="api-rg-pro",
    location="West Europe")
example_server = azure.mysql.Server("example")
example_firewall_rule = azure.mysql.FirewallRule("example",
    name="office",
    resource_group_name=example.name,
    server_name=example_server.name,
    start_ip_address="40.112.0.0",
    end_ip_address="40.112.255.255")
Content copied to clipboard
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 = "api-rg-pro",
        Location = "West Europe",
    });
    var exampleServer = new Azure.MySql.Server("example");
    var exampleFirewallRule = new Azure.MySql.FirewallRule("example", new()
    {
        Name = "office",
        ResourceGroupName = example.Name,
        ServerName = exampleServer.Name,
        StartIpAddress = "40.112.0.0",
        EndIpAddress = "40.112.255.255",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/mysql"
	"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("api-rg-pro"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleServer, err := mysql.NewServer(ctx, "example", nil)
		if err != nil {
			return err
		}
		_, err = mysql.NewFirewallRule(ctx, "example", &mysql.FirewallRuleArgs{
			Name:              pulumi.String("office"),
			ResourceGroupName: example.Name,
			ServerName:        exampleServer.Name,
			StartIpAddress:    pulumi.String("40.112.0.0"),
			EndIpAddress:      pulumi.String("40.112.255.255"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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.mysql.Server;
import com.pulumi.azure.mysql.FirewallRule;
import com.pulumi.azure.mysql.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("api-rg-pro")
            .location("West Europe")
            .build());
        var exampleServer = new Server("exampleServer");
        var exampleFirewallRule = new FirewallRule("exampleFirewallRule", FirewallRuleArgs.builder()
            .name("office")
            .resourceGroupName(example.name())
            .serverName(exampleServer.name())
            .startIpAddress("40.112.0.0")
            .endIpAddress("40.112.255.255")
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: api-rg-pro
      location: West Europe
  exampleServer:
    type: azure:mysql:Server
    name: example
  exampleFirewallRule:
    type: azure:mysql:FirewallRule
    name: example
    properties:
      name: office
      resourceGroupName: ${example.name}
      serverName: ${exampleServer.name}
      startIpAddress: 40.112.0.0
      endIpAddress: 40.112.255.255
Content copied to clipboard

Allow Access To Azure Services)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
    name: "api-rg-pro",
    location: "West Europe",
});
const exampleServer = new azure.mysql.Server("example", {});
const exampleFirewallRule = new azure.mysql.FirewallRule("example", {
    name: "office",
    resourceGroupName: example.name,
    serverName: exampleServer.name,
    startIpAddress: "0.0.0.0",
    endIpAddress: "0.0.0.0",
});
Content copied to clipboard
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
    name="api-rg-pro",
    location="West Europe")
example_server = azure.mysql.Server("example")
example_firewall_rule = azure.mysql.FirewallRule("example",
    name="office",
    resource_group_name=example.name,
    server_name=example_server.name,
    start_ip_address="0.0.0.0",
    end_ip_address="0.0.0.0")
Content copied to clipboard
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 = "api-rg-pro",
        Location = "West Europe",
    });
    var exampleServer = new Azure.MySql.Server("example");
    var exampleFirewallRule = new Azure.MySql.FirewallRule("example", new()
    {
        Name = "office",
        ResourceGroupName = example.Name,
        ServerName = exampleServer.Name,
        StartIpAddress = "0.0.0.0",
        EndIpAddress = "0.0.0.0",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/mysql"
	"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("api-rg-pro"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleServer, err := mysql.NewServer(ctx, "example", nil)
		if err != nil {
			return err
		}
		_, err = mysql.NewFirewallRule(ctx, "example", &mysql.FirewallRuleArgs{
			Name:              pulumi.String("office"),
			ResourceGroupName: example.Name,
			ServerName:        exampleServer.Name,
			StartIpAddress:    pulumi.String("0.0.0.0"),
			EndIpAddress:      pulumi.String("0.0.0.0"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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.mysql.Server;
import com.pulumi.azure.mysql.FirewallRule;
import com.pulumi.azure.mysql.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("api-rg-pro")
            .location("West Europe")
            .build());
        var exampleServer = new Server("exampleServer");
        var exampleFirewallRule = new FirewallRule("exampleFirewallRule", FirewallRuleArgs.builder()
            .name("office")
            .resourceGroupName(example.name())
            .serverName(exampleServer.name())
            .startIpAddress("0.0.0.0")
            .endIpAddress("0.0.0.0")
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: api-rg-pro
      location: West Europe
  exampleServer:
    type: azure:mysql:Server
    name: example
  exampleFirewallRule:
    type: azure:mysql:FirewallRule
    name: example
    properties:
      name: office
      resourceGroupName: ${example.name}
      serverName: ${exampleServer.name}
      startIpAddress: 0.0.0.0
      endIpAddress: 0.0.0.0
Content copied to clipboard

Import

MySQL Firewall Rule's can be imported using the resource id, e.g.

$ pulumi import azure:mysql/firewallRule:FirewallRule rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.DBforMySQL/servers/server1/firewallRules/rule1
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(endIpAddress: Output<String>? = null, name: Output<String>? = null, resourceGroupName: Output<String>? = null, serverName: Output<String>? = null, startIpAddress: Output<String>? = null)

Properties

Link copied to clipboard
val endIpAddress: Output<String>? = null

Specifies the End IP Address associated with this Firewall Rule.

Link copied to clipboard
val name: Output<String>? = null

Specifies the name of the MySQL Firewall Rule. Changing this forces a new resource to be created.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.

Link copied to clipboard
val serverName: Output<String>? = null

Specifies the name of the MySQL Server. Changing this forces a new resource to be created.

Link copied to clipboard
val startIpAddress: Output<String>? = null

Specifies the Start IP Address associated with this Firewall Rule.

Functions

Link copied to clipboard
open override fun toJava(): FirewallRuleArgs