pulumi-azure-native-kotlin/com.pulumi.azurenative.network.kotlin/SubnetArgs

SubnetArgs

data class SubnetArgs(val addressPrefix: Output<String>? = null, val addressPrefixes: Output<List<String>>? = null, val applicationGatewayIPConfigurations: Output<List<ApplicationGatewayIPConfigurationArgs>>? = null, val defaultOutboundAccess: Output<Boolean>? = null, val delegations: Output<List<DelegationArgs>>? = null, val id: Output<String>? = null, val ipAllocations: Output<List<SubResourceArgs>>? = null, val ipamPoolPrefixAllocations: Output<List<IpamPoolPrefixAllocationArgs>>? = null, val name: Output<String>? = null, val natGateway: Output<SubResourceArgs>? = null, val networkSecurityGroup: Output<NetworkSecurityGroupArgs>? = null, val privateEndpointNetworkPolicies: Output<Either<String, VirtualNetworkPrivateEndpointNetworkPolicies>>? = null, val privateLinkServiceNetworkPolicies: Output<Either<String, VirtualNetworkPrivateLinkServiceNetworkPolicies>>? = null, val resourceGroupName: Output<String>? = null, val routeTable: Output<RouteTableArgs>? = null, val serviceEndpointPolicies: Output<List<ServiceEndpointPolicyArgs>>? = null, val serviceEndpoints: Output<List<ServiceEndpointPropertiesFormatArgs>>? = null, val sharingScope: Output<Either<String, SharingScope>>? = null, val subnetName: Output<String>? = null, val type: Output<String>? = null, val virtualNetworkName: Output<String>? = null) : ConvertibleToJava<SubnetArgs>

Subnet in a virtual network resource. Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01. Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

Create subnet

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var subnet = new AzureNative.Network.Subnet("subnet", new()
    {
        AddressPrefix = "10.0.0.0/16",
        ResourceGroupName = "subnet-test",
        SubnetName = "subnet1",
        VirtualNetworkName = "vnetname",
    });
});
Content copied to clipboard
package main
import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewSubnet(ctx, "subnet", &network.SubnetArgs{
			AddressPrefix:      pulumi.String("10.0.0.0/16"),
			ResourceGroupName:  pulumi.String("subnet-test"),
			SubnetName:         pulumi.String("subnet1"),
			VirtualNetworkName: pulumi.String("vnetname"),
		})
		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.azurenative.network.Subnet;
import com.pulumi.azurenative.network.SubnetArgs;
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 subnet = new Subnet("subnet", SubnetArgs.builder()
            .addressPrefix("10.0.0.0/16")
            .resourceGroupName("subnet-test")
            .subnetName("subnet1")
            .virtualNetworkName("vnetname")
            .build());
    }
}
Content copied to clipboard

Create subnet with a delegation

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var subnet = new AzureNative.Network.Subnet("subnet", new()
    {
        AddressPrefix = "10.0.0.0/16",
        ResourceGroupName = "subnet-test",
        SubnetName = "subnet1",
        VirtualNetworkName = "vnetname",
    });
});
Content copied to clipboard
package main
import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewSubnet(ctx, "subnet", &network.SubnetArgs{
			AddressPrefix:      pulumi.String("10.0.0.0/16"),
			ResourceGroupName:  pulumi.String("subnet-test"),
			SubnetName:         pulumi.String("subnet1"),
			VirtualNetworkName: pulumi.String("vnetname"),
		})
		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.azurenative.network.Subnet;
import com.pulumi.azurenative.network.SubnetArgs;
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 subnet = new Subnet("subnet", SubnetArgs.builder()
            .addressPrefix("10.0.0.0/16")
            .resourceGroupName("subnet-test")
            .subnetName("subnet1")
            .virtualNetworkName("vnetname")
            .build());
    }
}
Content copied to clipboard

Create subnet with service endpoints

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var subnet = new AzureNative.Network.Subnet("subnet", new()
    {
        AddressPrefix = "10.0.0.0/16",
        ResourceGroupName = "subnet-test",
        ServiceEndpoints = new[]
        {
            new AzureNative.Network.Inputs.ServiceEndpointPropertiesFormatArgs
            {
                Service = "Microsoft.Storage",
            },
        },
        SubnetName = "subnet1",
        VirtualNetworkName = "vnetname",
    });
});
Content copied to clipboard
package main
import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewSubnet(ctx, "subnet", &network.SubnetArgs{
			AddressPrefix:     pulumi.String("10.0.0.0/16"),
			ResourceGroupName: pulumi.String("subnet-test"),
			ServiceEndpoints: network.ServiceEndpointPropertiesFormatArray{
				&network.ServiceEndpointPropertiesFormatArgs{
					Service: pulumi.String("Microsoft.Storage"),
				},
			},
			SubnetName:         pulumi.String("subnet1"),
			VirtualNetworkName: pulumi.String("vnetname"),
		})
		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.azurenative.network.Subnet;
import com.pulumi.azurenative.network.SubnetArgs;
import com.pulumi.azurenative.network.inputs.ServiceEndpointPropertiesFormatArgs;
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 subnet = new Subnet("subnet", SubnetArgs.builder()
            .addressPrefix("10.0.0.0/16")
            .resourceGroupName("subnet-test")
            .serviceEndpoints(ServiceEndpointPropertiesFormatArgs.builder()
                .service("Microsoft.Storage")
                .build())
            .subnetName("subnet1")
            .virtualNetworkName("vnetname")
            .build());
    }
}
Content copied to clipboard

Create subnet with service endpoints with network identifier

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var subnet = new AzureNative.Network.Subnet("subnet", new()
    {
        AddressPrefix = "10.0.0.0/16",
        ResourceGroupName = "subnet-test",
        ServiceEndpoints = new[]
        {
            new AzureNative.Network.Inputs.ServiceEndpointPropertiesFormatArgs
            {
                NetworkIdentifier = new AzureNative.Network.Inputs.SubResourceArgs
                {
                    Id = "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/publicIPAddresses/test-ip",
                },
                Service = "Microsoft.Storage",
            },
        },
        SubnetName = "subnet1",
        VirtualNetworkName = "vnetname",
    });
});
Content copied to clipboard
package main
import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewSubnet(ctx, "subnet", &network.SubnetArgs{
			AddressPrefix:     pulumi.String("10.0.0.0/16"),
			ResourceGroupName: pulumi.String("subnet-test"),
			ServiceEndpoints: network.ServiceEndpointPropertiesFormatArray{
				&network.ServiceEndpointPropertiesFormatArgs{
					NetworkIdentifier: &network.SubResourceArgs{
						Id: pulumi.String("/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/publicIPAddresses/test-ip"),
					},
					Service: pulumi.String("Microsoft.Storage"),
				},
			},
			SubnetName:         pulumi.String("subnet1"),
			VirtualNetworkName: pulumi.String("vnetname"),
		})
		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.azurenative.network.Subnet;
import com.pulumi.azurenative.network.SubnetArgs;
import com.pulumi.azurenative.network.inputs.ServiceEndpointPropertiesFormatArgs;
import com.pulumi.azurenative.network.inputs.SubResourceArgs;
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 subnet = new Subnet("subnet", SubnetArgs.builder()
            .addressPrefix("10.0.0.0/16")
            .resourceGroupName("subnet-test")
            .serviceEndpoints(ServiceEndpointPropertiesFormatArgs.builder()
                .networkIdentifier(SubResourceArgs.builder()
                    .id("/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/publicIPAddresses/test-ip")
                    .build())
                .service("Microsoft.Storage")
                .build())
            .subnetName("subnet1")
            .virtualNetworkName("vnetname")
            .build());
    }
}
Content copied to clipboard

Create subnet with sharing scope

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var subnet = new AzureNative.Network.Subnet("subnet", new()
    {
        AddressPrefix = "10.0.0.0/16",
        ResourceGroupName = "subnet-test",
        SubnetName = "subnet1",
        VirtualNetworkName = "vnetname",
    });
});
Content copied to clipboard
package main
import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewSubnet(ctx, "subnet", &network.SubnetArgs{
			AddressPrefix:      pulumi.String("10.0.0.0/16"),
			ResourceGroupName:  pulumi.String("subnet-test"),
			SubnetName:         pulumi.String("subnet1"),
			VirtualNetworkName: pulumi.String("vnetname"),
		})
		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.azurenative.network.Subnet;
import com.pulumi.azurenative.network.SubnetArgs;
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 subnet = new Subnet("subnet", SubnetArgs.builder()
            .addressPrefix("10.0.0.0/16")
            .resourceGroupName("subnet-test")
            .subnetName("subnet1")
            .virtualNetworkName("vnetname")
            .build());
    }
}
Content copied to clipboard

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:network:Subnet subnet1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(addressPrefix: Output<String>? = null, addressPrefixes: Output<List<String>>? = null, applicationGatewayIPConfigurations: Output<List<ApplicationGatewayIPConfigurationArgs>>? = null, defaultOutboundAccess: Output<Boolean>? = null, delegations: Output<List<DelegationArgs>>? = null, id: Output<String>? = null, ipAllocations: Output<List<SubResourceArgs>>? = null, ipamPoolPrefixAllocations: Output<List<IpamPoolPrefixAllocationArgs>>? = null, name: Output<String>? = null, natGateway: Output<SubResourceArgs>? = null, networkSecurityGroup: Output<NetworkSecurityGroupArgs>? = null, privateEndpointNetworkPolicies: Output<Either<String, VirtualNetworkPrivateEndpointNetworkPolicies>>? = null, privateLinkServiceNetworkPolicies: Output<Either<String, VirtualNetworkPrivateLinkServiceNetworkPolicies>>? = null, resourceGroupName: Output<String>? = null, routeTable: Output<RouteTableArgs>? = null, serviceEndpointPolicies: Output<List<ServiceEndpointPolicyArgs>>? = null, serviceEndpoints: Output<List<ServiceEndpointPropertiesFormatArgs>>? = null, sharingScope: Output<Either<String, SharingScope>>? = null, subnetName: Output<String>? = null, type: Output<String>? = null, virtualNetworkName: Output<String>? = null)

Properties

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

The address prefix for the subnet.

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

List of address prefixes for the subnet.

Link copied to clipboard
val applicationGatewayIPConfigurations: Output<List<ApplicationGatewayIPConfigurationArgs>>? = null

Application gateway IP configurations of virtual network resource.

Link copied to clipboard
val defaultOutboundAccess: Output<Boolean>? = null

Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet.

Link copied to clipboard
val delegations: Output<List<DelegationArgs>>? = null

An array of references to the delegations on the subnet.

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

Resource ID.

Link copied to clipboard
val ipAllocations: Output<List<SubResourceArgs>>? = null

Array of IpAllocation which reference this subnet.

Link copied to clipboard
val ipamPoolPrefixAllocations: Output<List<IpamPoolPrefixAllocationArgs>>? = null

A list of IPAM Pools for allocating IP address prefixes.

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

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Link copied to clipboard
val natGateway: Output<SubResourceArgs>? = null

Nat gateway associated with this subnet.

Link copied to clipboard
val networkSecurityGroup: Output<NetworkSecurityGroupArgs>? = null

The reference to the NetworkSecurityGroup resource.

Link copied to clipboard
val privateEndpointNetworkPolicies: Output<Either<String, VirtualNetworkPrivateEndpointNetworkPolicies>>? = null

Enable or Disable apply network policies on private end point in the subnet.

Link copied to clipboard
val privateLinkServiceNetworkPolicies: Output<Either<String, VirtualNetworkPrivateLinkServiceNetworkPolicies>>? = null

Enable or Disable apply network policies on private link service in the subnet.

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

The name of the resource group.

Link copied to clipboard
val routeTable: Output<RouteTableArgs>? = null

The reference to the RouteTable resource.

Link copied to clipboard
val serviceEndpointPolicies: Output<List<ServiceEndpointPolicyArgs>>? = null

An array of service endpoint policies.

Link copied to clipboard
val serviceEndpoints: Output<List<ServiceEndpointPropertiesFormatArgs>>? = null

An array of service endpoints.

Link copied to clipboard
val sharingScope: Output<Either<String, SharingScope>>? = null

Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty.

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

The name of the subnet.

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

Resource type.

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

The name of the virtual network.

Functions

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