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

com.pulumi.azure.mysql.kotlin.VirtualNetworkRuleArgs.kt Maven / Gradle / Ivy

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

package com.pulumi.azure.mysql.kotlin

import com.pulumi.azure.mysql.VirtualNetworkRuleArgs.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

/**
 * Manages a MySQL Virtual Network Rule.
 * > **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.VirtualNetworkRule` resource is deprecated and will be removed in v4.0 of the AzureRM Provider.
 * > **NOTE:** MySQL Virtual Network Rules [can only be used with SKU Tiers of `GeneralPurpose` or `MemoryOptimized`](https://docs.microsoft.com/azure/mysql/concepts-data-access-and-security-vnet)
 * ## 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 exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
 *     name: "example-vnet",
 *     addressSpaces: ["10.7.29.0/29"],
 *     location: example.location,
 *     resourceGroupName: example.name,
 * });
 * const internal = new azure.network.Subnet("internal", {
 *     name: "internal",
 *     resourceGroupName: example.name,
 *     virtualNetworkName: exampleVirtualNetwork.name,
 *     addressPrefixes: ["10.7.29.0/29"],
 *     serviceEndpoints: ["Microsoft.Sql"],
 * });
 * const exampleServer = new azure.mysql.Server("example", {
 *     name: "example-mysqlserver",
 *     location: example.location,
 *     resourceGroupName: example.name,
 *     administratorLogin: "mysqladminun",
 *     administratorLoginPassword: "H@Sh1CoR3!",
 *     skuName: "GP_Gen5_2",
 *     storageMb: 5120,
 *     version: "5.7",
 *     backupRetentionDays: 7,
 *     geoRedundantBackupEnabled: false,
 *     sslEnforcementEnabled: true,
 * });
 * const exampleVirtualNetworkRule = new azure.mysql.VirtualNetworkRule("example", {
 *     name: "mysql-vnet-rule",
 *     resourceGroupName: example.name,
 *     serverName: exampleServer.name,
 *     subnetId: internal.id,
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.core.ResourceGroup("example",
 *     name="example-resources",
 *     location="West Europe")
 * example_virtual_network = azure.network.VirtualNetwork("example",
 *     name="example-vnet",
 *     address_spaces=["10.7.29.0/29"],
 *     location=example.location,
 *     resource_group_name=example.name)
 * internal = azure.network.Subnet("internal",
 *     name="internal",
 *     resource_group_name=example.name,
 *     virtual_network_name=example_virtual_network.name,
 *     address_prefixes=["10.7.29.0/29"],
 *     service_endpoints=["Microsoft.Sql"])
 * example_server = azure.mysql.Server("example",
 *     name="example-mysqlserver",
 *     location=example.location,
 *     resource_group_name=example.name,
 *     administrator_login="mysqladminun",
 *     administrator_login_password="H@Sh1CoR3!",
 *     sku_name="GP_Gen5_2",
 *     storage_mb=5120,
 *     version="5.7",
 *     backup_retention_days=7,
 *     geo_redundant_backup_enabled=False,
 *     ssl_enforcement_enabled=True)
 * example_virtual_network_rule = azure.mysql.VirtualNetworkRule("example",
 *     name="mysql-vnet-rule",
 *     resource_group_name=example.name,
 *     server_name=example_server.name,
 *     subnet_id=internal.id)
 * ```
 * ```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 exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
 *     {
 *         Name = "example-vnet",
 *         AddressSpaces = new[]
 *         {
 *             "10.7.29.0/29",
 *         },
 *         Location = example.Location,
 *         ResourceGroupName = example.Name,
 *     });
 *     var @internal = new Azure.Network.Subnet("internal", new()
 *     {
 *         Name = "internal",
 *         ResourceGroupName = example.Name,
 *         VirtualNetworkName = exampleVirtualNetwork.Name,
 *         AddressPrefixes = new[]
 *         {
 *             "10.7.29.0/29",
 *         },
 *         ServiceEndpoints = new[]
 *         {
 *             "Microsoft.Sql",
 *         },
 *     });
 *     var exampleServer = new Azure.MySql.Server("example", new()
 *     {
 *         Name = "example-mysqlserver",
 *         Location = example.Location,
 *         ResourceGroupName = example.Name,
 *         AdministratorLogin = "mysqladminun",
 *         AdministratorLoginPassword = "H@Sh1CoR3!",
 *         SkuName = "GP_Gen5_2",
 *         StorageMb = 5120,
 *         Version = "5.7",
 *         BackupRetentionDays = 7,
 *         GeoRedundantBackupEnabled = false,
 *         SslEnforcementEnabled = true,
 *     });
 *     var exampleVirtualNetworkRule = new Azure.MySql.VirtualNetworkRule("example", new()
 *     {
 *         Name = "mysql-vnet-rule",
 *         ResourceGroupName = example.Name,
 *         ServerName = exampleServer.Name,
 *         SubnetId = @internal.Id,
 *     });
 * });
 * ```
 * ```go
 * 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-azure/sdk/v5/go/azure/network"
 * 	"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
 * 		}
 * 		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
 * 			Name: pulumi.String("example-vnet"),
 * 			AddressSpaces: pulumi.StringArray{
 * 				pulumi.String("10.7.29.0/29"),
 * 			},
 * 			Location:          example.Location,
 * 			ResourceGroupName: example.Name,
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		internal, err := network.NewSubnet(ctx, "internal", &network.SubnetArgs{
 * 			Name:               pulumi.String("internal"),
 * 			ResourceGroupName:  example.Name,
 * 			VirtualNetworkName: exampleVirtualNetwork.Name,
 * 			AddressPrefixes: pulumi.StringArray{
 * 				pulumi.String("10.7.29.0/29"),
 * 			},
 * 			ServiceEndpoints: pulumi.StringArray{
 * 				pulumi.String("Microsoft.Sql"),
 * 			},
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleServer, err := mysql.NewServer(ctx, "example", &mysql.ServerArgs{
 * 			Name:                       pulumi.String("example-mysqlserver"),
 * 			Location:                   example.Location,
 * 			ResourceGroupName:          example.Name,
 * 			AdministratorLogin:         pulumi.String("mysqladminun"),
 * 			AdministratorLoginPassword: pulumi.String("H@Sh1CoR3!"),
 * 			SkuName:                    pulumi.String("GP_Gen5_2"),
 * 			StorageMb:                  pulumi.Int(5120),
 * 			Version:                    pulumi.String("5.7"),
 * 			BackupRetentionDays:        pulumi.Int(7),
 * 			GeoRedundantBackupEnabled:  pulumi.Bool(false),
 * 			SslEnforcementEnabled:      pulumi.Bool(true),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = mysql.NewVirtualNetworkRule(ctx, "example", &mysql.VirtualNetworkRuleArgs{
 * 			Name:              pulumi.String("mysql-vnet-rule"),
 * 			ResourceGroupName: example.Name,
 * 			ServerName:        exampleServer.Name,
 * 			SubnetId:          internal.ID(),
 * 		})
 * 		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.network.VirtualNetwork;
 * import com.pulumi.azure.network.VirtualNetworkArgs;
 * import com.pulumi.azure.network.Subnet;
 * import com.pulumi.azure.network.SubnetArgs;
 * import com.pulumi.azure.mysql.Server;
 * import com.pulumi.azure.mysql.ServerArgs;
 * import com.pulumi.azure.mysql.VirtualNetworkRule;
 * import com.pulumi.azure.mysql.VirtualNetworkRuleArgs;
 * 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 exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
 *             .name("example-vnet")
 *             .addressSpaces("10.7.29.0/29")
 *             .location(example.location())
 *             .resourceGroupName(example.name())
 *             .build());
 *         var internal = new Subnet("internal", SubnetArgs.builder()
 *             .name("internal")
 *             .resourceGroupName(example.name())
 *             .virtualNetworkName(exampleVirtualNetwork.name())
 *             .addressPrefixes("10.7.29.0/29")
 *             .serviceEndpoints("Microsoft.Sql")
 *             .build());
 *         var exampleServer = new Server("exampleServer", ServerArgs.builder()
 *             .name("example-mysqlserver")
 *             .location(example.location())
 *             .resourceGroupName(example.name())
 *             .administratorLogin("mysqladminun")
 *             .administratorLoginPassword("H@Sh1CoR3!")
 *             .skuName("GP_Gen5_2")
 *             .storageMb(5120)
 *             .version("5.7")
 *             .backupRetentionDays(7)
 *             .geoRedundantBackupEnabled(false)
 *             .sslEnforcementEnabled(true)
 *             .build());
 *         var exampleVirtualNetworkRule = new VirtualNetworkRule("exampleVirtualNetworkRule", VirtualNetworkRuleArgs.builder()
 *             .name("mysql-vnet-rule")
 *             .resourceGroupName(example.name())
 *             .serverName(exampleServer.name())
 *             .subnetId(internal.id())
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:core:ResourceGroup
 *     properties:
 *       name: example-resources
 *       location: West Europe
 *   exampleVirtualNetwork:
 *     type: azure:network:VirtualNetwork
 *     name: example
 *     properties:
 *       name: example-vnet
 *       addressSpaces:
 *         - 10.7.29.0/29
 *       location: ${example.location}
 *       resourceGroupName: ${example.name}
 *   internal:
 *     type: azure:network:Subnet
 *     properties:
 *       name: internal
 *       resourceGroupName: ${example.name}
 *       virtualNetworkName: ${exampleVirtualNetwork.name}
 *       addressPrefixes:
 *         - 10.7.29.0/29
 *       serviceEndpoints:
 *         - Microsoft.Sql
 *   exampleServer:
 *     type: azure:mysql:Server
 *     name: example
 *     properties:
 *       name: example-mysqlserver
 *       location: ${example.location}
 *       resourceGroupName: ${example.name}
 *       administratorLogin: mysqladminun
 *       administratorLoginPassword: H@Sh1CoR3!
 *       skuName: GP_Gen5_2
 *       storageMb: 5120
 *       version: '5.7'
 *       backupRetentionDays: 7
 *       geoRedundantBackupEnabled: false
 *       sslEnforcementEnabled: true
 *   exampleVirtualNetworkRule:
 *     type: azure:mysql:VirtualNetworkRule
 *     name: example
 *     properties:
 *       name: mysql-vnet-rule
 *       resourceGroupName: ${example.name}
 *       serverName: ${exampleServer.name}
 *       subnetId: ${internal.id}
 * ```
 * 
 * ## Import
 * MySQL Virtual Network Rules can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:mysql/virtualNetworkRule:VirtualNetworkRule rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.DBforMySQL/servers/myserver/virtualNetworkRules/vnetrulename
 * ```
 * @property name The name of the MySQL Virtual Network Rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.
 * > **NOTE:** `name` must be between 1-128 characters long and must satisfy all of the requirements below:
 * 1. Contains only alphanumeric and hyphen characters
 * 2. Cannot start with a number or hyphen
 * 3. Cannot end with a hyphen
 * @property resourceGroupName The name of the resource group where the MySQL server resides. Changing this forces a new resource to be created.
 * @property serverName The name of the SQL Server to which this MySQL virtual network rule will be applied to. Changing this forces a new resource to be created.
 * @property subnetId The ID of the subnet that the MySQL server will be connected to.
 * > **NOTE:** Due to [a bug in the Azure API](https://github.com/Azure/azure-rest-api-specs/issues/3719) this resource currently doesn't expose the `ignore_missing_vnet_service_endpoint` field and defaults this to `false`. This provider will check during the provisioning of the Virtual Network Rule that the Subnet contains the Service Rule to verify that the Virtual Network Rule can be created.
 */
public data class VirtualNetworkRuleArgs(
    public val name: Output? = null,
    public val resourceGroupName: Output? = null,
    public val serverName: Output? = null,
    public val subnetId: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.azure.mysql.VirtualNetworkRuleArgs =
        com.pulumi.azure.mysql.VirtualNetworkRuleArgs.builder()
            .name(name?.applyValue({ args0 -> args0 }))
            .resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
            .serverName(serverName?.applyValue({ args0 -> args0 }))
            .subnetId(subnetId?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [VirtualNetworkRuleArgs].
 */
@PulumiTagMarker
public class VirtualNetworkRuleArgsBuilder internal constructor() {
    private var name: Output? = null

    private var resourceGroupName: Output? = null

    private var serverName: Output? = null

    private var subnetId: Output? = null

    /**
     * @param value The name of the MySQL Virtual Network Rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.
     * > **NOTE:** `name` must be between 1-128 characters long and must satisfy all of the requirements below:
     * 1. Contains only alphanumeric and hyphen characters
     * 2. Cannot start with a number or hyphen
     * 3. Cannot end with a hyphen
     */
    @JvmName("lruwoksybpcamaps")
    public suspend fun name(`value`: Output) {
        this.name = value
    }

    /**
     * @param value The name of the resource group where the MySQL server resides. Changing this forces a new resource to be created.
     */
    @JvmName("jmsfedjmuyanghii")
    public suspend fun resourceGroupName(`value`: Output) {
        this.resourceGroupName = value
    }

    /**
     * @param value The name of the SQL Server to which this MySQL virtual network rule will be applied to. Changing this forces a new resource to be created.
     */
    @JvmName("dudjhtwtfhyqpvvi")
    public suspend fun serverName(`value`: Output) {
        this.serverName = value
    }

    /**
     * @param value The ID of the subnet that the MySQL server will be connected to.
     * > **NOTE:** Due to [a bug in the Azure API](https://github.com/Azure/azure-rest-api-specs/issues/3719) this resource currently doesn't expose the `ignore_missing_vnet_service_endpoint` field and defaults this to `false`. This provider will check during the provisioning of the Virtual Network Rule that the Subnet contains the Service Rule to verify that the Virtual Network Rule can be created.
     */
    @JvmName("npphablivyceujvj")
    public suspend fun subnetId(`value`: Output) {
        this.subnetId = value
    }

    /**
     * @param value The name of the MySQL Virtual Network Rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.
     * > **NOTE:** `name` must be between 1-128 characters long and must satisfy all of the requirements below:
     * 1. Contains only alphanumeric and hyphen characters
     * 2. Cannot start with a number or hyphen
     * 3. Cannot end with a hyphen
     */
    @JvmName("igfyhbpmywvcilrf")
    public suspend fun name(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.name = mapped
    }

    /**
     * @param value The name of the resource group where the MySQL server resides. Changing this forces a new resource to be created.
     */
    @JvmName("uyctfkbilujkyvkr")
    public suspend fun resourceGroupName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.resourceGroupName = mapped
    }

    /**
     * @param value The name of the SQL Server to which this MySQL virtual network rule will be applied to. Changing this forces a new resource to be created.
     */
    @JvmName("fdtcknbkrndfjnmu")
    public suspend fun serverName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.serverName = mapped
    }

    /**
     * @param value The ID of the subnet that the MySQL server will be connected to.
     * > **NOTE:** Due to [a bug in the Azure API](https://github.com/Azure/azure-rest-api-specs/issues/3719) this resource currently doesn't expose the `ignore_missing_vnet_service_endpoint` field and defaults this to `false`. This provider will check during the provisioning of the Virtual Network Rule that the Subnet contains the Service Rule to verify that the Virtual Network Rule can be created.
     */
    @JvmName("xdaviueetuabldyn")
    public suspend fun subnetId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.subnetId = mapped
    }

    internal fun build(): VirtualNetworkRuleArgs = VirtualNetworkRuleArgs(
        name = name,
        resourceGroupName = resourceGroupName,
        serverName = serverName,
        subnetId = subnetId,
    )
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy